Class WoHumi

Class representing a WoHumi device.

See

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

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect decrease disconnect discoverServices getCharacteristics getDeviceName increase log percentage setAutoMode setDeviceName setManualMode 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>

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

  • Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

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

  • Returns () => Promise<void>

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

  • Parameters

    • func: () => Promise<void>

    Returns void

Methods

command

  • command(reqBuf: Buffer<ArrayBufferLike>): Promise<Buffer<ArrayBufferLike>>

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

    Parameters

    • reqBuf: Buffer<ArrayBufferLike>

      The command buffer.

    Returns Promise<Buffer<ArrayBufferLike>>

    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.

decrease

  • decrease(): Promise<void>

  • Decreases the humidifier setting.

    Returns Promise<void>

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

discoverServices

getCharacteristics

getDeviceName

increase

  • increase(): Promise<void>

  • Increases the humidifier setting.

    Returns Promise<void>

log

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

percentage

  • percentage(level: number): Promise<void>

  • Sets the humidifier level.

    Parameters

    • level: number

      The level to set (0-100).

    Returns Promise<void>

setAutoMode

  • setAutoMode(): Promise<void>

  • Sets the humidifier to auto mode.

    Returns Promise<void>

setDeviceName

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

setManualMode

  • setManualMode(): Promise<void>

  • Sets the humidifier to manual mode.

    Returns Promise<void>

turnOff

  • turnOff(): Promise<void>

  • Turns off the humidifier.

    Returns Promise<void>

turnOn

  • turnOn(): Promise<void>

  • Turns on the humidifier.

    Returns Promise<void>

unsubscribeFromNotify

StaticparseServiceData

  • parseServiceData(
        serviceData: Buffer<ArrayBufferLike>,
        emitLog: (level: string, message: string) => void,
    ): Promise<null | humidifierServiceData>

  • Parses the service data for WoHumi.

    Parameters

    • serviceData: Buffer<ArrayBufferLike>

      The service data buffer.

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

      The function to emit log messages.

    Returns Promise<null | humidifierServiceData>

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods