node-switchbot
    Preparing search index...

    Class WoStrip

    Class representing a WoStrip device.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get address(): string

      Returns string

    • get connectionState(): string

      Returns string

    • get id(): string

      Returns string

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

      Returns () => Promise<void>

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

      Parameters

      • func: () => Promise<void>

      Returns void

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

      Returns () => Promise<void>

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

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    • 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.

    • 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>

    • 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.
    • Reads the state of the strip light.

      Returns Promise<boolean>

      • Resolves with true if the strip light is ON, false otherwise.
    • 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.
    • Sets the device name.

      Parameters

      • name: string

        The new device name.

      Returns Promise<void>

      A Promise that resolves when the name is set.

    • 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.
    • 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.
    • Turns the strip light off.

      Returns Promise<boolean>

      • Resolves with true if the strip light is OFF.
    • Turns the strip light on.

      Returns Promise<boolean>

      • Resolves with true if the strip light is ON.
    • 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.

      Returns Promise<null | stripLightServiceData>

      • Parsed service data or null if invalid.