Skip to Content
🚀 We just launched! Please star us on Github!

Window Covering Channel

Channel Category: window_covering

Controls coverings like blinds, curtains, and shutters, including position and tilt adjustments.


Required Properties

PropertyData TypeRangeUnitPermissions
statusEnumopened/closed/opening/closing/stopped-RO (Read-Only)
positionUchar0–100%RW (Read/Write)
typeEnumcurtain/blind/roller/outdoor_blind-RO (Read-Only)

Property Details

status

Describes the state of the covering:

  • Possible values:
    • opened: The covering is fully open.
    • closed: The covering is fully closed.
    • opening: The covering is in the process of opening.
    • closing: The covering is in the process of closing.
    • stopped: The covering has stopped mid-operation.

position

Represents the current openness of the covering as a percentage:

  • 0%: Fully closed
  • 100%: Fully open
  • Intermediate values indicate partial opening

This property is the primary way to read or set the target position.

type

Defines the type of window covering:

  • Possible values:
    • curtain: Indoor curtains.
    • blind: Indoor blinds.
    • roller: Roll-up coverings.
    • outdoor_blind: Outdoor blinds.

Optional Properties

PropertyData TypeRangeUnitPermissions
commandEnumopen/close/stop-WO (Write-Only)
obstructionBooltrue/false-RO (Read-Only)
tiltChar-90–90degreesRW (Read/Write)
faultUchar0–255-RO (Read-Only)

Property Details

command

Issues a direct command to the covering, independent of the position value:

  • open: Fully open the covering
  • close: Fully close the covering
  • stop: Halt the covering’s movement immediately

This property is intended as a convenience for quick actions.

obstruction

Indicates whether the covering is obstructed:

  • true: An obstruction is detected, preventing the covering from moving.
  • false: No obstruction is detected.

angle

Represents the tilt angle of the covering:

  • 0: Neutral position.
  • Negative values: Tilt towards one direction.
  • Positive values: Tilt towards the opposite direction.

fault

Represents the fault state of the actor:

  • 0: No fault detected.
  • Non-zero: A fault has been detected, potentially affecting functionality.
Last updated on