Class Switchbot

Hierarchy

Switchbot
- default
- default
- default
- default
- default
- default
- default

Implements

ObnizPartsBleInterface

Index

Constructors

Properties

_peripheral ondisconnect?

Methods

connectWait getServiceDataPayload isSwitchbotDevice

Constructors

constructor

new Switchbot(peripheral): Switchbot
Parameters
- peripheral: BleRemotePeripheral
Returns Switchbot
- 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>
- Defined in src/parts/Ble/utils/abstracts/Switchbot.ts:95

`Static` getServiceDataPayload

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

`Static` isSwitchbotDevice

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

Generated using TypeDoc