Thermostat¶
Attributes¶
- class st.matter.generated.zap_clusters.Thermostat.server.attributes.LocalTemperature¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“LocalTemperature” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the LocalTemperature(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: LocalTemperature => 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 LocalTemperature 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.Thermostat.server.attributes.OutdoorTemperature¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“OutdoorTemperature” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the OutdoorTemperature(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: OutdoorTemperature => 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 OutdoorTemperature 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.Thermostat.server.attributes.Occupancy¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“Occupancy” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap¶
the data type of this attribute
- new_value(...)¶
Create a OccupancyBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the Occupancy(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OccupancyBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap
- 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: Occupancy => 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 Occupancy 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.Thermostat.server.attributes.AbsMinHeatSetpointLimit¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“AbsMinHeatSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the AbsMinHeatSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: AbsMinHeatSetpointLimit => 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 AbsMinHeatSetpointLimit 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.Thermostat.server.attributes.AbsMaxHeatSetpointLimit¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“AbsMaxHeatSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the AbsMaxHeatSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: AbsMaxHeatSetpointLimit => 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 AbsMaxHeatSetpointLimit 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.Thermostat.server.attributes.AbsMinCoolSetpointLimit¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“AbsMinCoolSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the AbsMinCoolSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: AbsMinCoolSetpointLimit => 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 AbsMinCoolSetpointLimit 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.Thermostat.server.attributes.AbsMaxCoolSetpointLimit¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“AbsMaxCoolSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the AbsMaxCoolSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: AbsMaxCoolSetpointLimit => 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 AbsMaxCoolSetpointLimit 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.Thermostat.server.attributes.PICoolingDemand¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“PICoolingDemand” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the PICoolingDemand(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: PICoolingDemand => 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 PICoolingDemand 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.Thermostat.server.attributes.PIHeatingDemand¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“PIHeatingDemand” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the PIHeatingDemand(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: PIHeatingDemand => 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 PIHeatingDemand 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.Thermostat.server.attributes.HVACSystemTypeConfiguration¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“HVACSystemTypeConfiguration” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.HVACSystemTypeBitmap¶
the data type of this attribute
- new_value(...)¶
Create a HVACSystemTypeBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the HVACSystemTypeConfiguration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a HVACSystemTypeBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.HVACSystemTypeBitmap
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.HVACSystemTypeBitmap) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: HVACSystemTypeConfiguration => 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 HVACSystemTypeConfiguration 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.Thermostat.server.attributes.LocalTemperatureCalibration¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“LocalTemperatureCalibration” the name of this attribute
- data_type: st.matter.data_types.Int8¶
the data type of this attribute
- new_value(...)¶
Create a Int8 object of this attribute with any additional features provided for the attribute
This is also usable with the LocalTemperatureCalibration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int8- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: LocalTemperatureCalibration => 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 LocalTemperatureCalibration 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.Thermostat.server.attributes.OccupiedCoolingSetpoint¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“OccupiedCoolingSetpoint” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the OccupiedCoolingSetpoint(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: OccupiedCoolingSetpoint => 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 OccupiedCoolingSetpoint 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.Thermostat.server.attributes.OccupiedHeatingSetpoint¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“OccupiedHeatingSetpoint” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the OccupiedHeatingSetpoint(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: OccupiedHeatingSetpoint => 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 OccupiedHeatingSetpoint 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.Thermostat.server.attributes.UnoccupiedCoolingSetpoint¶
- ID: number¶
0x0013 the ID of this attribute
- NAME: str¶
“UnoccupiedCoolingSetpoint” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the UnoccupiedCoolingSetpoint(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: UnoccupiedCoolingSetpoint => 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 UnoccupiedCoolingSetpoint 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.Thermostat.server.attributes.UnoccupiedHeatingSetpoint¶
- ID: number¶
0x0014 the ID of this attribute
- NAME: str¶
“UnoccupiedHeatingSetpoint” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the UnoccupiedHeatingSetpoint(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: UnoccupiedHeatingSetpoint => 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 UnoccupiedHeatingSetpoint 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.Thermostat.server.attributes.MinHeatSetpointLimit¶
- ID: number¶
0x0015 the ID of this attribute
- NAME: str¶
“MinHeatSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinHeatSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MinHeatSetpointLimit => 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 MinHeatSetpointLimit 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.Thermostat.server.attributes.MaxHeatSetpointLimit¶
- ID: number¶
0x0016 the ID of this attribute
- NAME: str¶
“MaxHeatSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxHeatSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxHeatSetpointLimit => 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 MaxHeatSetpointLimit 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.Thermostat.server.attributes.MinCoolSetpointLimit¶
- ID: number¶
0x0017 the ID of this attribute
- NAME: str¶
“MinCoolSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinCoolSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MinCoolSetpointLimit => 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 MinCoolSetpointLimit 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.Thermostat.server.attributes.MaxCoolSetpointLimit¶
- ID: number¶
0x0018 the ID of this attribute
- NAME: str¶
“MaxCoolSetpointLimit” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxCoolSetpointLimit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MaxCoolSetpointLimit => 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 MaxCoolSetpointLimit 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.Thermostat.server.attributes.MinSetpointDeadBand¶
- ID: number¶
0x0019 the ID of this attribute
- NAME: str¶
“MinSetpointDeadBand” the name of this attribute
- data_type: st.matter.data_types.Int8¶
the data type of this attribute
- new_value(...)¶
Create a Int8 object of this attribute with any additional features provided for the attribute
This is also usable with the MinSetpointDeadBand(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int8- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Int8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: MinSetpointDeadBand => 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 MinSetpointDeadBand 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.Thermostat.server.attributes.RemoteSensing¶
- ID: number¶
0x001A the ID of this attribute
- NAME: str¶
“RemoteSensing” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.RemoteSensingBitmap¶
the data type of this attribute
- new_value(...)¶
Create a RemoteSensingBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the RemoteSensing(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a RemoteSensingBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.RemoteSensingBitmap
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.RemoteSensingBitmap) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: RemoteSensing => 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 RemoteSensing 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.Thermostat.server.attributes.ControlSequenceOfOperation¶
- ID: number¶
0x001B the ID of this attribute
- NAME: str¶
“ControlSequenceOfOperation” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ControlSequenceOfOperationEnum¶
the data type of this attribute
- new_value(...)¶
Create a ControlSequenceOfOperationEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ControlSequenceOfOperation(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ControlSequenceOfOperationEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ControlSequenceOfOperationEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ControlSequenceOfOperationEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ControlSequenceOfOperation => 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 ControlSequenceOfOperation 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.Thermostat.server.attributes.SystemMode¶
- ID: number¶
0x001C the ID of this attribute
- NAME: str¶
“SystemMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a SystemModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the SystemMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SystemModeEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: SystemMode => 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 SystemMode 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.Thermostat.server.attributes.ThermostatRunningMode¶
- ID: number¶
0x001E the ID of this attribute
- NAME: str¶
“ThermostatRunningMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ThermostatRunningModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ThermostatRunningModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ThermostatRunningMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ThermostatRunningModeEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ThermostatRunningModeEnum
- 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: ThermostatRunningMode => 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 ThermostatRunningMode 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.Thermostat.server.attributes.StartOfWeek¶
- ID: number¶
0x0020 the ID of this attribute
- NAME: str¶
“StartOfWeek” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.StartOfWeekEnum¶
the data type of this attribute
- new_value(...)¶
Create a StartOfWeekEnum object of this attribute with any additional features provided for the attribute
This is also usable with the StartOfWeek(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a StartOfWeekEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.StartOfWeekEnum
- 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: StartOfWeek => 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 StartOfWeek 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.Thermostat.server.attributes.NumberOfWeeklyTransitions¶
- ID: number¶
0x0021 the ID of this attribute
- NAME: str¶
“NumberOfWeeklyTransitions” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfWeeklyTransitions(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfWeeklyTransitions => 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 NumberOfWeeklyTransitions 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.Thermostat.server.attributes.NumberOfDailyTransitions¶
- ID: number¶
0x0022 the ID of this attribute
- NAME: str¶
“NumberOfDailyTransitions” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfDailyTransitions(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfDailyTransitions => 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 NumberOfDailyTransitions 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.Thermostat.server.attributes.TemperatureSetpointHold¶
- ID: number¶
0x0023 the ID of this attribute
- NAME: str¶
“TemperatureSetpointHold” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldEnum¶
the data type of this attribute
- new_value(...)¶
Create a TemperatureSetpointHoldEnum object of this attribute with any additional features provided for the attribute
This is also usable with the TemperatureSetpointHold(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a TemperatureSetpointHoldEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: TemperatureSetpointHold => 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 TemperatureSetpointHold 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.Thermostat.server.attributes.TemperatureSetpointHoldDuration¶
- ID: number¶
0x0024 the ID of this attribute
- NAME: str¶
“TemperatureSetpointHoldDuration” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the TemperatureSetpointHoldDuration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: TemperatureSetpointHoldDuration => 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 TemperatureSetpointHoldDuration 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.Thermostat.server.attributes.ThermostatProgrammingOperationMode¶
- ID: number¶
0x0025 the ID of this attribute
- NAME: str¶
“ThermostatProgrammingOperationMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ProgrammingOperationModeBitmap¶
the data type of this attribute
- new_value(...)¶
Create a ProgrammingOperationModeBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ThermostatProgrammingOperationMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ProgrammingOperationModeBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ProgrammingOperationModeBitmap
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ProgrammingOperationModeBitmap) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ThermostatProgrammingOperationMode => 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 ThermostatProgrammingOperationMode 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.Thermostat.server.attributes.ThermostatRunningState¶
- ID: number¶
0x0029 the ID of this attribute
- NAME: str¶
“ThermostatRunningState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.RelayStateBitmap¶
the data type of this attribute
- new_value(...)¶
Create a RelayStateBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ThermostatRunningState(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a RelayStateBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.RelayStateBitmap
- 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: ThermostatRunningState => 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 ThermostatRunningState 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.Thermostat.server.attributes.SetpointChangeSource¶
- ID: number¶
0x0030 the ID of this attribute
- NAME: str¶
“SetpointChangeSource” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.SetpointChangeSourceEnum¶
the data type of this attribute
- new_value(...)¶
Create a SetpointChangeSourceEnum object of this attribute with any additional features provided for the attribute
This is also usable with the SetpointChangeSource(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SetpointChangeSourceEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.SetpointChangeSourceEnum
- 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: SetpointChangeSource => 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 SetpointChangeSource 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.Thermostat.server.attributes.SetpointChangeAmount¶
- ID: number¶
0x0031 the ID of this attribute
- NAME: str¶
“SetpointChangeAmount” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the SetpointChangeAmount(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: SetpointChangeAmount => 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 SetpointChangeAmount 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.Thermostat.server.attributes.SetpointChangeSourceTimestamp¶
- ID: number¶
0x0032 the ID of this attribute
- NAME: str¶
“SetpointChangeSourceTimestamp” 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 SetpointChangeSourceTimestamp(…) 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: SetpointChangeSourceTimestamp => 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 SetpointChangeSourceTimestamp 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.Thermostat.server.attributes.OccupiedSetback¶
- ID: number¶
0x0034 the ID of this attribute
- NAME: str¶
“OccupiedSetback” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the OccupiedSetback(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: OccupiedSetback => 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 OccupiedSetback 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.Thermostat.server.attributes.OccupiedSetbackMin¶
- ID: number¶
0x0035 the ID of this attribute
- NAME: str¶
“OccupiedSetbackMin” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the OccupiedSetbackMin(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: OccupiedSetbackMin => 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 OccupiedSetbackMin 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.Thermostat.server.attributes.OccupiedSetbackMax¶
- ID: number¶
0x0036 the ID of this attribute
- NAME: str¶
“OccupiedSetbackMax” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the OccupiedSetbackMax(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: OccupiedSetbackMax => 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 OccupiedSetbackMax 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.Thermostat.server.attributes.UnoccupiedSetback¶
- ID: number¶
0x0037 the ID of this attribute
- NAME: str¶
“UnoccupiedSetback” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the UnoccupiedSetback(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: UnoccupiedSetback => 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 UnoccupiedSetback 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.Thermostat.server.attributes.UnoccupiedSetbackMin¶
- ID: number¶
0x0038 the ID of this attribute
- NAME: str¶
“UnoccupiedSetbackMin” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the UnoccupiedSetbackMin(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: UnoccupiedSetbackMin => 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 UnoccupiedSetbackMin 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.Thermostat.server.attributes.UnoccupiedSetbackMax¶
- ID: number¶
0x0039 the ID of this attribute
- NAME: str¶
“UnoccupiedSetbackMax” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the UnoccupiedSetbackMax(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: UnoccupiedSetbackMax => 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 UnoccupiedSetbackMax 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.Thermostat.server.attributes.EmergencyHeatDelta¶
- ID: number¶
0x003A the ID of this attribute
- NAME: str¶
“EmergencyHeatDelta” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the EmergencyHeatDelta(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: EmergencyHeatDelta => 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 EmergencyHeatDelta 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.Thermostat.server.attributes.ACType¶
- ID: number¶
0x0040 the ID of this attribute
- NAME: str¶
“ACType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACTypeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ACTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ACType(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACTypeEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACTypeEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACTypeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACType => 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 ACType 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.Thermostat.server.attributes.ACCapacity¶
- ID: number¶
0x0041 the ID of this attribute
- NAME: str¶
“ACCapacity” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the ACCapacity(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACCapacity => 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 ACCapacity 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.Thermostat.server.attributes.ACRefrigerantType¶
- ID: number¶
0x0042 the ID of this attribute
- NAME: str¶
“ACRefrigerantType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACRefrigerantTypeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ACRefrigerantTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ACRefrigerantType(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACRefrigerantTypeEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACRefrigerantTypeEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACRefrigerantTypeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACRefrigerantType => 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 ACRefrigerantType 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.Thermostat.server.attributes.ACCompressorType¶
- ID: number¶
0x0043 the ID of this attribute
- NAME: str¶
“ACCompressorType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACCompressorTypeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ACCompressorTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ACCompressorType(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACCompressorTypeEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACCompressorTypeEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACCompressorTypeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACCompressorType => 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 ACCompressorType 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.Thermostat.server.attributes.ACErrorCode¶
- ID: number¶
0x0044 the ID of this attribute
- NAME: str¶
“ACErrorCode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACErrorCodeBitmap¶
the data type of this attribute
- new_value(...)¶
Create a ACErrorCodeBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ACErrorCode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACErrorCodeBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACErrorCodeBitmap
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACErrorCodeBitmap) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACErrorCode => 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 ACErrorCode 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.Thermostat.server.attributes.ACLouverPosition¶
- ID: number¶
0x0045 the ID of this attribute
- NAME: str¶
“ACLouverPosition” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACLouverPositionEnum¶
the data type of this attribute
- new_value(...)¶
Create a ACLouverPositionEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ACLouverPosition(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACLouverPositionEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACLouverPositionEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACLouverPositionEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACLouverPosition => 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 ACLouverPosition 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.Thermostat.server.attributes.ACCoilTemperature¶
- ID: number¶
0x0046 the ID of this attribute
- NAME: str¶
“ACCoilTemperature” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the ACCoilTemperature(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: ACCoilTemperature => 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 ACCoilTemperature 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.Thermostat.server.attributes.ACCapacityformat¶
- ID: number¶
0x0047 the ID of this attribute
- NAME: str¶
“ACCapacityformat” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ACCapacityFormatEnum¶
the data type of this attribute
- new_value(...)¶
Create a ACCapacityFormatEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ACCapacityformat(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ACCapacityFormatEnum- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ACCapacityFormatEnum
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.generated.zap_clusters.Thermostat.types.ACCapacityFormatEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ACCapacityformat => 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 ACCapacityformat 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.Thermostat.server.attributes.PresetTypes¶
- ID: number¶
0x0048 the ID of this attribute
- NAME: str¶
“PresetTypes” 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 PresetTypes(…) 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: PresetTypes => 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 PresetTypes 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.Thermostat.server.attributes.ScheduleTypes¶
- ID: number¶
0x0049 the ID of this attribute
- NAME: str¶
“ScheduleTypes” 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 ScheduleTypes(…) 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: ScheduleTypes => 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 ScheduleTypes 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.Thermostat.server.attributes.NumberOfPresets¶
- ID: number¶
0x004A the ID of this attribute
- NAME: str¶
“NumberOfPresets” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfPresets(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfPresets => 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 NumberOfPresets 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.Thermostat.server.attributes.NumberOfSchedules¶
- ID: number¶
0x004B the ID of this attribute
- NAME: str¶
“NumberOfSchedules” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfSchedules(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfSchedules => 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 NumberOfSchedules 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.Thermostat.server.attributes.NumberOfScheduleTransitions¶
- ID: number¶
0x004C the ID of this attribute
- NAME: str¶
“NumberOfScheduleTransitions” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfScheduleTransitions(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfScheduleTransitions => 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 NumberOfScheduleTransitions 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.Thermostat.server.attributes.NumberOfScheduleTransitionPerDay¶
- ID: number¶
0x004D the ID of this attribute
- NAME: str¶
“NumberOfScheduleTransitionPerDay” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfScheduleTransitionPerDay(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: NumberOfScheduleTransitionPerDay => 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 NumberOfScheduleTransitionPerDay 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.Thermostat.server.attributes.ActivePresetHandle¶
- ID: number¶
0x004E the ID of this attribute
- NAME: str¶
“ActivePresetHandle” the name of this attribute
- data_type: st.matter.data_types.OctetString1¶
the data type of this attribute
- new_value(...)¶
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the ActivePresetHandle(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OctetString1- 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: ActivePresetHandle => 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 ActivePresetHandle 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.Thermostat.server.attributes.ActiveScheduleHandle¶
- ID: number¶
0x004F the ID of this attribute
- NAME: str¶
“ActiveScheduleHandle” the name of this attribute
- data_type: st.matter.data_types.OctetString1¶
the data type of this attribute
- new_value(...)¶
Create a OctetString1 object of this attribute with any additional features provided for the attribute
This is also usable with the ActiveScheduleHandle(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OctetString1- 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: ActiveScheduleHandle => 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 ActiveScheduleHandle 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.Thermostat.server.attributes.Presets¶
- ID: number¶
0x0050 the ID of this attribute
- NAME: str¶
“Presets” 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 Presets(…) 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Array) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: Presets => 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 Presets 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.Thermostat.server.attributes.Schedules¶
- ID: number¶
0x0051 the ID of this attribute
- NAME: str¶
“Schedules” 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 Schedules(…) 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Array) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: Schedules => 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 Schedules 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.Thermostat.server.attributes.SetpointHoldExpiryTimestamp¶
- ID: number¶
0x0052 the ID of this attribute
- NAME: str¶
“SetpointHoldExpiryTimestamp” 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 SetpointHoldExpiryTimestamp(…) 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: SetpointHoldExpiryTimestamp => 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 SetpointHoldExpiryTimestamp 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.Thermostat.server.attributes.MaxThermostatSuggestions¶
- ID: number¶
0x0053 the ID of this attribute
- NAME: str¶
“MaxThermostatSuggestions” the name of this attribute
- data_type: st.matter.data_types.Uint8¶
the data type of this attribute
- new_value(...)¶
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxThermostatSuggestions(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- 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: MaxThermostatSuggestions => 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 MaxThermostatSuggestions 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.Thermostat.server.attributes.ThermostatSuggestions¶
- ID: number¶
0x0054 the ID of this attribute
- NAME: str¶
“ThermostatSuggestions” 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 ThermostatSuggestions(…) 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: ThermostatSuggestions => 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 ThermostatSuggestions 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.Thermostat.server.attributes.CurrentThermostatSuggestion¶
- ID: number¶
0x0055 the ID of this attribute
- NAME: str¶
“CurrentThermostatSuggestion” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionStruct¶
the data type of this attribute
- new_value(...)¶
Create a ThermostatSuggestionStruct object of this attribute with any additional features provided for the attribute
This is also usable with the CurrentThermostatSuggestion(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ThermostatSuggestionStruct- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionStruct
- 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: CurrentThermostatSuggestion => 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 CurrentThermostatSuggestion 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.Thermostat.server.attributes.ThermostatSuggestionNotFollowingReason¶
- ID: number¶
0x0056 the ID of this attribute
- NAME: str¶
“ThermostatSuggestionNotFollowingReason” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionNotFollowingReasonBitmap¶
the data type of this attribute
- new_value(...)¶
Create a ThermostatSuggestionNotFollowingReasonBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ThermostatSuggestionNotFollowingReason(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ThermostatSuggestionNotFollowingReasonBitmap- Return type:
st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionNotFollowingReasonBitmap
- 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: ThermostatSuggestionNotFollowingReason => 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 ThermostatSuggestionNotFollowingReason 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.Thermostat.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.Thermostat.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)
Client Commands¶
- class st.matter.generated.zap_clusters.Thermostat.client.commands.GetWeeklyScheduleResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“GetWeeklyScheduleResponse” the name of this command
- number_of_transitions_for_sequence: st.matter.data_types.Uint8¶
- day_of_week_for_sequence: st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap¶
- mode_for_sequence: st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap¶
- transitions: st.matter.data_types.Array¶
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- build_test_command_response(device, endpoint_id, number_of_transitions_for_sequence, day_of_week_for_sequence, mode_for_sequence, transitions)¶
Builds an GetWeeklyScheduleResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)number_of_transitions_for_sequence (
st.matter.data_types.Uint8)day_of_week_for_sequence (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap)mode_for_sequence (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap)transitions (
st.matter.data_types.Array)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the GetWeeklyScheduleResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.client.commands.AddThermostatSuggestionResponse: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“AddThermostatSuggestionResponse” the name of this command
- uniqueid: st.matter.data_types.Uint8¶
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- build_test_command_response(device, endpoint_id, uniqueid)¶
Builds an AddThermostatSuggestionResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)uniqueid (
st.matter.data_types.Uint8)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the AddThermostatSuggestionResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.client.commands.AtomicResponse: st.matter.data_types.Structure¶
- ID: number¶
0x00FD the ID of this command
- NAME: str¶
“AtomicResponse” the name of this command
- status_code: st.matter.data_types.Uint8¶
- attribute_status: st.matter.data_types.Array¶
- timeout: st.matter.data_types.Uint16¶
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- build_test_command_response(device, endpoint_id, status_code, attribute_status, timeout)¶
Builds an AtomicResponse test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status_code (
st.matter.data_types.Uint8)attribute_status (
st.matter.data_types.Array)timeout (
st.matter.data_types.Uint16)
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init()¶
Initialize the AtomicResponse command
- Return type:
nil
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Server Commands¶
- class st.matter.generated.zap_clusters.Thermostat.server.commands.SetpointRaiseLower: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“SetpointRaiseLower” the name of this command
- mode: st.matter.generated.zap_clusters.Thermostat.types.SetpointRaiseLowerModeEnum¶
- amount: st.matter.data_types.Int8¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetpointRaiseLower test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device, mode, amount)¶
Initialize the SetpointRaiseLower command
- Parameters:
device (
st.matter.Device) – the device to build this message tomode (
st.matter.generated.zap_clusters.Thermostat.types.SetpointRaiseLowerModeEnum)amount (
st.matter.data_types.Int8)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.SetWeeklySchedule: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“SetWeeklySchedule” the name of this command
- number_of_transitions_for_sequence: st.matter.data_types.Uint8¶
- day_of_week_for_sequence: st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap¶
- mode_for_sequence: st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap¶
- transitions: st.matter.data_types.Array¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetWeeklySchedule test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device, number_of_transitions_for_sequence, day_of_week_for_sequence, mode_for_sequence, transitions)¶
Initialize the SetWeeklySchedule command
- Parameters:
device (
st.matter.Device) – the device to build this message tonumber_of_transitions_for_sequence (
st.matter.data_types.Uint8)day_of_week_for_sequence (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap)mode_for_sequence (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap)transitions (
st.matter.data_types.Array)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.GetWeeklySchedule: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“GetWeeklySchedule” the name of this command
- days_to_return: st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap¶
- mode_to_return: st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap¶
- init(device, days_to_return, mode_to_return)¶
Refer to GetWeeklyScheduleResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the GetWeeklySchedule command
- Parameters:
device (
st.matter.Device) – the device to build this message todays_to_return (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap)mode_to_return (
st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.ClearWeeklySchedule: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this command
- NAME: str¶
“ClearWeeklySchedule” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an ClearWeeklySchedule test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device)¶
Initialize the ClearWeeklySchedule command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.SetActiveScheduleRequest: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this command
- NAME: str¶
“SetActiveScheduleRequest” the name of this command
- schedule_handle: st.matter.data_types.OctetString1¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetActiveScheduleRequest test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device, schedule_handle)¶
Initialize the SetActiveScheduleRequest command
- Parameters:
device (
st.matter.Device) – the device to build this message toschedule_handle (
st.matter.data_types.OctetString1)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.SetActivePresetRequest: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this command
- NAME: str¶
“SetActivePresetRequest” the name of this command
- preset_handle: st.matter.data_types.OctetString1¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetActivePresetRequest test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device, preset_handle)¶
Initialize the SetActivePresetRequest command
- Parameters:
device (
st.matter.Device) – the device to build this message topreset_handle (
st.matter.data_types.OctetString1)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.AddThermostatSuggestion: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this command
- NAME: str¶
“AddThermostatSuggestion” the name of this command
- preset_handle: st.matter.data_types.OctetString1¶
- effective_time: st.matter.data_types.Uint32¶
- expiration_in_minutes: st.matter.data_types.Uint16¶
- init(device, preset_handle, effective_time, expiration_in_minutes)¶
Refer to AddThermostatSuggestionResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the AddThermostatSuggestion command
- Parameters:
device (
st.matter.Device) – the device to build this message topreset_handle (
st.matter.data_types.OctetString1)effective_time (
st.matter.data_types.Uint32)expiration_in_minutes (
st.matter.data_types.Uint16)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.RemoveThermostatSuggestion: st.matter.data_types.Structure¶
- ID: number¶
0x0008 the ID of this command
- NAME: str¶
“RemoveThermostatSuggestion” the name of this command
- uniqueid: st.matter.data_types.Uint8¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an RemoveThermostatSuggestion test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil)status (
str) – Interaction status associated with the path
- Returns:
of type COMMAND_RESPONSE
- Return type:
st.matter.st.matter.interaction_model.InteractionResponse
- init(device, uniqueid)¶
Initialize the RemoveThermostatSuggestion command
- Parameters:
device (
st.matter.Device) – the device to build this message touniqueid (
st.matter.data_types.Uint8)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.Thermostat.server.commands.AtomicRequest: st.matter.data_types.Structure¶
- ID: number¶
0x00FE the ID of this command
- NAME: str¶
“AtomicRequest” the name of this command
- request_type: st.matter.generated.zap_clusters.Global.types.AtomicRequestTypeEnum¶
- attribute_requests: st.matter.data_types.Array¶
- timeout: st.matter.data_types.Uint16¶
- init(device, request_type, attribute_requests, timeout)¶
Refer to AtomicResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the AtomicRequest command
- Parameters:
device (
st.matter.Device) – the device to build this message torequest_type (
st.matter.generated.zap_clusters.Global.types.AtomicRequestTypeEnum)attribute_requests (
st.matter.data_types.Array)timeout (
st.matter.data_types.Uint16)
- Returns:
of type INVOKE
- Return type:
- augment_type(base_type_obj)¶
Add field names to each command field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Events¶
- class st.matter.generated.zap_clusters.Thermostat.server.events.SystemModeChange: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this event
- NAME: str¶
“SystemModeChange” the name of this event
- previous_system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- current_system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an SystemModeChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.LocalTemperatureChange: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this event
- NAME: str¶
“LocalTemperatureChange” the name of this event
- current_local_temperature: st.matter.data_types.Int16¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an LocalTemperatureChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.OccupancyChange: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this event
- NAME: str¶
“OccupancyChange” the name of this event
- previous_occupancy: st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap¶
- current_occupancy: st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an OccupancyChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.SetpointChange: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this event
- NAME: str¶
“SetpointChange” the name of this event
- system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- occupancy: st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap¶
- previous_setpoint: st.matter.data_types.Int16¶
- current_setpoint: st.matter.data_types.Int16¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an SetpointChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.RunningStateChange: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this event
- NAME: str¶
“RunningStateChange” the name of this event
- previous_running_state: st.matter.generated.zap_clusters.Thermostat.types.RelayStateBitmap¶
- current_running_state: st.matter.generated.zap_clusters.Thermostat.types.RelayStateBitmap¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an RunningStateChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.RunningModeChange: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this event
- NAME: str¶
“RunningModeChange” the name of this event
- previous_running_mode: st.matter.generated.zap_clusters.Thermostat.types.ThermostatRunningModeEnum¶
- current_running_mode: st.matter.generated.zap_clusters.Thermostat.types.ThermostatRunningModeEnum¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an RunningModeChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.ActiveScheduleChange: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this event
- NAME: str¶
“ActiveScheduleChange” the name of this event
- previous_schedule_handle: st.matter.data_types.OctetString1¶
- current_schedule_handle: st.matter.data_types.OctetString1¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an ActiveScheduleChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.server.events.ActivePresetChange: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this event
- NAME: str¶
“ActivePresetChange” the name of this event
- previous_preset_handle: st.matter.data_types.OctetString1¶
- current_preset_handle: st.matter.data_types.OctetString1¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an ActivePresetChange test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
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.Thermostat.types.ACErrorCodeBitmap¶
- COMPRESSOR_FAIL: number¶
1
- ROOM_SENSOR_FAIL: number¶
2
- OUTDOOR_SENSOR_FAIL: number¶
4
- COIL_SENSOR_FAIL: number¶
8
- FAN_FAIL: number¶
16
- is_compressor_fail_set()¶
- Returns:
True if the value of COMPRESSOR_FAIL is non-zero
- Return type:
boolean
- set_compressor_fail()¶
Set the value of the bit in the COMPRESSOR_FAIL field to 1
- unset_compressor_fail()¶
Set the value of the bits in the COMPRESSOR_FAIL field to 0
- is_room_sensor_fail_set()¶
- Returns:
True if the value of ROOM_SENSOR_FAIL is non-zero
- Return type:
boolean
- set_room_sensor_fail()¶
Set the value of the bit in the ROOM_SENSOR_FAIL field to 1
- unset_room_sensor_fail()¶
Set the value of the bits in the ROOM_SENSOR_FAIL field to 0
- is_outdoor_sensor_fail_set()¶
- Returns:
True if the value of OUTDOOR_SENSOR_FAIL is non-zero
- Return type:
boolean
- set_outdoor_sensor_fail()¶
Set the value of the bit in the OUTDOOR_SENSOR_FAIL field to 1
- unset_outdoor_sensor_fail()¶
Set the value of the bits in the OUTDOOR_SENSOR_FAIL field to 0
- is_coil_sensor_fail_set()¶
- Returns:
True if the value of COIL_SENSOR_FAIL is non-zero
- Return type:
boolean
- set_coil_sensor_fail()¶
Set the value of the bit in the COIL_SENSOR_FAIL field to 1
- unset_coil_sensor_fail()¶
Set the value of the bits in the COIL_SENSOR_FAIL field to 0
- is_fan_fail_set()¶
- Returns:
True if the value of FAN_FAIL is non-zero
- Return type:
boolean
- set_fan_fail()¶
Set the value of the bit in the FAN_FAIL field to 1
- unset_fan_fail()¶
Set the value of the bits in the FAN_FAIL field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.Feature¶
- HEATING: number¶
1
- COOLING: number¶
2
- OCCUPANCY: number¶
4
- SCHEDULE_CONFIGURATION: number¶
8
- SETBACK: number¶
16
- AUTO_MODE: number¶
32
- LOCAL_TEMPERATURE_NOT_EXPOSED: number¶
64
- MATTER_SCHEDULE_CONFIGURATION: number¶
128
- PRESETS: number¶
256
- EVENTS: number¶
512
- THERMOSTAT_SUGGESTIONS: number¶
1024
- is_heating_set()¶
- Returns:
True if the value of HEATING is non-zero
- Return type:
boolean
- set_heating()¶
Set the value of the bit in the HEATING field to 1
- unset_heating()¶
Set the value of the bits in the HEATING field to 0
- is_cooling_set()¶
- Returns:
True if the value of COOLING is non-zero
- Return type:
boolean
- set_cooling()¶
Set the value of the bit in the COOLING field to 1
- unset_cooling()¶
Set the value of the bits in the COOLING field to 0
- is_occupancy_set()¶
- Returns:
True if the value of OCCUPANCY is non-zero
- Return type:
boolean
- set_occupancy()¶
Set the value of the bit in the OCCUPANCY field to 1
- unset_occupancy()¶
Set the value of the bits in the OCCUPANCY field to 0
- is_schedule_configuration_set()¶
- Returns:
True if the value of SCHEDULE_CONFIGURATION is non-zero
- Return type:
boolean
- set_schedule_configuration()¶
Set the value of the bit in the SCHEDULE_CONFIGURATION field to 1
- unset_schedule_configuration()¶
Set the value of the bits in the SCHEDULE_CONFIGURATION field to 0
- is_setback_set()¶
- Returns:
True if the value of SETBACK is non-zero
- Return type:
boolean
- set_setback()¶
Set the value of the bit in the SETBACK field to 1
- unset_setback()¶
Set the value of the bits in the SETBACK field to 0
- is_auto_mode_set()¶
- Returns:
True if the value of AUTO_MODE is non-zero
- Return type:
boolean
- set_auto_mode()¶
Set the value of the bit in the AUTO_MODE field to 1
- unset_auto_mode()¶
Set the value of the bits in the AUTO_MODE field to 0
- is_local_temperature_not_exposed_set()¶
- Returns:
True if the value of LOCAL_TEMPERATURE_NOT_EXPOSED is non-zero
- Return type:
boolean
- set_local_temperature_not_exposed()¶
Set the value of the bit in the LOCAL_TEMPERATURE_NOT_EXPOSED field to 1
- unset_local_temperature_not_exposed()¶
Set the value of the bits in the LOCAL_TEMPERATURE_NOT_EXPOSED field to 0
- is_matter_schedule_configuration_set()¶
- Returns:
True if the value of MATTER_SCHEDULE_CONFIGURATION is non-zero
- Return type:
boolean
- set_matter_schedule_configuration()¶
Set the value of the bit in the MATTER_SCHEDULE_CONFIGURATION field to 1
- unset_matter_schedule_configuration()¶
Set the value of the bits in the MATTER_SCHEDULE_CONFIGURATION field to 0
- is_presets_set()¶
- Returns:
True if the value of PRESETS is non-zero
- Return type:
boolean
- set_presets()¶
Set the value of the bit in the PRESETS field to 1
- unset_presets()¶
Set the value of the bits in the PRESETS field to 0
- is_events_set()¶
- Returns:
True if the value of EVENTS is non-zero
- Return type:
boolean
- set_events()¶
Set the value of the bit in the EVENTS field to 1
- unset_events()¶
Set the value of the bits in the EVENTS field to 0
- is_thermostat_suggestions_set()¶
- Returns:
True if the value of THERMOSTAT_SUGGESTIONS is non-zero
- Return type:
boolean
- set_thermostat_suggestions()¶
Set the value of the bit in the THERMOSTAT_SUGGESTIONS field to 1
- unset_thermostat_suggestions()¶
Set the value of the bits in the THERMOSTAT_SUGGESTIONS field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.HVACSystemTypeBitmap¶
- COOLING_STAGE: number¶
3
- HEATING_STAGE: number¶
12
- HEATING_IS_HEAT_PUMP: number¶
16
- HEATING_USES_FUEL: number¶
32
- is_cooling_stage_set()¶
- Returns:
True if the value of COOLING_STAGE is non-zero
- Return type:
boolean
- set_cooling_stage()¶
Set the value of the bit in the COOLING_STAGE field to 1
- unset_cooling_stage()¶
Set the value of the bits in the COOLING_STAGE field to 0
- is_heating_stage_set()¶
- Returns:
True if the value of HEATING_STAGE is non-zero
- Return type:
boolean
- set_heating_stage()¶
Set the value of the bit in the HEATING_STAGE field to 1
- unset_heating_stage()¶
Set the value of the bits in the HEATING_STAGE field to 0
- is_heating_is_heat_pump_set()¶
- Returns:
True if the value of HEATING_IS_HEAT_PUMP is non-zero
- Return type:
boolean
- set_heating_is_heat_pump()¶
Set the value of the bit in the HEATING_IS_HEAT_PUMP field to 1
- unset_heating_is_heat_pump()¶
Set the value of the bits in the HEATING_IS_HEAT_PUMP field to 0
- is_heating_uses_fuel_set()¶
- Returns:
True if the value of HEATING_USES_FUEL is non-zero
- Return type:
boolean
- set_heating_uses_fuel()¶
Set the value of the bit in the HEATING_USES_FUEL field to 1
- unset_heating_uses_fuel()¶
Set the value of the bits in the HEATING_USES_FUEL field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.OccupancyBitmap¶
- OCCUPIED: number¶
1
- is_occupied_set()¶
- Returns:
True if the value of OCCUPIED is non-zero
- Return type:
boolean
- set_occupied()¶
Set the value of the bit in the OCCUPIED field to 1
- unset_occupied()¶
Set the value of the bits in the OCCUPIED field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.PresetTypeFeaturesBitmap¶
- AUTOMATIC: number¶
1
- SUPPORTS_NAMES: number¶
2
- is_automatic_set()¶
- Returns:
True if the value of AUTOMATIC is non-zero
- Return type:
boolean
- set_automatic()¶
Set the value of the bit in the AUTOMATIC field to 1
- unset_automatic()¶
Set the value of the bits in the AUTOMATIC field to 0
- is_supports_names_set()¶
- Returns:
True if the value of SUPPORTS_NAMES is non-zero
- Return type:
boolean
- set_supports_names()¶
Set the value of the bit in the SUPPORTS_NAMES field to 1
- unset_supports_names()¶
Set the value of the bits in the SUPPORTS_NAMES field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.ProgrammingOperationModeBitmap¶
- SCHEDULE_ACTIVE: number¶
1
- AUTO_RECOVERY: number¶
2
- ECONOMY: number¶
4
- is_schedule_active_set()¶
- Returns:
True if the value of SCHEDULE_ACTIVE is non-zero
- Return type:
boolean
- set_schedule_active()¶
Set the value of the bit in the SCHEDULE_ACTIVE field to 1
- unset_schedule_active()¶
Set the value of the bits in the SCHEDULE_ACTIVE field to 0
- is_auto_recovery_set()¶
- Returns:
True if the value of AUTO_RECOVERY is non-zero
- Return type:
boolean
- set_auto_recovery()¶
Set the value of the bit in the AUTO_RECOVERY field to 1
- unset_auto_recovery()¶
Set the value of the bits in the AUTO_RECOVERY field to 0
- is_economy_set()¶
- Returns:
True if the value of ECONOMY is non-zero
- Return type:
boolean
- set_economy()¶
Set the value of the bit in the ECONOMY field to 1
- unset_economy()¶
Set the value of the bits in the ECONOMY field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.RelayStateBitmap¶
- HEAT: number¶
1
- COOL: number¶
2
- FAN: number¶
4
- HEAT_STAGE2: number¶
8
- COOL_STAGE2: number¶
16
- FAN_STAGE2: number¶
32
- FAN_STAGE3: number¶
64
- is_heat_set()¶
- Returns:
True if the value of HEAT is non-zero
- Return type:
boolean
- set_heat()¶
Set the value of the bit in the HEAT field to 1
- unset_heat()¶
Set the value of the bits in the HEAT field to 0
- is_cool_set()¶
- Returns:
True if the value of COOL is non-zero
- Return type:
boolean
- set_cool()¶
Set the value of the bit in the COOL field to 1
- unset_cool()¶
Set the value of the bits in the COOL field to 0
- is_fan_set()¶
- Returns:
True if the value of FAN is non-zero
- Return type:
boolean
- set_fan()¶
Set the value of the bit in the FAN field to 1
- unset_fan()¶
Set the value of the bits in the FAN field to 0
- is_heat_stage2_set()¶
- Returns:
True if the value of HEAT_STAGE2 is non-zero
- Return type:
boolean
- set_heat_stage2()¶
Set the value of the bit in the HEAT_STAGE2 field to 1
- unset_heat_stage2()¶
Set the value of the bits in the HEAT_STAGE2 field to 0
- is_cool_stage2_set()¶
- Returns:
True if the value of COOL_STAGE2 is non-zero
- Return type:
boolean
- set_cool_stage2()¶
Set the value of the bit in the COOL_STAGE2 field to 1
- unset_cool_stage2()¶
Set the value of the bits in the COOL_STAGE2 field to 0
- is_fan_stage2_set()¶
- Returns:
True if the value of FAN_STAGE2 is non-zero
- Return type:
boolean
- set_fan_stage2()¶
Set the value of the bit in the FAN_STAGE2 field to 1
- unset_fan_stage2()¶
Set the value of the bits in the FAN_STAGE2 field to 0
- is_fan_stage3_set()¶
- Returns:
True if the value of FAN_STAGE3 is non-zero
- Return type:
boolean
- set_fan_stage3()¶
Set the value of the bit in the FAN_STAGE3 field to 1
- unset_fan_stage3()¶
Set the value of the bits in the FAN_STAGE3 field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.RemoteSensingBitmap¶
- LOCAL_TEMPERATURE: number¶
1
- OUTDOOR_TEMPERATURE: number¶
2
- OCCUPANCY: number¶
4
- is_local_temperature_set()¶
- Returns:
True if the value of LOCAL_TEMPERATURE is non-zero
- Return type:
boolean
- set_local_temperature()¶
Set the value of the bit in the LOCAL_TEMPERATURE field to 1
- unset_local_temperature()¶
Set the value of the bits in the LOCAL_TEMPERATURE field to 0
- is_outdoor_temperature_set()¶
- Returns:
True if the value of OUTDOOR_TEMPERATURE is non-zero
- Return type:
boolean
- set_outdoor_temperature()¶
Set the value of the bit in the OUTDOOR_TEMPERATURE field to 1
- unset_outdoor_temperature()¶
Set the value of the bits in the OUTDOOR_TEMPERATURE field to 0
- is_occupancy_set()¶
- Returns:
True if the value of OCCUPANCY is non-zero
- Return type:
boolean
- set_occupancy()¶
Set the value of the bit in the OCCUPANCY field to 1
- unset_occupancy()¶
Set the value of the bits in the OCCUPANCY field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap¶
- SUNDAY: number¶
1
- MONDAY: number¶
2
- TUESDAY: number¶
4
- WEDNESDAY: number¶
8
- THURSDAY: number¶
16
- FRIDAY: number¶
32
- SATURDAY: number¶
64
- AWAY: number¶
128
- is_sunday_set()¶
- Returns:
True if the value of SUNDAY is non-zero
- Return type:
boolean
- set_sunday()¶
Set the value of the bit in the SUNDAY field to 1
- unset_sunday()¶
Set the value of the bits in the SUNDAY field to 0
- is_monday_set()¶
- Returns:
True if the value of MONDAY is non-zero
- Return type:
boolean
- set_monday()¶
Set the value of the bit in the MONDAY field to 1
- unset_monday()¶
Set the value of the bits in the MONDAY field to 0
- is_tuesday_set()¶
- Returns:
True if the value of TUESDAY is non-zero
- Return type:
boolean
- set_tuesday()¶
Set the value of the bit in the TUESDAY field to 1
- unset_tuesday()¶
Set the value of the bits in the TUESDAY field to 0
- is_wednesday_set()¶
- Returns:
True if the value of WEDNESDAY is non-zero
- Return type:
boolean
- set_wednesday()¶
Set the value of the bit in the WEDNESDAY field to 1
- unset_wednesday()¶
Set the value of the bits in the WEDNESDAY field to 0
- is_thursday_set()¶
- Returns:
True if the value of THURSDAY is non-zero
- Return type:
boolean
- set_thursday()¶
Set the value of the bit in the THURSDAY field to 1
- unset_thursday()¶
Set the value of the bits in the THURSDAY field to 0
- is_friday_set()¶
- Returns:
True if the value of FRIDAY is non-zero
- Return type:
boolean
- set_friday()¶
Set the value of the bit in the FRIDAY field to 1
- unset_friday()¶
Set the value of the bits in the FRIDAY field to 0
- is_saturday_set()¶
- Returns:
True if the value of SATURDAY is non-zero
- Return type:
boolean
- set_saturday()¶
Set the value of the bit in the SATURDAY field to 1
- unset_saturday()¶
Set the value of the bits in the SATURDAY field to 0
- is_away_set()¶
- Returns:
True if the value of AWAY is non-zero
- Return type:
boolean
- set_away()¶
Set the value of the bit in the AWAY field to 1
- unset_away()¶
Set the value of the bits in the AWAY field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleModeBitmap¶
- HEAT_SETPOINT_PRESENT: number¶
1
- COOL_SETPOINT_PRESENT: number¶
2
- is_heat_setpoint_present_set()¶
- Returns:
True if the value of HEAT_SETPOINT_PRESENT is non-zero
- Return type:
boolean
- set_heat_setpoint_present()¶
Set the value of the bit in the HEAT_SETPOINT_PRESENT field to 1
- unset_heat_setpoint_present()¶
Set the value of the bits in the HEAT_SETPOINT_PRESENT field to 0
- is_cool_setpoint_present_set()¶
- Returns:
True if the value of COOL_SETPOINT_PRESENT is non-zero
- Return type:
boolean
- set_cool_setpoint_present()¶
Set the value of the bit in the COOL_SETPOINT_PRESENT field to 1
- unset_cool_setpoint_present()¶
Set the value of the bits in the COOL_SETPOINT_PRESENT field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleTypeFeaturesBitmap¶
- SUPPORTS_PRESETS: number¶
1
- SUPPORTS_SETPOINTS: number¶
2
- SUPPORTS_NAMES: number¶
4
- SUPPORTS_OFF: number¶
8
- is_supports_presets_set()¶
- Returns:
True if the value of SUPPORTS_PRESETS is non-zero
- Return type:
boolean
- set_supports_presets()¶
Set the value of the bit in the SUPPORTS_PRESETS field to 1
- unset_supports_presets()¶
Set the value of the bits in the SUPPORTS_PRESETS field to 0
- is_supports_setpoints_set()¶
- Returns:
True if the value of SUPPORTS_SETPOINTS is non-zero
- Return type:
boolean
- set_supports_setpoints()¶
Set the value of the bit in the SUPPORTS_SETPOINTS field to 1
- unset_supports_setpoints()¶
Set the value of the bits in the SUPPORTS_SETPOINTS field to 0
- is_supports_names_set()¶
- Returns:
True if the value of SUPPORTS_NAMES is non-zero
- Return type:
boolean
- set_supports_names()¶
Set the value of the bit in the SUPPORTS_NAMES field to 1
- unset_supports_names()¶
Set the value of the bits in the SUPPORTS_NAMES field to 0
- is_supports_off_set()¶
- Returns:
True if the value of SUPPORTS_OFF is non-zero
- Return type:
boolean
- set_supports_off()¶
Set the value of the bit in the SUPPORTS_OFF field to 1
- unset_supports_off()¶
Set the value of the bits in the SUPPORTS_OFF field to 0
- class st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionNotFollowingReasonBitmap¶
- DEMAND_RESPONSE_EVENT: number¶
1
- ONGOING_HOLD: number¶
2
- SCHEDULE: number¶
4
- OCCUPANCY: number¶
8
- VACATION_MODE: number¶
16
- TIME_OF_USE_COST_SAVINGS: number¶
32
- PRE_COOLING_OR_PRE_HEATING: number¶
64
- CONFLICTING_SUGGESTIONS: number¶
128
- is_demand_response_event_set()¶
- Returns:
True if the value of DEMAND_RESPONSE_EVENT is non-zero
- Return type:
boolean
- set_demand_response_event()¶
Set the value of the bit in the DEMAND_RESPONSE_EVENT field to 1
- unset_demand_response_event()¶
Set the value of the bits in the DEMAND_RESPONSE_EVENT field to 0
- is_ongoing_hold_set()¶
- Returns:
True if the value of ONGOING_HOLD is non-zero
- Return type:
boolean
- set_ongoing_hold()¶
Set the value of the bit in the ONGOING_HOLD field to 1
- unset_ongoing_hold()¶
Set the value of the bits in the ONGOING_HOLD field to 0
- is_schedule_set()¶
- Returns:
True if the value of SCHEDULE is non-zero
- Return type:
boolean
- set_schedule()¶
Set the value of the bit in the SCHEDULE field to 1
- unset_schedule()¶
Set the value of the bits in the SCHEDULE field to 0
- is_occupancy_set()¶
- Returns:
True if the value of OCCUPANCY is non-zero
- Return type:
boolean
- set_occupancy()¶
Set the value of the bit in the OCCUPANCY field to 1
- unset_occupancy()¶
Set the value of the bits in the OCCUPANCY field to 0
- is_vacation_mode_set()¶
- Returns:
True if the value of VACATION_MODE is non-zero
- Return type:
boolean
- set_vacation_mode()¶
Set the value of the bit in the VACATION_MODE field to 1
- unset_vacation_mode()¶
Set the value of the bits in the VACATION_MODE field to 0
- is_time_of_use_cost_savings_set()¶
- Returns:
True if the value of TIME_OF_USE_COST_SAVINGS is non-zero
- Return type:
boolean
- set_time_of_use_cost_savings()¶
Set the value of the bit in the TIME_OF_USE_COST_SAVINGS field to 1
- unset_time_of_use_cost_savings()¶
Set the value of the bits in the TIME_OF_USE_COST_SAVINGS field to 0
- is_pre_cooling_or_pre_heating_set()¶
- Returns:
True if the value of PRE_COOLING_OR_PRE_HEATING is non-zero
- Return type:
boolean
- set_pre_cooling_or_pre_heating()¶
Set the value of the bit in the PRE_COOLING_OR_PRE_HEATING field to 1
- unset_pre_cooling_or_pre_heating()¶
Set the value of the bits in the PRE_COOLING_OR_PRE_HEATING field to 0
- is_conflicting_suggestions_set()¶
- Returns:
True if the value of CONFLICTING_SUGGESTIONS is non-zero
- Return type:
boolean
- set_conflicting_suggestions()¶
Set the value of the bit in the CONFLICTING_SUGGESTIONS field to 1
- unset_conflicting_suggestions()¶
Set the value of the bits in the CONFLICTING_SUGGESTIONS field to 0
Enum types¶
- class st.matter.generated.zap_clusters.Thermostat.types.ACCapacityFormatEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- BT_UH: number¶
0
- class st.matter.generated.zap_clusters.Thermostat.types.ACCompressorTypeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- UNKNOWN: number¶
0
- T1: number¶
1
- T2: number¶
2
- T3: number¶
3
- class st.matter.generated.zap_clusters.Thermostat.types.ACLouverPositionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- CLOSED: number¶
1
- OPEN: number¶
2
- QUARTER: number¶
3
- HALF: number¶
4
- THREE_QUARTERS: number¶
5
- class st.matter.generated.zap_clusters.Thermostat.types.ACRefrigerantTypeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- UNKNOWN: number¶
0
- R22: number¶
1
- R410A: number¶
2
- R407C: number¶
3
- class st.matter.generated.zap_clusters.Thermostat.types.ACTypeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- UNKNOWN: number¶
0
- COOLING_FIXED: number¶
1
- HEAT_PUMP_FIXED: number¶
2
- COOLING_INVERTER: number¶
3
- HEAT_PUMP_INVERTER: number¶
4
- class st.matter.generated.zap_clusters.Thermostat.types.ControlSequenceOfOperationEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- COOLING_ONLY: number¶
0
- COOLING_WITH_REHEAT: number¶
1
- HEATING_ONLY: number¶
2
- HEATING_WITH_REHEAT: number¶
3
- COOLING_AND_HEATING: number¶
4
- COOLING_AND_HEATING_WITH_REHEAT: number¶
5
- class st.matter.generated.zap_clusters.Thermostat.types.PresetScenarioEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- OCCUPIED: number¶
1
- UNOCCUPIED: number¶
2
- SLEEP: number¶
3
- WAKE: number¶
4
- VACATION: number¶
5
- GOING_TO_SLEEP: number¶
6
- USER_DEFINED: number¶
254
- class st.matter.generated.zap_clusters.Thermostat.types.SetpointChangeSourceEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- MANUAL: number¶
0
- SCHEDULE: number¶
1
- EXTERNAL: number¶
2
- class st.matter.generated.zap_clusters.Thermostat.types.SetpointRaiseLowerModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- HEAT: number¶
0
- COOL: number¶
1
- BOTH: number¶
2
- class st.matter.generated.zap_clusters.Thermostat.types.StartOfWeekEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- SUNDAY: number¶
0
- MONDAY: number¶
1
- TUESDAY: number¶
2
- WEDNESDAY: number¶
3
- THURSDAY: number¶
4
- FRIDAY: number¶
5
- SATURDAY: number¶
6
- class st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- OFF: number¶
0
- AUTO: number¶
1
- COOL: number¶
3
- HEAT: number¶
4
- EMERGENCY_HEAT: number¶
5
- PRECOOLING: number¶
6
- FAN_ONLY: number¶
7
- DRY: number¶
8
- SLEEP: number¶
9
- class st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- SETPOINT_HOLD_OFF: number¶
0
- SETPOINT_HOLD_ON: number¶
1
Struct types¶
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleTransitionStruct: st.matter.data_types.Structure¶
- day_of_week: st.matter.generated.zap_clusters.Thermostat.types.ScheduleDayOfWeekBitmap¶
- transition_time: st.matter.data_types.Uint16¶
- preset_handle: st.matter.data_types.OctetString1¶
- system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- cooling_setpoint: st.matter.data_types.Int16¶
- heating_setpoint: st.matter.data_types.Int16¶
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleStruct: st.matter.data_types.Structure¶
- schedule_handle: st.matter.data_types.OctetString1¶
- system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- name: st.matter.data_types.UTF8String1¶
- preset_handle: st.matter.data_types.OctetString1¶
- transitions: st.matter.data_types.Array¶
- built_in: st.matter.data_types.Boolean¶
- class st.matter.generated.zap_clusters.Thermostat.types.PresetStruct: st.matter.data_types.Structure¶
- preset_handle: st.matter.data_types.OctetString1¶
- preset_scenario: st.matter.generated.zap_clusters.Thermostat.types.PresetScenarioEnum¶
- name: st.matter.data_types.UTF8String1¶
- cooling_setpoint: st.matter.data_types.Int16¶
- heating_setpoint: st.matter.data_types.Int16¶
- built_in: st.matter.data_types.Boolean¶
- class st.matter.generated.zap_clusters.Thermostat.types.PresetTypeStruct: st.matter.data_types.Structure¶
- preset_scenario: st.matter.generated.zap_clusters.Thermostat.types.PresetScenarioEnum¶
- number_of_presets: st.matter.data_types.Uint8¶
- preset_type_features: st.matter.generated.zap_clusters.Thermostat.types.PresetTypeFeaturesBitmap¶
- class st.matter.generated.zap_clusters.Thermostat.types.ScheduleTypeStruct: st.matter.data_types.Structure¶
- system_mode: st.matter.generated.zap_clusters.Thermostat.types.SystemModeEnum¶
- number_of_schedules: st.matter.data_types.Uint8¶
- schedule_type_features: st.matter.generated.zap_clusters.Thermostat.types.ScheduleTypeFeaturesBitmap¶
- class st.matter.generated.zap_clusters.Thermostat.types.ThermostatSuggestionStruct: st.matter.data_types.Structure¶
- unique_id: st.matter.data_types.Uint8¶
- preset_handle: st.matter.data_types.OctetString1¶
- effective_time: st.matter.data_types.Uint32¶
- expiration_time: st.matter.data_types.Uint32¶
- class st.matter.generated.zap_clusters.Thermostat.types.WeeklyScheduleTransitionStruct: st.matter.data_types.Structure¶
- transition_time: st.matter.data_types.Uint16¶
- heat_setpoint: st.matter.data_types.Int16¶
- cool_setpoint: st.matter.data_types.Int16¶