Interface ObnizPartsBleProps

Hierarchy

ObnizPartsProps
- ObnizPartsBleProps

Index

Constructors

Properties

Address? AvailableBleMode BeaconDataLength? BeaconDataLength_ScanResponse? BeaconDataStruct? CompanyID? CompanyID_ScanResponse? LocalName? PartsName ServiceDataLength? ServiceDataStruct? ServiceUUID? ServiceUuids?

Methods

getDeviceMode getServiceUuids info

Constructors

constructor

new ObnizPartsBleProps(peripheral, mode): ObnizPartsBle<unknown>
Parameters
- peripheral: BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
Returns ObnizPartsBle<unknown>
Inherited from ObnizPartsProps.constructor
- Defined in src/obniz/ObnizPartsBleAbstract.ts:214

Properties

`Optional` `Readonly` Address

Address?: ObnizPartsBleCompareWithNonNull<RegExp>

`Readonly` AvailableBleMode

AvailableBleMode: "Beacon" | "Connectable" | "Pairing" | ("Beacon" | "Connectable" | "Pairing")[]

`Optional` `Readonly` BeaconDataLength

BeaconDataLength?: ObnizPartsBleCompare<number>

`Optional` `Readonly` BeaconDataLength_ScanResponse

BeaconDataLength_ScanResponse?: ObnizPartsBleCompare<number>

`Optional` `Readonly` BeaconDataStruct

BeaconDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

`Optional` `Readonly` CompanyID

CompanyID?: ObnizPartsBleCompare<number[]>

`Optional` `Readonly` CompanyID_ScanResponse

CompanyID_ScanResponse?: ObnizPartsBleCompare<number[]>

`Optional` `Readonly` LocalName

LocalName?: ObnizPartsBleCompareWithNonNull<RegExp>

`Readonly` PartsName

PartsName: keyof PartsList

`Optional` `Readonly` ServiceDataLength

ServiceDataLength?: ObnizPartsBleCompare<number>

`Optional` `Readonly` ServiceDataStruct

ServiceDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

`Optional` `Readonly` ServiceUUID

ServiceUUID?: ObnizPartsBleCompare<number[]>

`Optional` `Readonly` ServiceUuids

ServiceUuids?: ObnizPartsBleCompare<string | string[]>

Methods

getDeviceMode

getDeviceMode(peripheral): null | "Beacon" | "Connectable" | "Pairing"
Parameters
- peripheral: BleRemotePeripheral
Returns null | "Beacon" | "Connectable" | "Pairing"
- Defined in src/obniz/ObnizPartsBleAbstract.ts:212

getServiceUuids

getServiceUuids(mode): undefined | null | string[]
Parameters
- mode: "Beacon" | "Connectable" | "Pairing"
Returns undefined | null | string[]
- Defined in src/obniz/ObnizPartsBleAbstract.ts:210

info

info(): ObnizPartsInfo
Returns ObnizPartsInfo
Inherited from ObnizPartsProps.info
- Defined in src/obniz/ObnizPartsInterface.ts:15

Generated using TypeDoc