AirQuality¶
Attributes¶
- class st.matter.generated.zap_clusters.AirQuality.server.attributes.AirQuality¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“AirQuality” the name of this attribute
- data_type: st.matter.generated.zap_clusters.AirQuality.types.AirQualityEnum¶
the data type of this attribute
- new_value(...)¶
Create a AirQualityEnum object of this attribute with any additional features provided for the attribute
This is also usable with the AirQuality(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a AirQualityEnum- Return type:
st.matter.generated.zap_clusters.AirQuality.types.AirQualityEnum
- 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: AirQuality => true => mandatory
Sets up a Subscribe Interaction
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
any
- build_test_report_data(device, endpoint_id, value, status)¶
Builds an AirQuality 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.generated.zap_clusters.AirQuality.server.attributes.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(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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
- 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.generated.zap_clusters.AirQuality.server.attributes.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(data_type_obj)¶
Add additional functionality to the base type object
- Parameters:
data_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
- 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.generated.zap_clusters.AirQuality.types.Feature¶
- FAIR: number¶
1
- MODERATE: number¶
2
- VERY_POOR: number¶
4
- EXTREMELY_POOR: number¶
8
- is_fair_set()¶
- Returns:
True if the value of FAIR is non-zero
- Return type:
boolean
- set_fair()¶
Set the value of the bit in the FAIR field to 1
- unset_fair()¶
Set the value of the bits in the FAIR field to 0
- is_moderate_set()¶
- Returns:
True if the value of MODERATE is non-zero
- Return type:
boolean
- set_moderate()¶
Set the value of the bit in the MODERATE field to 1
- unset_moderate()¶
Set the value of the bits in the MODERATE field to 0
- is_very_poor_set()¶
- Returns:
True if the value of VERY_POOR is non-zero
- Return type:
boolean
- set_very_poor()¶
Set the value of the bit in the VERY_POOR field to 1
- unset_very_poor()¶
Set the value of the bits in the VERY_POOR field to 0
- is_extremely_poor_set()¶
- Returns:
True if the value of EXTREMELY_POOR is non-zero
- Return type:
boolean
- set_extremely_poor()¶
Set the value of the bit in the EXTREMELY_POOR field to 1
- unset_extremely_poor()¶
Set the value of the bits in the EXTREMELY_POOR field to 0