Class ObnizPartsBlePairable<S, T>`Abstract`

Type Parameters

Hierarchy

ObnizPartsBleConnectable<S, T>
- ObnizPartsBlePairable

Constructors

constructor

new ObnizPartsBlePairable<S, T>(peripheral, mode): ObnizPartsBlePairable<S, T>
Type Parameters
- S
- T
Parameters
- peripheral: BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
Returns ObnizPartsBlePairable<S, T>
Inherited from ObnizPartsBleConnectable.constructor
- Defined in src/obniz/ObnizPartsBleAbstract.ts:794

Properties

`Readonly` address

address: string

`Readonly` beaconData

beaconData: null | number[]

`Readonly` beaconDataInScanResponse

beaconDataInScanResponse: null | number[]

`Optional` ondisconnect

ondisconnect?: ((reason) => void | Promise<void>)

Type declaration

- (reason): void | Promise<void>
- onDisconnect callback function.
  
  切断された時に呼ばれるコールバック関数
  Parameters
  - reason: unknown
    
    Reason for being disconnected 切断された理由
  Returns void | Promise<void>

`Readonly` peripheral

peripheral: BleRemotePeripheral

`Readonly` serviceData

serviceData: null | number[]

`Static` `Optional` `Readonly` Address

Address?: ObnizPartsBleCompareWithNonNull<RegExp> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` BeaconDataLength

BeaconDataLength?: ObnizPartsBleCompare<number> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` BeaconDataLength_ScanResponse

BeaconDataLength_ScanResponse?: ObnizPartsBleCompare<number> = undefined

Overall length of manufacturer-specific data. Used as a condition of isDevice() by default.

製造者固有データ全体の長さ標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` BeaconDataStruct

BeaconDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

Used as a condition of isDevice() by default. Compare with data after Company ID.

標準でisDevice()の条件として使用 CompanyID以降のデータと比較

`Static` `Optional` `Readonly` CompanyID

CompanyID?: ObnizPartsBleCompare<number[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` CompanyID_ScanResponse

