Class WoHumi

Class representing a WoHumi device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes

Hierarchy (view full)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect disconnect discoverServices down getCharacteristics getDeviceName log operateHumi press setDeviceName turnOff turnOn unsubscribeFromNotify up 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

down

  • down(): Promise<void>

  • Decreases the humidifier setting.

    Returns Promise<void>

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>

operateHumi

  • operateHumi(bytes): Promise<void>

  • Sends a command to the humidifier.

    Parameters

    • bytes: number[]

      The command bytes.

    Returns Promise<void>

press

  • press(): Promise<void>

  • Presses the humidifier button.

    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.

turnOff

  • turnOff(): Promise<void>

  • Turns off the humidifier.

    Returns Promise<void>

turnOn

  • turnOn(): Promise<void>

  • Turns on the humidifier.

    Returns Promise<void>

unsubscribeFromNotify

up

  • up(): Promise<void>

  • Increases the humidifier setting.

    Returns Promise<void>

StaticparseServiceData

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

  • Parses the service data for WoHumi.

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

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods