Class WoBlindTilt

Class representing a WoBlindTilt device.

See

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

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

close closeDown closeUp command connect disconnect discoverServices getBasicInfo getCharacteristics getDeviceName getPosition internalConnect log open 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>

  • 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

close

  • close(): Promise<void>

    Closes the blind tilt to the nearest endpoint.

    Returns Promise<void>

closeDown

  • closeDown(): Promise<void>

    Closes the blind tilt down to the nearest endpoint.

    Returns Promise<void>

closeUp

  • closeUp(): Promise<void>

    Closes the blind tilt up to the nearest endpoint.

    Returns Promise<void>

command

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

    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.

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

getBasicInfo

  • getBasicInfo(): Promise<null | object>

    Retrieves the basic information of the blind tilt.

    Returns Promise<null | object>

    • A promise that resolves to an object containing the basic information of the blind tilt.

getCharacteristics

getDeviceName

getPosition

  • getPosition(): Promise<number>

    Retrieves the current position of the blind tilt.

    Returns Promise<number>

    • The current position of the blind tilt (0-100).

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

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>

open

  • open(): Promise<void>

    Opens the blind tilt to the fully open position.

    Returns Promise<void>

pause

  • pause(): Promise<void>

    Pauses the blind tilt operation.

    Returns Promise<void>

runToPos

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

    Runs the blind tilt to the specified position.

    Parameters

    • percent: number

      The target position percentage (0-100).

    • mode: number

      The running mode (0 or 1).

    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.

unsubscribeFromNotify

StaticparseServiceData

  • parseServiceData(
        serviceData: Buffer,
        manufacturerData: Buffer,
        emitLog: (level: string, message: string) => void,
        reverse?: boolean,
    ): Promise<null | blindTiltServiceData>

    Parses the service data and manufacturer data for the WoBlindTilt device.

    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.

    • Optionalreverse: boolean = false

      Whether to reverse the tilt percentage.

    Returns Promise<null | blindTiltServiceData>

    • The parsed data object or null if the data is invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods