class
Matter::Cluster::CarbonDioxideConcentrationMeasurementCluster
Overview
Carbon Dioxide Concentration Measurement Cluster (0x040D)
Provides attributes for reporting Carbon Dioxide (CO2) concentration measurements and level indications in air, water, or soil. This cluster is a derived cluster from the base Concentration Measurement cluster specification.
Supports two main measurement modes:
- NumericMeasurement: Provides actual measured values in configurable units
- LevelIndication: Provides coarse level indication (Unknown, Low, Medium, High, Critical)
Specification: Matter 1.4 § 2.10 (Concentration Measurement)
Defined in:
matter/cluster/carbon_dioxide_concentration_measurement_cluster.crConstant Summary
-
ATTR_AVERAGE_MEASURED_VALUE =
5_u32 -
AverageMeasurement Feature Attributes
-
ATTR_AVERAGE_MEASURED_VALUE_WINDOW =
6_u32 -
ATTR_LEVEL_VALUE =
10_u32 -
LevelIndication Feature Attributes
-
ATTR_MAX_MEASURED_VALUE =
2_u32 -
ATTR_MEASURED_VALUE =
0_u32 -
NumericMeasurement Feature Attributes
-
ATTR_MEASUREMENT_MEDIUM =
9_u32 -
Base Attributes
-
ATTR_MEASUREMENT_UNIT =
8_u32 -
ATTR_MIN_MEASURED_VALUE =
1_u32 -
ATTR_PEAK_MEASURED_VALUE =
3_u32 -
PeakMeasurement Feature Attributes
-
ATTR_PEAK_MEASURED_VALUE_WINDOW =
4_u32 -
ATTR_UNCERTAINTY =
7_u32 -
CLUSTER_ID =
1037_u32
Constructors
Class Method Summary
-
.cluster_id
Carbon Dioxide Concentration Measurement Cluster (0x040D)
Instance Method Summary
-
#attributes : Array(AttributeMetadata)
Get all attribute metadata
-
#average_measured_value : Float32 | Nil
AverageMeasurement feature attributes
-
#average_measured_value=(average_measured_value : Float32 | Nil)
AverageMeasurement feature attributes
- #average_measured_value_window : UInt32 | Nil
- #average_measured_value_window=(average_measured_value_window : UInt32 | Nil)
-
#average_measurement_enabled? : Bool
Check if AverageMeasurement feature is enabled
-
#commands : Array(CommandMetadata)
Get all command metadata
-
#level_indication_enabled? : Bool
Check if LevelIndication feature is enabled
-
#level_value : LevelValue | Nil
LevelIndication feature attributes
-
#level_value=(level_value : LevelValue | Nil)
LevelIndication feature attributes
- #max_measured_value : Float32 | Nil
- #max_measured_value=(max_measured_value : Float32 | Nil)
-
#measured_value : Float32 | Nil
NumericMeasurement feature attributes
-
#measured_value=(measured_value : Float32 | Nil)
NumericMeasurement feature attributes
-
#measurement_medium : MeasurementMedium
Measurement medium (mandatory)
-
#measurement_medium=(measurement_medium : MeasurementMedium)
Measurement medium (mandatory)
- #measurement_unit : MeasurementUnit | Nil
- #measurement_unit=(measurement_unit : MeasurementUnit | Nil)
- #min_measured_value : Float32 | Nil
- #min_measured_value=(min_measured_value : Float32 | Nil)
-
#name : String
Get cluster name
-
#numeric_measurement_enabled? : Bool
Check if NumericMeasurement feature is enabled
- #on_average_measured_value_changed(&block : Float32 | Nil, Float32 -> Nil)
- #on_level_value_changed(&block : LevelValue | Nil, LevelValue -> Nil)
- #on_measured_value_changed(&block : Float32 | Nil, Float32 -> Nil)
- #on_peak_measured_value_changed(&block : Float32 | Nil, Float32 -> Nil)
-
#peak_measured_value : Float32 | Nil
PeakMeasurement feature attributes
-
#peak_measured_value=(peak_measured_value : Float32 | Nil)
PeakMeasurement feature attributes
- #peak_measured_value_window : UInt32 | Nil
- #peak_measured_value_window=(peak_measured_value_window : UInt32 | Nil)
-
#peak_measurement_enabled? : Bool
Check if PeakMeasurement feature is enabled
-
#read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : Bytes | InteractionModel::Status
Read an attribute value The fabric_index parameter is optional and used for fabric-scoped attributes like CurrentFabricIndex in OperationalCredentialsCluster
- #uncertainty : Float32 | Nil
- #uncertainty=(uncertainty : Float32 | Nil)
-
#update_average_measured_value(value : Float32)
Update the average measured value
-
#update_level_value(value : LevelValue)
Update the level indication value
-
#update_measured_value(value : Float32)
Update the measured CO2 concentration value
-
#update_peak_measured_value(value : Float32)
Update the peak measured value
Instance methods inherited from class Matter::Cluster::Base
apply_scene_extension_field_set(field_set : ScenesManagementCluster::ExtensionFieldSet) : Bool
apply_scene_extension_field_set,
attributes : Array(AttributeMetadata)
attributes,
cluster_id : DataType::ClusterId
cluster_id,
cluster_id=(cluster_id : DataType::ClusterId)
cluster_id=,
commands : Array(CommandMetadata)
commands,
data_version : UInt32
data_version,
data_version=(data_version : UInt32)
data_version=,
endpoint_id : DataType::EndpointNumber
endpoint_id,
endpoint_id=(endpoint_id : DataType::EndpointNumber)
endpoint_id=,
events : Array(EventMetadata)
events,
get_attribute_metadata(attribute_id : UInt32) : AttributeMetadata | Nil
get_attribute_metadata,
get_command_metadata(command_id : UInt32) : CommandMetadata | Nil
get_command_metadata,
invoke_command(command_id : UInt32, fields : Bytes = Bytes.new(0), session_id : UInt64 | Nil = nil, is_case_session : Bool = false, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | CommandResponse
invoke_command,
name : String
name,
on_attribute_changed : Proc(UInt16, UInt32, UInt32, Nil) | Nil
on_attribute_changed,
on_attribute_changed=(on_attribute_changed : Proc(UInt16, UInt32, UInt32, Nil) | Nil)
on_attribute_changed=,
persistence_key : String
persistence_key,
read_attribute(attribute_id : UInt32, fabric_index : UInt8 | Nil = nil) : InteractionModel::Status | Bytes
read_attribute,
request_fabric_index : UInt8 | Nil
request_fabric_index,
request_fabric_index=(request_fabric_index : UInt8 | Nil)
request_fabric_index=,
request_is_case_session=(request_is_case_session : Bool)
request_is_case_session=,
request_is_case_session? : Bool
request_is_case_session?,
request_peer_node_id : UInt64 | Nil
request_peer_node_id,
request_peer_node_id=(request_peer_node_id : UInt64 | Nil)
request_peer_node_id=,
request_session_id : UInt64 | Nil
request_session_id,
request_session_id=(request_session_id : UInt64 | Nil)
request_session_id=,
restore_state(json : String) : Nil
restore_state,
save_state : String | Nil
save_state,
store_scene_extension_field_set : ScenesManagementCluster::ExtensionFieldSet | Nil
store_scene_extension_field_set,
write_attribute(attribute_id : UInt32, value : Bytes) : InteractionModel::Status
write_attribute
Constructor methods inherited from class Matter::Cluster::Base
new(endpoint_id : DataType::EndpointNumber, cluster_id : DataType::ClusterId)
new
Constructor Detail
Class Method Detail
Carbon Dioxide Concentration Measurement Cluster (0x040D)
Provides attributes for reporting Carbon Dioxide (CO2) concentration measurements and level indications in air, water, or soil. This cluster is a derived cluster from the base Concentration Measurement cluster specification.
Supports two main measurement modes:
- NumericMeasurement: Provides actual measured values in configurable units
- LevelIndication: Provides coarse level indication (Unknown, Low, Medium, High, Critical)
Specification: Matter 1.4 § 2.10 (Concentration Measurement)
Instance Method Detail
Get all attribute metadata
AverageMeasurement feature attributes
Get all command metadata
Read an attribute value The fabric_index parameter is optional and used for fabric-scoped attributes like CurrentFabricIndex in OperationalCredentialsCluster