CompanyID_ScanResponse?: ObnizPartsBleCompare<number[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` LocalName

LocalName?: ObnizPartsBleCompareWithNonNull<RegExp> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` ServiceDataLength

ServiceDataLength?: ObnizPartsBleCompare<number> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` ServiceDataStruct

ServiceDataStruct?: ObnizPartsBleCompare<ObnizBleBeaconStruct<unknown>>

Used as a condition of isDevice() by default. Compare with data after Service UUID.

標準でisDevice()の条件として使用 ServiceUUID以降のデータと比較

`Static` `Optional` `Readonly` ServiceDataUUID

ServiceDataUUID?: ObnizPartsBleCompare<number[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

`Static` `Optional` `Readonly` ServiceUuids

ServiceUuids?: ObnizPartsBleCompare<string | string[]> = undefined

Used as a condition of isDevice() by default.

標準でisDevice()の条件として使用

Accessors

mode

get mode(): "Beacon" | "Connectable" | "Pairing"
Returns "Beacon" | "Connectable" | "Pairing"
Inherited from ObnizPartsBleConnectable.mode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:651

Methods

checkMode

checkMode(force?): "Beacon" | "Connectable" | "Pairing"
Parameters
- force: boolean = false
Returns "Beacon" | "Connectable" | "Pairing"
Inherited from ObnizPartsBleConnectable.checkMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:673

connectWait

connectWait(keys?, setting?): Promise<void>
Connect to peripherals with validation.

バリデーションのあるペリフェラルへの接続
Parameters
- Optional keys: string
- Optional setting: BleConnectSetting
Returns Promise<void>
Inherited from ObnizPartsBleConnectable.connectWait
- Defined in src/obniz/ObnizPartsBleAbstract.ts:830

disconnectWait

disconnectWait(): Promise<void>
Disconnect from peripheral.

ペリフェラルから切断

Returns Promise<void>
Inherited from ObnizPartsBleConnectable.disconnectWait
- Defined in src/obniz/ObnizPartsBleAbstract.ts:860

getData

getData(): S
アドバタイジングデータを連想配列に成形

利用可能なモード: Beacon, Connectable(一部のみ)

Form advertising data into an associative array

Available modes: Beacon, Connectable(only part)

Returns S
Inherited from ObnizPartsBleConnectable.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:689

`Abstract` getDataWait

getDataWait(): Promise<T>
Get data during connection.

接続中にデータを取得

Returns Promise<T>
Inherited from ObnizPartsBleConnectable.getDataWait
- Defined in src/obniz/ObnizPartsBleAbstract.ts:876

pairingWait

pairingWait(): Promise<null | string>
Perform pairing

ペアリングを実行

Returns Promise<null | string>
Pairing key ペアリングキー
- Defined in src/obniz/ObnizPartsBleAbstract.ts:1046

`Static` getAvailableBleMode

getAvailableBleMode(): ("Beacon" | "Connectable" | "Pairing")[]
Available BLE modes (Beacon | Connectable | Pairing)

利用可能なBLEのモード (Beacon | Connectable | Pairing)

Returns ("Beacon" | "Connectable" | "Pairing")[]
Inherited from ObnizPartsBleConnectable.getAvailableBleMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:234

`Static` getData

getData(peripheral): unknown
Form advertising data into an associative array.

アドバタイジングデータを連想配列に成形
Parameters
- peripheral: BleRemotePeripheral
Returns unknown

Deprecated
Inherited from ObnizPartsBleConnectable.getData
- Defined in src/obniz/ObnizPartsBleAbstract.ts:627

`Static` getDeviceMode

getDeviceMode(peripheral): null | "Beacon" | "Connectable" | "Pairing"
Get Peripheral Mode.

ペリフェラルのモードを取得
Parameters
- peripheral: BleRemotePeripheral
  
  BleRemotePeripheral
Returns null | "Beacon" | "Connectable" | "Pairing"
If the corresponding device is that mode, it must be null if not applicable 該当するデバイスならばそのモード、該当しなければnull
Inherited from ObnizPartsBleConnectable.getDeviceMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:363

`Static` getServiceUuids

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

`Static` info

info(): ObnizPartsInfo
Information of parts. name: PartsName

Returns ObnizPartsInfo
Inherited from ObnizPartsBleConnectable.info
- Defined in src/obniz/ObnizPartsBleAbstract.ts:225

`Static` isDevice

isDevice(peripheral): boolean
Parameters
- peripheral: BleRemotePeripheral
Returns boolean

Deprecated
Inherited from ObnizPartsBleConnectable.isDevice
- Defined in src/obniz/ObnizPartsBleAbstract.ts:351

`Static` isDeviceWithMode

isDeviceWithMode(peripheral, mode): boolean
Check if peripherals and modes match the library.

ペリフェラルとモードがライブラリと合致するかチェック
Parameters
- peripheral: BleRemotePeripheral
  
  BleRemotePeripheral
- mode: "Beacon" | "Connectable" | "Pairing"
  
  Beacon | Connectable | Pairing
Returns boolean
Whether to match 合致するかどうか
Inherited from ObnizPartsBleConnectable.isDeviceWithMode
- Defined in src/obniz/ObnizPartsBleAbstract.ts:387

Class ObnizPartsBlePairable<S, T>Abstract

Type Parameters

S

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

S

T

Parameters

peripheral: BleRemotePeripheral

mode: "Beacon" | "Connectable" | "Pairing"

Returns ObnizPartsBlePairable<S, T>

Properties

Readonly address

Readonly beaconData

Readonly beaconDataInScanResponse

Optional ondisconnect

Type declaration

Parameters

reason: unknown

Returns void | Promise<void>

Readonly peripheral

Readonly serviceData

Static Optional Readonly Address

Static Optional Readonly BeaconDataLength

Static Optional Readonly BeaconDataLength_ScanResponse

Static Optional Readonly BeaconDataStruct

Static Optional Readonly CompanyID

Static Optional Readonly CompanyID_ScanResponse

Static Optional Readonly LocalName

Static Optional Readonly ServiceDataLength

Static Optional Readonly ServiceDataStruct

Static Optional Readonly ServiceDataUUID

Static Optional Readonly ServiceUuids

Accessors

mode

Returns "Beacon" | "Connectable" | "Pairing"

Methods

checkMode

Parameters

force: boolean = false

Returns "Beacon" | "Connectable" | "Pairing"

connectWait

Parameters

Optional keys: string

Optional setting: BleConnectSetting

Returns Promise<void>

disconnectWait

Returns Promise<void>

getData

Returns S

Abstract getDataWait

Returns Promise<T>

pairingWait

Returns Promise<null | string>

Static getAvailableBleMode

Returns ("Beacon" | "Connectable" | "Pairing")[]

Static getData

Parameters

peripheral: BleRemotePeripheral

Returns unknown

Deprecated

Static getDeviceMode

Parameters

peripheral: BleRemotePeripheral

Returns null | "Beacon" | "Connectable" | "Pairing"

Static getServiceUuids

Parameters

mode: "Beacon" | "Connectable" | "Pairing"

Returns undefined | null | string[]

Static info

Returns ObnizPartsInfo

Static isDevice

Class ObnizPartsBlePairable<S, T>`Abstract`

`Readonly` address

`Readonly` beaconData

`Readonly` beaconDataInScanResponse

`Optional` ondisconnect

`Readonly` peripheral

`Readonly` serviceData

`Static` `Optional` `Readonly` Address

`Static` `Optional` `Readonly` BeaconDataLength

`Static` `Optional` `Readonly` BeaconDataLength_ScanResponse

`Static` `Optional` `Readonly` BeaconDataStruct

`Static` `Optional` `Readonly` CompanyID

`Static` `Optional` `Readonly` CompanyID_ScanResponse

`Static` `Optional` `Readonly` LocalName

`Static` `Optional` `Readonly` ServiceDataLength

`Static` `Optional` `Readonly` ServiceDataStruct

`Static` `Optional` `Readonly` ServiceDataUUID

`Static` `Optional` `Readonly` ServiceUuids

`Optional` keys: string

`Optional` setting: BleConnectSetting

`Abstract` getDataWait

`Static` getAvailableBleMode

`Static` getData

`Static` getDeviceMode

`Static` getServiceUuids

`Static` info

`Static` isDevice

`Static` isDeviceWithMode