Class WoPresence

Class representing a WoPresence device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

Hierarchy (View Summary)

SwitchbotDevice
- WoPresence

Constructors

constructor

new WoPresence(peripheral: Peripheral, noble: Noble): WoPresence
Parameters
- peripheral: Peripheral
- noble: Noble
Returns WoPresence
Overrides SwitchbotDevice.constructor
- Defined in src/device.ts:2783

Accessors

address

get address(): string
Returns string
Inherited from SwitchbotDevice.address
- Defined in src/device.ts:604

connectionState

get connectionState(): string
Returns string
Inherited from SwitchbotDevice.connectionState
- Defined in src/device.ts:620

friendlyName

get friendlyName(): SwitchBotBLEModelFriendlyName
Returns SwitchBotBLEModelFriendlyName
Inherited from SwitchbotDevice.friendlyName
- Defined in src/device.ts:616

id

get id(): string
Returns string
Inherited from SwitchbotDevice.id
- Defined in src/device.ts:600

model

get model(): SwitchBotBLEModel
Returns SwitchBotBLEModel
Inherited from SwitchbotDevice.model
- Defined in src/device.ts:608

modelName

get modelName(): SwitchBotBLEModelName
Returns SwitchBotBLEModelName
Inherited from SwitchbotDevice.modelName
- Defined in src/device.ts:612

onConnectHandler

get onConnectHandler(): () => Promise<void>
Returns () => Promise<void>
Inherited from SwitchbotDevice.onConnectHandler
- Defined in src/device.ts:624
set onConnectHandler(func: () => Promise<void>): void
Parameters
- func: () => Promise<void>
Returns void
Inherited from SwitchbotDevice.onConnectHandler
- Defined in src/device.ts:628

onDisconnectHandler

get onDisconnectHandler(): () => Promise<void>
Returns () => Promise<void>
Inherited from SwitchbotDevice.onDisconnectHandler
- Defined in src/device.ts:637
set onDisconnectHandler(func: () => Promise<void>): void
Parameters
- func: () => Promise<void>
Returns void
Inherited from SwitchbotDevice.onDisconnectHandler
- Defined in src/device.ts:641

Methods

command

command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>
Sends a command to the device and awaits a response.
Parameters
- reqBuf: Buffer
  The command buffer.
Returns Promise<Buffer<ArrayBufferLike>>
A Promise that resolves with the response buffer.
Inherited from SwitchbotDevice.command
- Defined in src/device.ts:872

connect

connect(): Promise<void>
Connects to the device.

Returns Promise<void>
A Promise that resolves when the connection is complete.
Inherited from SwitchbotDevice.connect
- Defined in src/device.ts:654

disconnect

disconnect(): Promise<void>
Disconnects from the device.

Returns Promise<void>
A Promise that resolves when the disconnection is complete.
Inherited from SwitchbotDevice.disconnect
- Defined in src/device.ts:793

discoverServices

discoverServices(): Promise<Service[]>
Discovers the device services.

Returns Promise<Service[]>
A Promise that resolves with the list of services.
Inherited from SwitchbotDevice.discoverServices
- Defined in src/device.ts:739

getCharacteristics

getCharacteristics(): Promise<Chars>
Retrieves the device characteristics.

Returns Promise<Chars>
A Promise that resolves with the device characteristics.
Inherited from SwitchbotDevice.getCharacteristics
- Defined in src/device.ts:697

getDeviceName

getDeviceName(): Promise<string>
Retrieves the device name.

Returns Promise<string>
A Promise that resolves with the device name.
Inherited from SwitchbotDevice.getDeviceName
- Defined in src/device.ts:823

internalConnect

internalConnect(): Promise<void>
Internal method to handle the connection process.

Returns Promise<void>
A Promise that resolves when the connection is complete.
Inherited from SwitchbotDevice.internalConnect
- Defined in src/device.ts:663

log

log(level: string, message: string): Promise<void>
Logs a message with the specified log level.
Parameters
- level: string
  The severity level of the log (e.g., 'info', 'warn', 'error').
- message: string
  The log message to be emitted.
Returns Promise<void>
Inherited from SwitchbotDevice.log
- Defined in src/device.ts:595

setDeviceName

setDeviceName(name: string): Promise<void>
Sets the device name.
Parameters
- name: string
  The new device name.
Returns Promise<void>
A Promise that resolves when the name is set.
Inherited from SwitchbotDevice.setDeviceName
- Defined in src/device.ts:844

unsubscribeFromNotify

unsubscribeFromNotify(): Promise<void>
Unsubscribes from the notify characteristic.

Returns Promise<void>
A Promise that resolves when the unsubscription is complete.
Inherited from SwitchbotDevice.unsubscribeFromNotify
- Defined in src/device.ts:780

`Static`parseServiceData

parseServiceData(
serviceData: Buffer,
emitLog: (level: string, message: string) => void,
): Promise<null | motionSensorServiceData>
Parses the service data for WoPresence.
Parameters
- serviceData: Buffer
  The service data buffer.
- emitLog: (level: string, message: string) => void
  The function to emit log messages.
Returns Promise<null | motionSensorServiceData>
- Parsed service data or null if invalid.
- Defined in src/device.ts:2755