Class WoCurtain

Class representing a WoCurtain device.

See

Hierarchy (view full)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

close command connect disconnect discoverServices getCharacteristics getDeviceName log open operateCurtain pause runToPos setDeviceName 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

close

  • close(mode?): Promise<void>

  • Closes the curtain.

    Parameters

    • Optionalmode: number = 0xFF

      Running mode (0x01 = QuietDrift, 0xFF = Default).

    Returns Promise<void>

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>

open

  • open(mode?): Promise<void>

  • Opens the curtain.

    Parameters

    • Optionalmode: number = 0xFF

      Running mode (0x01 = QuietDrift, 0xFF = Default).

    Returns Promise<void>

operateCurtain

  • operateCurtain(bytes): Promise<void>

  • Sends a command to the curtain.

    Parameters

    • bytes: number[]

      The command bytes.

    Returns Promise<void>

pause

runToPos

  • runToPos(percent, mode?): Promise<void>

  • Runs the curtain to the target position.

    Parameters

    • percent: number

      The percentage of the target position.

    • Optionalmode: number = 0xFF

      Running mode (0x01 = QuietDrift, 0xFF = Default).

    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.

unsubscribeFromNotify

StaticparseServiceData

  • parseServiceData(serviceData, manufacturerData, emitLog, reverse?): Promise<null | curtainServiceData | curtain3ServiceData>

  • Parses the service data for WoCurtain.

    Parameters

    • serviceData: Buffer

      The service data buffer.

    • 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

    • Optionalreverse: boolean = false

      Whether to reverse the position.

    Returns Promise<null | curtainServiceData | curtain3ServiceData>

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods