Class WoRollerShade

Optional_lastPosition

activeConnection

• get activeConnection(): ConnectionType | undefined

  Get active connection type (property accessor for convenience)

  Returns ConnectionType | undefined

deviceType

• get deviceType(): string

  Get device type (property accessor for convenience)

  Returns string

id

• get id(): string | undefined

  Get device ID (property accessor for convenience)

  Returns string | undefined

mac

• get mac(): string | undefined

  Get MAC address (property accessor for convenience)

  Returns string | undefined

name

• get name(): string

  Get device name (property accessor for convenience)

  Returns string

close

• close(speed?: number): Promise<boolean>

  Close curtain (position 100%)

  Parameters

  • speed: number = 255

  Returns Promise<boolean>

getActiveConnection

• getActiveConnection(): ConnectionType | undefined

  Get active connection type

  Returns ConnectionType | undefined

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>

getCircuitBreakerAPI

• getCircuitBreakerAPI(): CircuitBreaker

  Get circuit breaker for API

  Returns CircuitBreaker

getCircuitBreakerBLE

• getCircuitBreakerBLE(): CircuitBreaker

  Get circuit breaker for BLE

  Returns CircuitBreaker

getConnectionTracker

• getConnectionTracker(): ConnectionTracker

  Get connection tracker for this device

  Returns ConnectionTracker

getDeviceType

• getDeviceType(): string

  Get device type

  Returns string

getExtendedInfo

• getExtendedInfo(): Promise<CurtainExtendedInfo>

  Get extended device information (Curtain 3) Returns device chain information and grouped curtain status

  Returns Promise<CurtainExtendedInfo>

getFallbackHandlerManager

• getFallbackHandlerManager(): FallbackHandlerManager

  Get fallback handler manager

  Returns FallbackHandlerManager

getId

• getId(): string

  Get device ID

  Returns string

getInfo

• getInfo(): DeviceInfo

  Get device information

  Returns DeviceInfo

getMAC

• getMAC(): string | undefined

  Get MAC address (if available)

  Returns string | undefined

getName

• getName(): string

  Get device name

  Returns string

getStatus

• getStatus(): Promise<CurtainStatus>

  Returns Promise<CurtainStatus>

hasAPI

• hasAPI(): boolean

  Check if API is available for this device

  Returns boolean

hasBLE

• hasBLE(): boolean

  Check if BLE is available for this device

  Returns boolean

open

• open(speed?: number): Promise<boolean>

  Open curtain (position 0%)

  Parameters

  • speed: number = 255

  Returns Promise<boolean>

pause

• pause(): Promise<boolean>

  Pause curtain movement

  Returns Promise<boolean>

pollIfNeeded

• pollIfNeeded(interval?: number): Promise<DeviceStatus | undefined>

  Poll device status if needed (passive polling)

  Parameters

  • interval: number = PASSIVE_POLL_INTERVAL

  Returns Promise<DeviceStatus | undefined>

pollNeeded

• pollNeeded(interval?: number): boolean

  Returns true if device should be polled (passive polling interval elapsed)

  Parameters

  • interval: number = PASSIVE_POLL_INTERVAL

  Returns boolean

registerFallbackHandler

• registerFallbackHandler(
      handler: FallbackHandler,
      options?: FallbackHandlerOptions,
  ): string

  Register a custom fallback handler

  Parameters

  • handler: FallbackHandler
  • Optionaloptions: FallbackHandlerOptions

  Returns string

sendCommandSequence

• sendCommandSequence(commands: (() => Promise<boolean>)[]): Promise<boolean>

  Send multiple commands in sequence (all must succeed) Used for Curtain 3 complex operations

  Parameters

  • commands: (() => Promise<boolean>)[]

  Returns Promise<boolean>

sendMultipleCommands

• sendMultipleCommands(commands: (() => Promise<boolean>)[]): Promise<boolean>

  Send multiple commands (returns true if any succeed) Used for Curtain 3 fallback operations

  Parameters

  • commands: (() => Promise<boolean>)[]

  Returns Promise<boolean>

setCircuitBreakerEnabled

• setCircuitBreakerEnabled(enabled: boolean): void

  Enable or disable circuit breaker

  Parameters

  • enabled: boolean

  Returns void

setConnectionIntelligenceEnabled

• setConnectionIntelligenceEnabled(enabled: boolean): void

  Enable or disable connection intelligence

  Parameters

  • enabled: boolean

  Returns void

setFallbackEnabled

• setFallbackEnabled(enabled: boolean): void

  Enable or disable fallback

  Parameters

  • enabled: boolean

  Returns void

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>

setPosition

• setPosition(position: number, speed?: number): Promise<boolean>

  Set curtain position (0-100%)

  Parameters

  • position: number
  • speed: number = 255

  Returns Promise<boolean>

setPreferredConnection

• setPreferredConnection(type: ConnectionType): void

  Set preferred connection type

  Parameters

  • type: ConnectionType

  Returns void

setRetryEnabled

• setRetryEnabled(enabled: boolean): void

  Enable or disable retry logic

  Parameters

  • enabled: boolean

  Returns void

unregisterFallbackHandler

• unregisterFallbackHandler(id: string): boolean

  Unregister a fallback handler

  Parameters

  • id: string

  Returns boolean

updateInfo

• updateInfo(newInfo: Partial<DeviceInfo>): void

  Update device information

  Parameters

  • newInfo: Partial<DeviceInfo>

  Returns void