Class WoPlugMiniUS

Class representing a WoPlugMini device.

See

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

Hierarchy (view full)

Constructors

constructor

Accessors

address connectionState friendlyName id model modelName onConnectHandler onDisconnectHandler

Methods

command connect disconnect discoverServices getCharacteristics getDeviceName log operatePlug readState setDeviceName toggle 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>)

      • (): 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>

operatePlug

  • operatePlug(bytes): Promise<boolean>

  • Operates the plug with the given bytes.

    Parameters

    • bytes: number[]

      The byte array to send to the plug.

    Returns Promise<boolean>

    • Resolves with a boolean that tells whether the plug is ON (true) or OFF (false).

readState

  • readState(): Promise<boolean>

  • Reads the state of the plug.

    Returns Promise<boolean>

    • Resolves with a boolean that tells whether the plug is ON (true) or OFF (false).

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.

toggle

  • toggle(): Promise<boolean>

  • Toggles the state of the plug.

    Returns Promise<boolean>

    • Resolves with a boolean that tells whether the plug is ON (true) or OFF (false).

turnOff

  • turnOff(): Promise<boolean>

  • Turns off the plug.

    Returns Promise<boolean>

    • Resolves with a boolean that tells whether the plug is ON (true) or OFF (false).

turnOn

  • turnOn(): Promise<boolean>

  • Turns on the plug.

    Returns Promise<boolean>

    • Resolves with a boolean that tells whether the plug is ON (true) or OFF (false).

unsubscribeFromNotify

StaticparseServiceData

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

  • Parses the service data for WoPlugMini US.

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

    • Parsed service data or null if invalid.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods