class Matter::Cluster::OnOffCluster

• Matter::Cluster::OnOffCluster
• Matter::Cluster::Base
• Reference
• Object

Overview

On/Off Cluster Implementation (0x0006) Provides binary on/off control with optional lighting and timing features

Features:

• Lighting (LT): Enables level control interaction and global scene management
• DeadFrontBehavior (DF): Device exhibits "dead front" when off
• OffOnly: Device can only be turned off (On/Toggle not supported)

Matter Spec: Application Clusters 1.5

Defined in:

Constant Summary

ACCEPTED_COMMAND_LIST = 65529_u32

ATTR_GLOBAL_SCENE_CONTROL = 16384_u32

ATTR_OFF_WAIT_TIME = 16386_u32

ATTR_ON_OFF = 0_u32

Attribute IDs

ATTR_ON_TIME = 16385_u32

ATTR_START_UP_ON_OFF = 16387_u32

ATTRIBUTE_LIST = 65531_u32

CLUSTER_ID = 6_u32

CLUSTER_REVISION = 65533_u32

Global attributes

CMD_OFF = 0_u32

Command IDs

CMD_OFF_WITH_EFFECT = 64_u32

CMD_ON = 1_u32

CMD_ON_WITH_RECALL_GLOBAL_SCENE = 65_u32

CMD_ON_WITH_TIMED_OFF = 66_u32

CMD_TOGGLE = 2_u32

FEATURE_MAP = 65532_u32

GENERATED_COMMAND_LIST = 65528_u32

Constructors

• .new(endpoint_id : DataType::EndpointNumber, on_off : Bool = false, feature_map : Feature = Feature::None)

Class Method Summary

• .cluster_id

  On/Off Cluster Implementation (0x0006) Provides binary on/off control with optional lighting and timing features

Instance Method Summary

• #apply_scene_extension_field_set(field_set : ScenesManagementCluster::ExtensionFieldSet) : Bool
• #attributes : Array(AttributeMetadata)

  Get all attribute metadata

• #commands : Array(CommandMetadata)

  Get all command metadata

• #feature_map : Feature
• #feature_map=(feature_map : Feature)
• #global_scene_control=(global_scene_control : Bool)

  Lighting feature attributes

• #global_scene_control? : Bool

  Lighting feature attributes

• #name : String

  Get cluster name

• #off? : Bool
• #off_wait_time : UInt16
• #off_wait_time=(off_wait_time : UInt16)
• #on=(state : Bool) : Bool
• #on? : Bool
• #on_off=(on_off : Bool)

  State

• #on_off? : Bool

  State

• #on_state_changed(&block : Bool -> Nil)

  Set callback for state changes

• #on_time : UInt16
• #on_time=(on_time : UInt16)
• #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

• #restore_state(json : String) : Nil

  Restore cluster state from JSON.

• #save_state : String | Nil

  Save cluster state to JSON for persistence.

• #start_up_on_off : StartUpOnOff | Nil
• #start_up_on_off=(start_up_on_off : StartUpOnOff | Nil)
• #store_scene_extension_field_set : ScenesManagementCluster::ExtensionFieldSet | Nil

  ------------------------------------------------------------------------ ScenesManagement extension field sets ------------------------------------------------------------------------

• #toggle : Bool
• #write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status

  Write an attribute value

Constructor Detail

Class Method Detail

Instance Method Detail