Class WoCeilingLight

Class representing a WoCeilingLight device.

See

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

Hierarchy (view full)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

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

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>

operateCeilingLight

  • operateCeilingLight(bytes): Promise<boolean>

  • Sends a command to the ceiling light.

    Parameters

    • bytes: number[]

      The command bytes.

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the operation was successful.

readState

  • readState(): Promise<boolean>

  • Reads the state of the ceiling light.

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the light is ON (true) or OFF (false).

setBrightness

  • setBrightness(brightness): Promise<boolean>

  • Sets the brightness of the ceiling light.

    Parameters

    • brightness: number

      The brightness percentage (0-100).

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the operation was successful.

setColorTemperature

  • setColorTemperature(color_temperature): Promise<boolean>

  • Sets the color temperature of the ceiling light.

    Parameters

    • color_temperature: number

      The color temperature percentage (0-100).

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether 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 color of the ceiling light.

    Parameters

    • brightness: number

      The brightness percentage (0-100).

    • red: number

      The red color value (0-255).

    • green: number

      The green color value (0-255).

    • blue: number

      The blue color value (0-255).

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the operation was successful.

setState

  • setState(reqByteArray): Promise<boolean>

  • Sets the state of the ceiling light.

    Parameters

    • reqByteArray: number[]

      The request byte array.

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the operation was successful.

turnOff

  • turnOff(): Promise<boolean>

  • Turns off the ceiling light.

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the light is OFF (false).

turnOn

  • turnOn(): Promise<boolean>

  • Turns on the ceiling light.

    Returns Promise<boolean>

    • Resolves with a boolean indicating whether the light is ON (true).

unsubscribeFromNotify

StaticparseServiceData

  • parseServiceData(manufacturerData, emitLog): Promise<null | ceilingLightServiceData>

  • Parses the service data for WoCeilingLight.

    Parameters

    • manufacturerData: Buffer

      The manufacturer 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 | ceilingLightServiceData>

    • Parsed service data or null if invalid.

StaticparseServiceData_Pro

  • parseServiceData_Pro(manufacturerData, emitLog): Promise<null | ceilingLightProServiceData>

  • Parses the service data for WoCeilingLight Pro.

    Parameters

    • manufacturerData: Buffer

      The manufacturer 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 | ceilingLightProServiceData>

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods