Pm25ConcentrationMeasurement
Attributes
- class st.matter.clusters.Pm25ConcentrationMeasurement.MeasuredValue
- ID: number
0x0000 the ID of this attribute
- NAME: str
“MeasuredValue” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the MeasuredValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MeasuredValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MeasuredValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.MinMeasuredValue
- ID: number
0x0001 the ID of this attribute
- NAME: str
“MinMeasuredValue” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the MinMeasuredValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MinMeasuredValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MinMeasuredValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.MaxMeasuredValue
- ID: number
0x0002 the ID of this attribute
- NAME: str
“MaxMeasuredValue” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the MaxMeasuredValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MaxMeasuredValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MaxMeasuredValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.PeakMeasuredValue
- ID: number
0x0003 the ID of this attribute
- NAME: str
“PeakMeasuredValue” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the PeakMeasuredValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: PeakMeasuredValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an PeakMeasuredValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.PeakMeasuredValueWindow
- ID: number
0x0004 the ID of this attribute
- NAME: str
“PeakMeasuredValueWindow” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the PeakMeasuredValueWindow(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: PeakMeasuredValueWindow => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an PeakMeasuredValueWindow test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.AverageMeasuredValue
- ID: number
0x0005 the ID of this attribute
- NAME: str
“AverageMeasuredValue” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the AverageMeasuredValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AverageMeasuredValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AverageMeasuredValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.AverageMeasuredValueWindow
- ID: number
0x0006 the ID of this attribute
- NAME: str
“AverageMeasuredValueWindow” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the AverageMeasuredValueWindow(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AverageMeasuredValueWindow => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AverageMeasuredValueWindow test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.Uncertainty
- ID: number
0x0007 the ID of this attribute
- NAME: str
“Uncertainty” the name of this attribute
- data_type: st.matter.data_types.SinglePrecisionFloat
the data type of this attribute
- new_value(...)
Create a SinglePrecisionFloat object of this attribute with any additional features provided for the attribute
This is also usable with the Uncertainty(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a SinglePrecisionFloat- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: Uncertainty => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an Uncertainty test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.MeasurementUnit
- ID: number
0x0008 the ID of this attribute
- NAME: str
“MeasurementUnit” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.MeasurementUnitEnum
the data type of this attribute
- new_value(...)
Create a MeasurementUnitEnum object of this attribute with any additional features provided for the attribute
This is also usable with the MeasurementUnit(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a MeasurementUnitEnum- Return type
st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.MeasurementUnitEnum
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MeasurementUnit => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MeasurementUnit test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.MeasurementMedium
- ID: number
0x0009 the ID of this attribute
- NAME: str
“MeasurementMedium” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.MeasurementMediumEnum
the data type of this attribute
- new_value(...)
Create a MeasurementMediumEnum object of this attribute with any additional features provided for the attribute
This is also usable with the MeasurementMedium(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a MeasurementMediumEnum- Return type
st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.MeasurementMediumEnum
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MeasurementMedium => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MeasurementMedium test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.LevelValue
- ID: number
0x000A the ID of this attribute
- NAME: str
“LevelValue” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.LevelValueEnum
the data type of this attribute
- new_value(...)
Create a LevelValueEnum object of this attribute with any additional features provided for the attribute
This is also usable with the LevelValue(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a LevelValueEnum- Return type
st.matter.generated.zap_clusters.Pm25ConcentrationMeasurement.types.LevelValueEnum
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LevelValue => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LevelValue test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.AcceptedCommandList
- ID: number
0xFFF9 the ID of this attribute
- NAME: str
“AcceptedCommandList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array
) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AcceptedCommandList(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AcceptedCommandList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.EventList
- ID: number
0xFFFA the ID of this attribute
- NAME: str
“EventList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array
) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the EventList(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: EventList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an EventList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.Pm25ConcentrationMeasurement.AttributeList
- ID: number
0xFFFB the ID of this attribute
- NAME: str
“AttributeList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array
) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AttributeList(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AttributeList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AttributeList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
Bitmap types
- class st.matter.clusters.Pm25ConcentrationMeasurement.types.Feature
- NUMERIC_MEASUREMENT: number
1
- LEVEL_INDICATION: number
2
- MEDIUM_LEVEL: number
4
- CRITICAL_LEVEL: number
8
- PEAK_MEASUREMENT: number
16
- AVERAGE_MEASUREMENT: number
32
- is_numeric_measurement_set()
- Returns
True if the value of NUMERIC_MEASUREMENT is non-zero
- Return type
boolean
- set_numeric_measurement()
Set the value of the bit in the NUMERIC_MEASUREMENT field to 1
- unset_numeric_measurement()
Set the value of the bits in the NUMERIC_MEASUREMENT field to 0
- is_level_indication_set()
- Returns
True if the value of LEVEL_INDICATION is non-zero
- Return type
boolean
- set_level_indication()
Set the value of the bit in the LEVEL_INDICATION field to 1
- unset_level_indication()
Set the value of the bits in the LEVEL_INDICATION field to 0
- is_medium_level_set()
- Returns
True if the value of MEDIUM_LEVEL is non-zero
- Return type
boolean
- set_medium_level()
Set the value of the bit in the MEDIUM_LEVEL field to 1
- unset_medium_level()
Set the value of the bits in the MEDIUM_LEVEL field to 0
- is_critical_level_set()
- Returns
True if the value of CRITICAL_LEVEL is non-zero
- Return type
boolean
- set_critical_level()
Set the value of the bit in the CRITICAL_LEVEL field to 1
- unset_critical_level()
Set the value of the bits in the CRITICAL_LEVEL field to 0
- is_peak_measurement_set()
- Returns
True if the value of PEAK_MEASUREMENT is non-zero
- Return type
boolean
- set_peak_measurement()
Set the value of the bit in the PEAK_MEASUREMENT field to 1
- unset_peak_measurement()
Set the value of the bits in the PEAK_MEASUREMENT field to 0
- is_average_measurement_set()
- Returns
True if the value of AVERAGE_MEASUREMENT is non-zero
- Return type
boolean
- set_average_measurement()
Set the value of the bit in the AVERAGE_MEASUREMENT field to 1
- unset_average_measurement()
Set the value of the bits in the AVERAGE_MEASUREMENT field to 0
Enum types
- class st.matter.clusters.Pm25ConcentrationMeasurement.types.LevelValueEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNKNOWN: number
0
- LOW: number
1
- MEDIUM: number
2
- HIGH: number
3
- CRITICAL: number
4