Class SwitchbotDevice

Represents a Switchbot Device.

Index

Constructors

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect disconnect discoverServices getCharacteristics getDeviceName internalConnect log setDeviceName unsubscribeFromNotify

Constructors

constructor

new SwitchbotDevice(peripheral: Peripheral, noble: Noble): SwitchbotDevice
Initializes a new instance of the SwitchbotDevice class.
Parameters
- peripheral: Peripheral
  The peripheral object from noble.
- noble: Noble
  The Noble object.
Returns SwitchbotDevice
Overrides EventEmitter.constructor
- Defined in src/device.ts:576

Accessors

address

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

connectionState

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

friendlyName

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

id

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

model

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

modelName

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

onConnectHandler

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

onDisconnectHandler

get onDisconnectHandler(): () => Promise<void>
Returns () => Promise<void>
- Defined in src/device.ts:637
set onDisconnectHandler(func: () => Promise<void>): void
Parameters
- func: () => Promise<void>
Returns void
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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>
- 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.
- 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.
- Defined in src/device.ts:780