Class SwitchbotDevice

Represents a Switchbot Device.

Hierarchy (view full)

Indexable

  • [x: string]: any

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect disconnect discoverServices getCharacteristics getDeviceName log setDeviceName unsubscribeFromNotify

Constructors

constructor

  • new SwitchbotDevice(peripheral, noble): SwitchbotDevice

  • Initializes a new instance of the SwitchbotDevice class.

    Parameters

    • peripheral: Peripheral

      The peripheral object from noble.

    • noble: __module

      The Noble object.

    Returns SwitchbotDevice

Accessors

address

connectionState

  • get connectionState(): string

  • Returns string

friendlyName

id

model

modelName

onConnectHandler

  • get onConnectHandler(): (() => Promise<void>)

  • Returns (() => Promise<void>)

      • (): Promise<void>

      • Returns Promise<void>

  • set onConnectHandler(func): void

  • Parameters

    • func: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): (() => Promise<void>)

  • Returns (() => Promise<void>)

      • (): Promise<void>

      • Returns Promise<void>

  • set onDisconnectHandler(func): void

  • Parameters

    • func: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    Returns void

Methods

command

  • command(reqBuf): Promise<Buffer>

  • Sends a command to the device and awaits a response.

    Parameters

    • reqBuf: Buffer

      The command buffer.

    Returns Promise<Buffer>

    A Promise that resolves with the response buffer.

connect

  • connect(): Promise<void>

  • Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

discoverServices

  • discoverServices(): Promise<Service[]>

  • Discovers the device services.

    Returns Promise<Service[]>

    A Promise that resolves with the list of services.

getCharacteristics

  • getCharacteristics(): Promise<Chars>

  • Retrieves the device characteristics.

    Returns Promise<Chars>

    A Promise that resolves with the device characteristics.

getDeviceName

  • getDeviceName(): Promise<string>

  • Retrieves the device name.

    Returns Promise<string>

    A Promise that resolves with the device name.

log

  • log(level, message): 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>

setDeviceName

  • setDeviceName(name): 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.

unsubscribeFromNotify

  • unsubscribeFromNotify(): Promise<void>

  • Unsubscribes from the notify characteristic.

    Returns Promise<void>

    A Promise that resolves when the unsubscription is complete.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods