Class WoVacuumK10Pro

Robot Vacuum Cleaner K10+ Pro

Hierarchy (View Summary)

WoVacuum
- WoVacuumK10Pro

Constructors

constructor

new WoVacuumK10Pro(
    info: DeviceInfo,
    options?: {
        apiClient?: OpenAPIClient;
        bleConnection?: BLEConnection;
        circuitBreakerConfig?: CircuitBreakerConfig;
        enableCircuitBreaker?: boolean;
        enableConnectionIntelligence?: boolean;
        enableFallback?: boolean;
        enableRetry?: boolean;
        logLevel?: number;
        preferredConnection?: ConnectionType;
        retryConfig?: RetryConfig;
    },
): WoVacuumK10Pro
Parameters
- info: DeviceInfo
- options: {
      apiClient?: OpenAPIClient;
      bleConnection?: BLEConnection;
      circuitBreakerConfig?: CircuitBreakerConfig;
      enableCircuitBreaker?: boolean;
      enableConnectionIntelligence?: boolean;
      enableFallback?: boolean;
      enableRetry?: boolean;
      logLevel?: number;
      preferredConnection?: ConnectionType;
      retryConfig?: RetryConfig;
  } = {}
Returns WoVacuumK10Pro
Inherited from WoVacuum.constructor
- Defined in devices/sequence-device.ts:37

Accessors

activeConnection

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

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

deviceType

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

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

id

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

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

mac

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

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

name

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

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

Methods

cleanUp

cleanUp(protocolVersion: number): Promise<boolean>
Start cleaning (BLE-first, API-fallback)
Parameters
- protocolVersion: number
Returns Promise<boolean>
Inherited from WoVacuum.cleanUp
- Defined in devices/wo-vacuum.ts:18

getActiveConnection

getActiveConnection(): ConnectionType | undefined
Get active connection type

Returns ConnectionType | undefined
Inherited from WoVacuum.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 WoVacuum.getBasicInfo
- Defined in devices/base.ts:778

getBattery

getBattery(): number | undefined
Return advertised battery value

Returns number | undefined
Inherited from WoVacuum.getBattery
- Defined in devices/wo-vacuum.ts:74

getCircuitBreakerAPI

getCircuitBreakerAPI(): CircuitBreaker
Get circuit breaker for API

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

getCircuitBreakerBLE

getCircuitBreakerBLE(): CircuitBreaker
Get circuit breaker for BLE

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

getConnectionTracker

getConnectionTracker(): ConnectionTracker
Get connection tracker for this device

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

getDeviceType

getDeviceType(): string
Get device type

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

getDustbinBoundStatus

getDustbinBoundStatus(): boolean | undefined
Return advertised dustbin bound state

Returns boolean | undefined
Inherited from WoVacuum.getDustbinBoundStatus
- Defined in devices/wo-vacuum.ts:90

getDustbinConnectedStatus

getDustbinConnectedStatus(): boolean | undefined
Return advertised dustbin connected state

Returns boolean | undefined
Inherited from WoVacuum.getDustbinConnectedStatus
- Defined in devices/wo-vacuum.ts:98

getFallbackHandlerManager

getFallbackHandlerManager(): FallbackHandlerManager
Get fallback handler manager

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

getId

getId(): string
Get device ID

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

getInfo

getInfo(): DeviceInfo
Get device information

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

getMAC

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

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

getName

getName(): string
Get device name

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

getNetworkConnectedStatus

getNetworkConnectedStatus(): boolean | undefined
Return advertised network connected state

Returns boolean | undefined
Inherited from WoVacuum.getNetworkConnectedStatus
- Defined in devices/wo-vacuum.ts:106

getStatus

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

Returns Promise<VacuumStatus>
Inherited from WoVacuum.getStatus
- Defined in devices/wo-vacuum.ts:114

getWorkStatus

getWorkStatus(): number | undefined
Return advertised work status value

Returns number | undefined
Inherited from WoVacuum.getWorkStatus
- Defined in devices/wo-vacuum.ts:82

hasAPI

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

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

hasBLE

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

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

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 WoVacuum.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 WoVacuum.pollNeeded
- Defined in devices/base.ts:213

registerFallbackHandler

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

returnToDock

returnToDock(protocolVersion: number): Promise<boolean>
Return to dock (BLE-first, API-fallback)
Parameters
- protocolVersion: number
Returns Promise<boolean>
Inherited from WoVacuum.returnToDock
- Defined in devices/wo-vacuum.ts:46

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 WoVacuum.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 WoVacuum.sendMultipleCommands
- Defined in devices/base.ts:192

setCircuitBreakerEnabled

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

setConnectionIntelligenceEnabled

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

setFallbackEnabled

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

setMode

setMode(mode: string | number): Promise<CommandResult>
Universal mode setting command BLE: 0x57 0x03 [modeByte] API: 'setMode' (if available)
Parameters
- mode: string | number
  Mode value (number or string, per-device enum recommended)
  
  Example usage: await device.setMode('auto') await device.setMode(1)
  
  Returns a CommandResult object indicating success and mode info.
Returns Promise<CommandResult>
Inherited from WoVacuum.setMode
- Defined in devices/base.ts:802

setPreferredConnection

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

setRetryEnabled

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

unregisterFallbackHandler

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

update

update(): Promise<DeviceStatus>
Refresh status for this device. Called automatically after sequence changes.

Returns Promise<DeviceStatus>
Inherited from WoVacuum.update
- Defined in devices/sequence-device.ts:59

updateInfo

updateInfo(newInfo: Partial<DeviceInfo>): void
Update device information and react to sequence number changes.
Parameters
- newInfo: Partial<DeviceInfo>
Returns void
Inherited from WoVacuum.updateInfo
- Defined in devices/sequence-device.ts:66

Class WoVacuumK10Pro

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns WoVacuumK10Pro

Accessors

activeConnection

Returns ConnectionType | undefined

deviceType

Returns string

id

Returns string | undefined

mac

Returns string | undefined

name

Returns string

Methods

cleanUp

Parameters

Returns Promise<boolean>

getActiveConnection

Returns ConnectionType | undefined

getBasicInfo

Returns Promise<CommandResult>

getBattery

Returns number | undefined

getCircuitBreakerAPI

Returns CircuitBreaker

getCircuitBreakerBLE

Returns CircuitBreaker

getConnectionTracker

Returns ConnectionTracker

getDeviceType

Returns string

getDustbinBoundStatus

Returns boolean | undefined

getDustbinConnectedStatus

Returns boolean | undefined

getFallbackHandlerManager

Returns FallbackHandlerManager

getId

Returns string

getInfo

Returns DeviceInfo

getMAC

Returns string | undefined

getName

Returns string

getNetworkConnectedStatus

Returns boolean | undefined

getStatus

Returns Promise<VacuumStatus>

getWorkStatus

Returns number | undefined

hasAPI

Returns boolean

hasBLE

Returns boolean

pollIfNeeded

Parameters

Returns Promise<DeviceStatus | undefined>

pollNeeded

Parameters

Returns boolean

registerFallbackHandler

Parameters

Returns string

returnToDock

Parameters

Returns Promise<boolean>

sendCommandSequence

Parameters

Returns Promise<boolean>

sendMultipleCommands

Parameters