Class default

Switchbot_ContactSensor management class Switchbot_ContactSensorを管理するクラス

Hierarchy

Switchbot
- default

Index

Constructors

Properties

_peripheral ondisconnect?

Methods

connectWait getData getServiceDataPayload info isDevice isSwitchbotDevice

Constructors

constructor

new default(peripheral): default
Parameters
- peripheral: BleRemotePeripheral
Returns default
Inherited from Switchbot.constructor
- Defined in src/parts/Ble/utils/abstracts/Switchbot.ts:91

Properties

_peripheral

_peripheral: BleRemotePeripheral

Internally Used function for connection required devices

`Optional` ondisconnect

ondisconnect?: ((reason) => void)

Type declaration

- (reason): void
- Parameters
  - reason: any
  Returns void

Methods

connectWait

connectWait(setting?): Promise<void>
Parameters
- Optional setting: Pick<BleConnectSetting, "retry" | "forceConnect">
Returns Promise<void>
Inherited from Switchbot.connectWait
- Defined in src/parts/Ble/utils/abstracts/Switchbot.ts:95

`Static` getData

getData(peripheral): null | Switchbot_ContactSensor_Data
Get a data from the Switchbot_ContactSensor

Switchbot_ContactSensorからデータを取得
Parameters
- peripheral: BleRemotePeripheral
  
  instance of BleRemotePeripheral BleRemotePeripheralのインスタンス
Returns null | Switchbot_ContactSensor_Data
received data from the Switchbot_ContactSensor Switchbot_ContactSensorから受け取ったデータ
- Defined in src/parts/Ble/Switchbot_ContactSensor/index.ts:67

`Static` getServiceDataPayload

getServiceDataPayload(peripheral, deviceType, serviceDataPayloadLength): null | number[]
Parameters
- peripheral: BleRemotePeripheral
- deviceType: number | number[]
- serviceDataPayloadLength: number
Returns null | number[]
Inherited from Switchbot.getServiceDataPayload
- Defined in src/parts/Ble/utils/abstracts/Switchbot.ts:22

`Static` info

info(): ObnizPartsBleInfo
Returns ObnizPartsBleInfo
- Defined in src/parts/Ble/Switchbot_ContactSensor/index.ts:33

`Static` isDevice

isDevice(peripheral): boolean
Verify that the received peripheral is from the Switchbot_ContactSensor

受け取ったPeripheralがSwitchbot_ContactSensorのものかどうかを確認する
Parameters
- peripheral: BleRemotePeripheral
  
  instance of BleRemotePeripheral BleRemotePeripheralのインスタンス
Returns boolean
Whether it is the Switchbot_ContactSensor

Switchbot_ContactSensorかどうか
- Defined in src/parts/Ble/Switchbot_ContactSensor/index.ts:50

`Static` isSwitchbotDevice

isSwitchbotDevice(peripheral, deviceType, serviceDataPayloadLength): boolean
Parameters
- peripheral: BleRemotePeripheral
- deviceType: number | number[]
- serviceDataPayloadLength: number
Returns boolean
Inherited from Switchbot.isSwitchbotDevice
- Defined in src/parts/Ble/utils/abstracts/Switchbot.ts:73

Generated using TypeDoc