class Matter::Cluster::WindowCoveringCluster

• Matter::Cluster::WindowCoveringCluster
• Matter::Cluster::Base
• Reference
• Object

Overview

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

Defined in:

matter/cluster/window_covering_cluster.cr

Constant Summary

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)

Class Method Summary

• .cluster_id

  Window Covering Cluster Implementation (0x0102)

Instance Method Summary

• #attributes : Array(AttributeMetadata)

  Get all attribute metadata

• #commands : Array(CommandMetadata)

  Get all command metadata

• #config_status : ConfigStatus
• #config_status=(config_status : ConfigStatus)
• #covering_type : CoveringType
• #covering_type=(covering_type : CoveringType)
• #current_position_lift_percent100ths : UInt16 | Nil
• #current_position_lift_percent100ths=(current_position_lift_percent100ths : UInt16 | Nil)
• #current_position_lift_percentage : UInt8 | Nil

  Lift properties

• #current_position_lift_percentage=(current_position_lift_percentage : UInt8 | Nil)

  Lift properties

• #current_position_tilt_percent100ths : UInt16 | Nil
• #current_position_tilt_percent100ths=(current_position_tilt_percent100ths : UInt16 | Nil)
• #current_position_tilt_percentage : UInt8 | Nil

  Tilt properties

• #current_position_tilt_percentage=(current_position_tilt_percentage : UInt8 | Nil)

  Tilt properties

• #end_product_type : EndProductType
• #end_product_type=(end_product_type : EndProductType)
• #feature_map : Feature
• #feature_map=(feature_map : Feature)
• #mode : Mode
• #mode=(mode : Mode)
• #name : String

  Get cluster name

• #number_of_actuations_lift : UInt16 | Nil
• #number_of_actuations_lift=(number_of_actuations_lift : UInt16 | Nil)
• #number_of_actuations_tilt : UInt16 | Nil
• #number_of_actuations_tilt=(number_of_actuations_tilt : UInt16 | Nil)
• #operational_status : OperationalStatus
• #operational_status=(operational_status : OperationalStatus)
• #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

• #safety_status : UInt16 | Nil

  Safety status

• #safety_status=(safety_status : UInt16 | Nil)

  Safety status

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

  Write an attribute value

Constructor Detail

Class Method Detail

Instance Method Detail