class Matter::Cluster::GeneralCommissioningCluster

• Matter::Cluster::GeneralCommissioningCluster
• Matter::Cluster::Base
• Reference
• Object

Overview

General Commissioning Cluster (0x0030)

Provides commands and attributes to support the device commissioning process. This includes commissioning window management, failsafe timer management, regulatory configuration, and commissioning completion.

Matter Core Spec §11.9 - General Commissioning Cluster

Defined in:

matter/cluster/general_commissioning_cluster.cr

Constant Summary

ATTR_BASIC_COMMISSIONING_INFO = 1_u32

ATTR_BREADCRUMB = 0_u32

ATTR_LOCATION_CAPABILITY = 3_u32

ATTR_REGULATORY_CONFIG = 2_u32

ATTR_SUPPORTS_CONCURRENT_CONNECTION = 4_u32

CLUSTER_ID = 48_u32

CMD_ARM_FAIL_SAFE = 0_u32

CMD_ARM_FAIL_SAFE_RESPONSE = 1_u32

CMD_COMMISSIONING_COMPLETE = 4_u32

CMD_COMMISSIONING_COMPLETE_RESPONSE = 5_u32

CMD_SET_REGULATORY_CONFIG = 2_u32

CMD_SET_REGULATORY_CONFIG_RESPONSE = 3_u32

Log = ::Log.for("matter.cluster.general_commissioning")

Constructors

• .new(endpoint_id : DataType::EndpointNumber = DataType::EndpointNumber.new(0_u16))

Class Method Summary

• .cluster_id

  General Commissioning Cluster (0x0030)

Instance Method Summary

• #accept_terms_conditions : Nil

  Accept Terms & Conditions (for TC feature)

• #arm_fail_safe(expiry_seconds : UInt16) : Nil

  Simple arm failsafe method for tests (arms with default max cumulative)

• #arm_failsafe(request : ArmFailSafeRequest, session_fabric_index : UInt8 | Nil, is_pase_session : Bool) : ArmFailSafeResponse

  Handle ArmFailSafe command

• #attributes : Array(AttributeMetadata)

  Get all attribute metadata

• #basic_commissioning_info : BasicCommissioningInfo

  Get basic commissioning info (for BasicCommissioningInfo attribute)

• #breadcrumb : UInt64

  Breadcrumb attribute (0x0000) - progress tracking during commissioning

• #breadcrumb=(breadcrumb : UInt64)

  Breadcrumb attribute (0x0000) - progress tracking during commissioning

• #close_commissioning_window : Nil

  Close commissioning window

• #commands : Array(CommandMetadata)

  Get all command metadata

• #commissioning_complete(session_fabric_index : UInt8 | Nil, is_case_session : Bool) : CommissioningCompleteResponse

  Handle CommissioningComplete command

• #country_code : String

  Country code (stored for rollback purposes)

• #country_code=(country_code : String)

  Country code (stored for rollback purposes)

• #country_code_whitelist : Array(String) | Nil

  Country code whitelist (nil = all countries allowed)

• #country_code_whitelist=(country_code_whitelist : Array(String) | Nil)

  Country code whitelist (nil = all countries allowed)

• #disarm_fail_safe : Nil

  Disarm the failsafe

• #fail_safe_active : Bool

  Alias for backward compatibility

• #fail_safe_expiry_time : Time | Nil

  Get failsafe expiry time (when it will expire)

• #failsafe_armed? : Bool

  Check if failsafe is currently armed

• #failsafe_context : FailsafeContext | Nil

  Get current failsafe context (for testing/inspection)

• #is_fail_safe_expired? : Bool

  Check if failsafe is expired

• #location_capability : RegulatoryLocationType

  LocationCapability attribute (0x0003) - supported regulatory locations

• #location_capability=(location_capability : RegulatoryLocationType)

  LocationCapability attribute (0x0003) - supported regulatory locations

• #max_cumulative_failsafe_seconds : UInt16

  BasicCommissioningInfo attribute (0x0001) Contains MaxCumulativeFailsafeSeconds and MaxNetworkCommissioningSeconds

• #max_cumulative_failsafe_seconds=(max_cumulative_failsafe_seconds : UInt16)

  BasicCommissioningInfo attribute (0x0001) Contains MaxCumulativeFailsafeSeconds and MaxNetworkCommissioningSeconds

• #max_network_commissioning_seconds : UInt16
• #max_network_commissioning_seconds=(max_network_commissioning_seconds : UInt16)
• #name : String

  Get cluster name

• #on_check_terms_conditions : Proc(Bool) | Nil

  Callback to check if Terms & Conditions have been accepted

• #on_check_terms_conditions=(on_check_terms_conditions : Proc(Bool) | Nil)

  Callback to check if Terms & Conditions have been accepted

• #on_clear_pase_sessions : Proc(Nil) | Nil

  Callback to clear all PASE sessions after successful commissioning

• #on_clear_pase_sessions=(on_clear_pase_sessions : Proc(Nil) | Nil)

  Callback to clear all PASE sessions after successful commissioning

• #on_persist_fabric_table : Proc(Nil) | Nil

  Callback to persist the fabric table after successful commissioning

• #on_persist_fabric_table=(on_persist_fabric_table : Proc(Nil) | Nil)

  Callback to persist the fabric table after successful commissioning

• #open_commissioning_window : Nil

  Open commissioning window (allows PASE sessions)

• #read_attribute(attribute_id : UInt32) : InteractionModel::Status | Bytes

  Read an attribute value

• #regulatory_config : RegulatoryLocationType

  RegulatoryConfig attribute (0x0002) - current regulatory location

• #regulatory_config=(regulatory_config : RegulatoryLocationType)

  RegulatoryConfig attribute (0x0002) - current regulatory location

• #restore_regulatory_config(location_type : UInt8, country_code : String) : Nil

  Restore regulatory config from snapshot (called during rollback)

• #set_regulatory_config(request : SetRegulatoryConfigRequest) : SetRegulatoryConfigResponse

  Handle SetRegulatoryConfig command

• #supports_concurrent_connection : Bool

  SupportsConcurrentConnection attribute (0x0004)

• #supports_concurrent_connection=(supports_concurrent_connection : Bool)

  SupportsConcurrentConnection attribute (0x0004)

• #terms_conditions_accepted? : Bool

  Check if Terms & Conditions are accepted

• #terms_conditions_required : Bool

  Terms & Conditions feature support

• #terms_conditions_required=(terms_conditions_required : Bool)

  Terms & Conditions feature support

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

  Write an attribute value

Constructor Detail

Class Method Detail

Instance Method Detail