class

Matter::Cluster::WindowCoveringCluster

Inherits Matter::Cluster::Base < Reference < Object

Window Covering Cluster Implementation (0x0102)

Provides control for various types of window coverings such as blinds, shades, curtains, etc.

Matter Specification: Core 1.4 § 5.3 - Window Covering Cluster

Features:

  • Lift (LF): Supports lift/lower position control
  • Tilt (TL): Supports tilt control
  • PositionAwareLift (PA_LF): Supports precise lift positioning
  • AbsolutePosition (ABS): Supports absolute position control
  • PositionAwareTilt (PA_TL): Supports precise tilt positioning

Constants

ATTR_CONFIG_STATUS = 7_u32
ATTR_CURRENT_POSITION_LIFT = 3_u32
ATTR_CURRENT_POSITION_LIFT_PERCENT100THS = 14_u32
ATTR_CURRENT_POSITION_LIFT_PERCENTAGE = 8_u32
ATTR_CURRENT_POSITION_TILT = 4_u32
ATTR_CURRENT_POSITION_TILT_PERCENT100THS = 15_u32
ATTR_CURRENT_POSITION_TILT_PERCENTAGE = 9_u32
ATTR_END_PRODUCT_TYPE = 13_u32
ATTR_INSTALLED_CLOSED_LIMIT_LIFT = 17_u32
ATTR_INSTALLED_CLOSED_LIMIT_TILT = 19_u32
ATTR_INSTALLED_OPEN_LIMIT_LIFT = 16_u32
ATTR_INSTALLED_OPEN_LIMIT_TILT = 18_u32
ATTR_MODE = 23_u32
ATTR_NUMBER_OF_ACTUATIONS_LIFT = 5_u32
ATTR_NUMBER_OF_ACTUATIONS_TILT = 6_u32
ATTR_OPERATIONAL_STATUS = 10_u32
ATTR_PHYSICAL_CLOSED_LIMIT_LIFT = 1_u32
ATTR_PHYSICAL_CLOSED_LIMIT_TILT = 2_u32
ATTR_SAFETY_STATUS = 26_u32
ATTR_TARGET_POSITION_LIFT_PERCENT100THS = 11_u32
ATTR_TARGET_POSITION_TILT_PERCENT100THS = 12_u32
ATTR_TYPE = 0_u32

Attribute IDs

CLUSTER_ID = 258_u32
CLUSTER_REVISION = 65533_u32

Global attributes

CMD_DOWN_OR_CLOSE = 1_u32
CMD_GO_TO_LIFT_PERCENTAGE = 5_u32
CMD_GO_TO_LIFT_VALUE = 4_u32
CMD_GO_TO_TILT_PERCENTAGE = 8_u32
CMD_GO_TO_TILT_VALUE = 7_u32
CMD_STOP_MOTION = 2_u32
CMD_UP_OR_OPEN = 0_u32

Command IDs

FEATURE_MAP = 65532_u32

Constructors

new(endpoint_id : DataType::EndpointNumber, feature_map : Feature = Feature::Lift | Feature::PositionAwareLift, covering_type : CoveringType = CoveringType::Rollershade, end_product_type : EndProductType = EndProductType::RollerShade)
Source

Class methods

cluster_id

Window Covering Cluster Implementation (0x0102)

Provides control for various types of window coverings such as blinds, shades, curtains, etc.

Matter Specification: Core 1.4 § 5.3 - Window Covering Cluster

Features:

  • Lift (LF): Supports lift/lower position control
  • Tilt (TL): Supports tilt control
  • PositionAwareLift (PA_LF): Supports precise lift positioning
  • AbsolutePosition (ABS): Supports absolute position control
  • PositionAwareTilt (PA_TL): Supports precise tilt positioning
Source

Instance methods

attributes

Get all attribute metadata

Source
commands

Get all command metadata

Source
config_status
Source
config_status=(config_status : ConfigStatus)
Source
covering_type
Source
covering_type=(covering_type : CoveringType)
Source
current_position_lift_percent100ths
Source
current_position_lift_percent100ths=(current_position_lift_percent100ths : UInt16 | Nil)
Source
current_position_lift_percentage

Lift properties

Source
current_position_lift_percentage=(current_position_lift_percentage : UInt8 | Nil)

Lift properties

Source
current_position_tilt_percent100ths
Source
current_position_tilt_percent100ths=(current_position_tilt_percent100ths : UInt16 | Nil)
Source
current_position_tilt_percentage

Tilt properties

Source
current_position_tilt_percentage=(current_position_tilt_percentage : UInt8 | Nil)

Tilt properties

Source
end_product_type
Source
end_product_type=(end_product_type : EndProductType)
Source
feature_map
Source
feature_map=(feature_map : Feature)
Source
mode
Source
mode=(mode : Mode)
Source
name

Get cluster name

Source
number_of_actuations_lift
Source
number_of_actuations_lift=(number_of_actuations_lift : UInt16 | Nil)
Source
number_of_actuations_tilt
Source
number_of_actuations_tilt=(number_of_actuations_tilt : UInt16 | Nil)
Source
operational_status
Source
operational_status=(operational_status : OperationalStatus)
Source
read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | Bytes

Read an attribute value The fabric_index parameter is optional and used for fabric-scoped attributes like CurrentFabricIndex in OperationalCredentialsCluster

Source
safety_status

Safety status

Source
safety_status=(safety_status : UInt16 | Nil)

Safety status

Source
target_position_lift_percent100ths
Source
target_position_lift_percent100ths=(target_position_lift_percent100ths : UInt16 | Nil)
Source
target_position_tilt_percent100ths
Source
target_position_tilt_percent100ths=(target_position_tilt_percent100ths : UInt16 | Nil)
Source
write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status

Write an attribute value

Source

Nested types