Class WoSmartLock

Class representing a WoSmartLock device.

See

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

Hierarchy (View Summary)

SwitchbotDevice
- WoSmartLock

Constructors

constructor

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

Properties

encryption_key

encryption_key: null | Buffer<ArrayBufferLike> = null

iv

iv: null | Buffer<ArrayBufferLike> = null

key_id

key_id: string = ''

`Static`Result

Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

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

decrypt

decrypt(data: Buffer): Promise<Buffer<ArrayBufferLike>>
Decrypts a buffer using AES-128-CTR.
Parameters
- data: Buffer
  The data to decrypt.
Returns Promise<Buffer<ArrayBufferLike>>
- The decrypted data.
- Defined in src/device.ts:3315

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

encrypt

encrypt(str: string): Promise<string>
Encrypts a string using AES-128-CTR.
Parameters
- str: string
  The string to encrypt.
Returns Promise<string>
- The encrypted string in hex format.
- Defined in src/device.ts:3305

encryptedCommand

encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>
Sends an encrypted command to the device.
Parameters
- key: string
  The command key.
Returns Promise<Buffer<ArrayBufferLike>>
- The response buffer.
- Defined in src/device.ts:3341

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

getIv

getIv(): Promise<Buffer<ArrayBufferLike>>
Retrieves the IV from the device.

Returns Promise<Buffer<ArrayBufferLike>>
- The IV buffer.
- Defined in src/device.ts:3324

info

info(): Promise<null | object>
Gets general state info from the Smart Lock.

Returns Promise<null | object>
- The state object or null if an error occurred.
- Defined in src/device.ts:3286

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

lock

lock(): Promise<number>
Locks the Smart Lock.

Returns Promise<number>
- The result of the lock operation.
- Defined in src/device.ts:3277

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

operateLock

operateLock(key: string, encrypt?: boolean): Promise<Buffer<ArrayBufferLike>>
Operates the lock with the given command.
Parameters
- key: string
  The command key.
- Optionalencrypt: boolean = true
  Whether to encrypt the command.
Returns Promise<Buffer<ArrayBufferLike>>
- The response buffer.
- Defined in src/device.ts:3365

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

setKey

setKey(keyId: string, encryptionKey: string): Promise<void>
Initializes the encryption key info for valid lock communication.
Parameters
- keyId: string
  The key ID.
- encryptionKey: string
  The encryption key.
Returns Promise<void>
- Defined in src/device.ts:3249

unlock

unlock(): Promise<number>
Unlocks the Smart Lock.

Returns Promise<number>
- The result of the unlock operation.
- Defined in src/device.ts:3259

unlockNoUnlatch

unlockNoUnlatch(): Promise<number>
Unlocks the Smart Lock without unlatching the door.

Returns Promise<number>
- The result of the unlock operation.
- Defined in src/device.ts:3268

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`getLockStatus

getLockStatus(code: number): string
Parameters
- code: number
Returns string
- Defined in src/device.ts:3187

`Static`parseServiceData

parseServiceData(
    serviceData: Buffer,
    manufacturerData: Buffer,
    emitLog: (level: string, message: string) => void,
): Promise<null | lockServiceData>
Parses the service data from the SwitchBot Strip Light.
Parameters
- serviceData: Buffer
  The service data buffer.
- manufacturerData: Buffer
  The manufacturer data buffer.
- emitLog: (level: string, message: string) => void
  The function to emit log messages.
Returns Promise<null | lockServiceData>
- Parsed service data or null if invalid.
- Defined in src/device.ts:3207

`Static`validateResponse

validateResponse(res: Buffer): Promise<number>
Parameters
- res: Buffer
Returns Promise<number>
- Defined in src/device.ts:3177

Class WoSmartLock

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WoSmartLock

Properties

encryption_key

iv

key_id

StaticResult

Accessors

address

Returns string

connectionState

Returns string

friendlyName

Returns SwitchBotBLEModelFriendlyName

id

Returns string

model

Returns SwitchBotBLEModel

modelName

Returns SwitchBotBLEModelName

onConnectHandler

Returns () => Promise<void>

Parameters

Returns void

onDisconnectHandler

Returns () => Promise<void>

Parameters

Returns void

Methods

command

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

connect

Returns Promise<void>

decrypt

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

disconnect

Returns Promise<void>

discoverServices

Returns Promise<Service[]>

encrypt

Parameters

Returns Promise<string>

encryptedCommand

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

getCharacteristics

Returns Promise<Chars>

getDeviceName

Returns Promise<string>

getIv

Returns Promise<Buffer<ArrayBufferLike>>

info

Returns Promise<null | object>

internalConnect

Returns Promise<void>

lock

Returns Promise<number>

log

Parameters

Returns Promise<void>

operateLock

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

setDeviceName

Parameters

Returns Promise<void>

setKey

Parameters

`Static`Result

`Static`getLockStatus

`Static`parseServiceData

`Static`validateResponse