Class WoStrip

Class representing a WoStrip device.

See

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

Hierarchy (view full)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect disconnect discoverServices getCharacteristics getDeviceName log operateStripLight readState setBrightness setDeviceName setRGB setState turnOff turnOn unsubscribeFromNotify parseServiceData

Constructors

constructor

Accessors

address

  • get address(): string

  • Returns string

connectionState

  • get connectionState(): string

  • Returns string

friendlyName

id

  • get id(): string

  • Returns string

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

getCharacteristics

getDeviceName

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>

operateStripLight

  • operateStripLight(bytes): Promise<boolean>

  • Operates the strip light with the given byte array.

    Parameters

    • bytes: number[]

      The byte array to send.

    Returns Promise<boolean>

    • Resolves with true if the operation was successful.

readState

  • readState(): Promise<boolean>

  • Reads the state of the strip light.

    Returns Promise<boolean>

    • Resolves with true if the strip light is ON, false otherwise.

setBrightness

  • setBrightness(brightness): Promise<boolean>

  • Sets the brightness of the strip light.

    Parameters

    • brightness: number

      The brightness percentage (0-100).

    Returns Promise<boolean>

    • Resolves with true if the operation was successful.

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.

setRGB

  • setRGB(brightness, red, green, blue): Promise<boolean>

  • Sets the RGB values of the strip light.

    Parameters

    • brightness: number

      The brightness percentage (0-100).

    • red: number

      The red value (0-255).

    • green: number

      The green value (0-255).

    • blue: number

      The blue value (0-255).

    Returns Promise<boolean>

    • Resolves with true if the operation was successful.

setState

  • setState(reqByteArray): Promise<boolean>

  • Sets the state of the strip light.

    Parameters

    • reqByteArray: number[]

      The request byte array.

    Returns Promise<boolean>

    • Resolves with true if the operation was successful.

turnOff

  • turnOff(): Promise<boolean>

  • Turns the strip light off.

    Returns Promise<boolean>

    • Resolves with true if the strip light is OFF.

turnOn

  • turnOn(): Promise<boolean>

  • Turns the strip light on.

    Returns Promise<boolean>

    • Resolves with true if the strip light is ON.

unsubscribeFromNotify

StaticparseServiceData

  • parseServiceData(serviceData, emitLog): Promise<null | stripLightServiceData>

  • Parses the service data from the SwitchBot Strip Light.

    Parameters

    • serviceData: Buffer

      The service data buffer.

    • emitLog: ((level: string, message: string) => void)

      The function to emit log messages.

        • (level, message): void

        • Parameters

          • level: string
          • message: string

          Returns void

    Returns Promise<null | stripLightServiceData>

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods