Class WoHand

Bot (WoHand) Device - Press or switch button device Supports optional BLE password protection

Hierarchy (View Summary)

DeviceOverrideStateDuringConnection
- WoHand

Implements

BotCommands

Constructors

constructor

new WoHand(
    info: DeviceInfo,
    options?: {
        apiClient?: OpenAPIClient;
        bleConnection?: BLEConnection;
        enableCircuitBreaker?: boolean;
        enableConnectionIntelligence?: boolean;
        enableFallback?: boolean;
        enableRetry?: boolean;
        logLevel?: number;
        password?: string;
        preferredConnection?: "ble" | "api";
    },
): WoHand
Parameters
- info: DeviceInfo
- options: {
      apiClient?: OpenAPIClient;
      bleConnection?: BLEConnection;
      enableCircuitBreaker?: boolean;
      enableConnectionIntelligence?: boolean;
      enableFallback?: boolean;
      enableRetry?: boolean;
      logLevel?: number;
      password?: string;
      preferredConnection?: "ble" | "api";
  } = {}
Returns WoHand
Overrides DeviceOverrideStateDuringConnection.constructor
- Defined in devices/wo-hand.ts:50

Accessors

activeConnection

get activeConnection(): ConnectionType | undefined
Get active connection type (property accessor for convenience)

Returns ConnectionType | undefined
Inherited from DeviceOverrideStateDuringConnection.activeConnection
- Defined in devices/base.ts:305

deviceType

get deviceType(): string
Get device type (property accessor for convenience)

Returns string
Inherited from DeviceOverrideStateDuringConnection.deviceType
- Defined in devices/base.ts:277

id

get id(): string | undefined
Get device ID (property accessor for convenience)

Returns string | undefined
Inherited from DeviceOverrideStateDuringConnection.id
- Defined in devices/base.ts:249

mac

get mac(): string | undefined
Get MAC address (property accessor for convenience)

Returns string | undefined
Inherited from DeviceOverrideStateDuringConnection.mac
- Defined in devices/base.ts:291

name

get name(): string
Get device name (property accessor for convenience)

Returns string
Inherited from DeviceOverrideStateDuringConnection.name
- Defined in devices/base.ts:263

Methods

clearPassword

clearPassword(): void
Clear Bot password

Returns void
- Defined in devices/wo-hand.ts:230

getActiveConnection

getActiveConnection(): ConnectionType | undefined
Get active connection type

Returns ConnectionType | undefined
Inherited from DeviceOverrideStateDuringConnection.getActiveConnection
- Defined in devices/base.ts:298

getBasicInfo

getBasicInfo(): Promise<CommandResult>
Get basic device info (universal settings retrieval) Returns: battery, firmware, device-specific settings, etc. Command: 0x57 0x02 (BLE), 'getBasicInfo' (API)

Example usage: const info = await device.getBasicInfo(); console.log(info);

Returns a CommandResult object with device info fields.

Returns Promise<CommandResult>
Inherited from DeviceOverrideStateDuringConnection.getBasicInfo
- Defined in devices/base.ts:778

getCircuitBreakerAPI

getCircuitBreakerAPI(): CircuitBreaker
Get circuit breaker for API

Returns CircuitBreaker
Inherited from DeviceOverrideStateDuringConnection.getCircuitBreakerAPI
- Defined in devices/base.ts:881

getCircuitBreakerBLE

getCircuitBreakerBLE(): CircuitBreaker
Get circuit breaker for BLE

Returns CircuitBreaker
Inherited from DeviceOverrideStateDuringConnection.getCircuitBreakerBLE
- Defined in devices/base.ts:874

getConnectionTracker

getConnectionTracker(): ConnectionTracker
Get connection tracker for this device

Returns ConnectionTracker
Inherited from DeviceOverrideStateDuringConnection.getConnectionTracker
- Defined in devices/base.ts:867

getDeviceType

getDeviceType(): string
Get device type

Returns string
Inherited from DeviceOverrideStateDuringConnection.getDeviceType
- Defined in devices/base.ts:270

getFallbackHandlerManager

getFallbackHandlerManager(): FallbackHandlerManager
Get fallback handler manager

Returns FallbackHandlerManager
Inherited from DeviceOverrideStateDuringConnection.getFallbackHandlerManager
- Defined in devices/base.ts:905

getId

getId(): string
Get device ID

Returns string
Inherited from DeviceOverrideStateDuringConnection.getId
- Defined in devices/base.ts:242

getInfo

getInfo(): DeviceInfo
Get device information

Returns DeviceInfo
Inherited from DeviceOverrideStateDuringConnection.getInfo
- Defined in devices/base.ts:235

getMAC

getMAC(): string | undefined
Get MAC address (if available)

Returns string | undefined
Inherited from DeviceOverrideStateDuringConnection.getMAC
- Defined in devices/base.ts:284

getName

getName(): string
Get device name

Returns string
Inherited from DeviceOverrideStateDuringConnection.getName
- Defined in devices/base.ts:256

getStatus

getStatus(): Promise<BotStatus>
Get device status (BLE-first, API-fallback)

Returns Promise<BotStatus>
Overrides DeviceOverrideStateDuringConnection.getStatus
- Defined in devices/wo-hand.ts:23

handDown

handDown(): Promise<boolean>
Lower Bot arm

Returns Promise<boolean>
Implementation of BotCommands.handDown
- Defined in devices/wo-hand.ts:169

handUp

handUp(): Promise<boolean>
Raise Bot arm

Returns Promise<boolean>
Implementation of BotCommands.handUp
- Defined in devices/wo-hand.ts:158

hasAPI

hasAPI(): boolean
Check if API is available for this device

Returns boolean
Inherited from DeviceOverrideStateDuringConnection.hasAPI
- Defined in devices/base.ts:319

hasBLE

hasBLE(): boolean
Check if BLE is available for this device

Returns boolean
Inherited from DeviceOverrideStateDuringConnection.hasBLE
- Defined in devices/base.ts:312

hasPassword

hasPassword(): boolean
Check if password is configured

Returns boolean
- Defined in devices/wo-hand.ts:238

pollIfNeeded

pollIfNeeded(interval?: number): Promise<DeviceStatus | undefined>
Poll device status if needed (passive polling)
Parameters
- interval: number = PASSIVE_POLL_INTERVAL
Returns Promise<DeviceStatus | undefined>
Inherited from DeviceOverrideStateDuringConnection.pollIfNeeded
- Defined in devices/base.ts:223

pollNeeded

pollNeeded(interval?: number): boolean
Returns true if device should be polled (passive polling interval elapsed)
Parameters
- interval: number = PASSIVE_POLL_INTERVAL
Returns boolean
Inherited from DeviceOverrideStateDuringConnection.pollNeeded
- Defined in devices/base.ts:213

press

press(): Promise<boolean>
Press (press mode)

Returns Promise<boolean>
Implementation of BotCommands.press
- Defined in devices/wo-hand.ts:116

registerFallbackHandler

registerFallbackHandler(
handler: FallbackHandler,
options?: FallbackHandlerOptions,
): string
Register a custom fallback handler
Parameters
- handler: FallbackHandler
- Optionaloptions: FallbackHandlerOptions
Returns string
Inherited from DeviceOverrideStateDuringConnection.registerFallbackHandler
- Defined in devices/base.ts:888

sendCommandSequence

sendCommandSequence(commands: (() => Promise<boolean>)[]): Promise<boolean>
Send multiple commands in sequence (all must succeed) Used for Curtain 3, bulbs, strips, and other multi-step devices
Parameters
- commands: (() => Promise<boolean>)[]
Returns Promise<boolean>
Inherited from DeviceOverrideStateDuringConnection.sendCommandSequence
- Defined in devices/base.ts:170

sendMultipleCommands

sendMultipleCommands(commands: (() => Promise<boolean>)[]): Promise<boolean>
Send multiple commands (returns true if any succeed) Used for fallback operations with complex patterns
Parameters
- commands: (() => Promise<boolean>)[]
Returns Promise<boolean>
Inherited from DeviceOverrideStateDuringConnection.sendMultipleCommands
- Defined in devices/base.ts:192

setCircuitBreakerEnabled

setCircuitBreakerEnabled(enabled: boolean): void
Enable or disable circuit breaker
Parameters
- enabled: boolean
Returns void
Inherited from DeviceOverrideStateDuringConnection.setCircuitBreakerEnabled
- Defined in devices/base.ts:851

setConnectionIntelligenceEnabled

setConnectionIntelligenceEnabled(enabled: boolean): void
Enable or disable connection intelligence
Parameters
- enabled: boolean
Returns void
Inherited from DeviceOverrideStateDuringConnection.setConnectionIntelligenceEnabled
- Defined in devices/base.ts:843

setFallbackEnabled

setFallbackEnabled(enabled: boolean): void
Enable or disable fallback
Parameters
- enabled: boolean
Returns void
Inherited from DeviceOverrideStateDuringConnection.setFallbackEnabled
- Defined in devices/base.ts:835

setLongPress

setLongPress(duration: number): Promise<boolean>
Set Bot long-press duration (1-255 deciseconds)
Parameters
- duration: number
Returns Promise<boolean>
Implementation of BotCommands.setLongPress
- Defined in devices/wo-hand.ts:145

setMode

setMode(mode: "press" | "switch"): Promise<CommandResult>
Set Bot mode
Parameters
- mode: "press" | "switch"
Returns Promise<CommandResult>
Implementation of BotCommands.setMode
Overrides DeviceOverrideStateDuringConnection.setMode
- Defined in devices/wo-hand.ts:133

setPassword

setPassword(password: string): void
Set or update Bot password
Parameters
- password: string
  4-character alphanumeric password (case-sensitive)
Returns void
- Defined in devices/wo-hand.ts:221

setPreferredConnection

setPreferredConnection(type: ConnectionType): void
Set preferred connection type
Parameters
- type: ConnectionType
Returns void
Inherited from DeviceOverrideStateDuringConnection.setPreferredConnection
- Defined in devices/base.ts:827

setRetryEnabled

setRetryEnabled(enabled: boolean): void
Enable or disable retry logic
Parameters
- enabled: boolean
Returns void
Inherited from DeviceOverrideStateDuringConnection.setRetryEnabled
- Defined in devices/base.ts:859

turnOff

turnOff(): Promise<boolean>
Turn off (switch mode)

Returns Promise<boolean>
Implementation of BotCommands.turnOff
- Defined in devices/wo-hand.ts:99

turnOn

turnOn(): Promise<boolean>
Turn on (switch mode)

Returns Promise<boolean>
Implementation of BotCommands.turnOn
- Defined in devices/wo-hand.ts:82

unregisterFallbackHandler

unregisterFallbackHandler(id: string): boolean
Unregister a fallback handler
Parameters
- id: string
Returns boolean
Inherited from DeviceOverrideStateDuringConnection.unregisterFallbackHandler
- Defined in devices/base.ts:898

updateInfo

updateInfo(newInfo: Partial<DeviceInfo>): void
Update device information
Parameters
- newInfo: Partial<DeviceInfo>
Returns void
Inherited from DeviceOverrideStateDuringConnection.updateInfo
- Defined in devices/device-override-state-during-connection.ts:36

Class WoHand

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns WoHand

Accessors

activeConnection

Returns ConnectionType | undefined

deviceType

Returns string

id

Returns string | undefined

mac

Returns string | undefined

name

Returns string

Methods

clearPassword

Returns void

getActiveConnection

Returns ConnectionType | undefined

getBasicInfo

Returns Promise<CommandResult>

getCircuitBreakerAPI

Returns CircuitBreaker

getCircuitBreakerBLE

Returns CircuitBreaker

getConnectionTracker

Returns ConnectionTracker

getDeviceType

Returns string

getFallbackHandlerManager

Returns FallbackHandlerManager

getId

Returns string

getInfo

Returns DeviceInfo

getMAC

Returns string | undefined

getName

Returns string

getStatus

Returns Promise<BotStatus>

handDown

Returns Promise<boolean>

handUp

Returns Promise<boolean>

hasAPI

Returns boolean

hasBLE

Returns boolean

hasPassword

Returns boolean

pollIfNeeded

Parameters

Returns Promise<DeviceStatus | undefined>

pollNeeded

Parameters

Returns boolean

press

Returns Promise<boolean>

registerFallbackHandler

Parameters

Returns string

sendCommandSequence

Parameters

Returns Promise<boolean>

sendMultipleCommands

Parameters

Returns Promise<boolean>

setCircuitBreakerEnabled

Parameters

Returns void

setConnectionIntelligenceEnabled