Thermostat
Attributes
- class st.matter.clusters.Thermostat.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 => suggested
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.Occupancy
- ID: number
0x0002 the ID of this attribute
- NAME: str
“Occupancy” 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 Occupancy(…) 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: Occupancy => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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 => suggested
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.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 => suggested
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.HVACSystemTypeConfiguration
- ID: number
0x0009 the ID of this attribute
- NAME: str
“HVACSystemTypeConfiguration” 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 HVACSystemTypeConfiguration(…) 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: HVACSystemTypeConfiguration => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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 => suggested
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an 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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.PresetsSchedulesEditable
- ID: number
0x0052 the ID of this attribute
- NAME: str
“PresetsSchedulesEditable” the name of this attribute
- data_type: st.matter.data_types.Boolean
the data type of this attribute
- new_value(...)
Create a Boolean object of this attribute with any additional features provided for the attribute
This is also usable with the PresetsSchedulesEditable(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Boolean- 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: PresetsSchedulesEditable => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an PresetsSchedulesEditable test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- class st.matter.clusters.Thermostat.TemperatureSetpointHoldPolicy
- ID: number
0x0053 the ID of this attribute
- NAME: str
“TemperatureSetpointHoldPolicy” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldPolicyBitmap
the data type of this attribute
- new_value(...)
Create a TemperatureSetpointHoldPolicyBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the TemperatureSetpointHoldPolicy(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a TemperatureSetpointHoldPolicyBitmap- Return type
st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldPolicyBitmap
- 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: TemperatureSetpointHoldPolicy => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an TemperatureSetpointHoldPolicy test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- class st.matter.clusters.Thermostat.SetpointHoldExpiryTimestamp
- ID: number
0x0054 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.Thermostat.QueuedPreset
- ID: number
0x0055 the ID of this attribute
- NAME: str
“QueuedPreset” the name of this attribute
- data_type: st.matter.generated.zap_clusters.Thermostat.types.QueuedPresetStruct
the data type of this attribute
- new_value(...)
Create a QueuedPresetStruct object of this attribute with any additional features provided for the attribute
This is also usable with the QueuedPreset(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a QueuedPresetStruct- Return type
st.matter.generated.zap_clusters.Thermostat.types.QueuedPresetStruct
- 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: QueuedPreset => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an QueuedPreset test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- class st.matter.clusters.Thermostat.AcceptedCommandList
- ID: number
0xFFF9 the ID of this attribute
- NAME: str
“AcceptedCommandList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AcceptedCommandList(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device) –endpoint_id (
number or nil) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AcceptedCommandList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- class st.matter.clusters.Thermostat.EventList
- ID: number
0xFFFA the ID of this attribute
- NAME: str
“EventList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the EventList(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device) –endpoint_id (
number or nil) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: EventList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an EventList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- class st.matter.clusters.Thermostat.AttributeList
- ID: number
0xFFFB the ID of this attribute
- NAME: str
“AttributeList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Array) – the base data type object to add functionality to
- new_value(...)
Create a Array object of this attribute with any additional features provided for the attribute
This is also usable with the AttributeList(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Array- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device) –endpoint_id (
number or nil) –
- Returns
containing an Interaction Request
- Return type
- subscribe(device, endpoint_id)
Reporting policy: AttributeList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an AttributeList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –value (
any) –status (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
Client Commands
- class st.matter.clusters.Thermostat.GetWeeklyScheduleResponse
- 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
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
Server Commands
- class st.matter.clusters.Thermostat.SetpointRaiseLower
- 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(self, device, mode, amount)
Initialize the SetpointRaiseLower command
- Parameters
self (
SetpointRaiseLower) – the template class for this commanddevice (
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
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.SetWeeklySchedule
- 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(self, device, number_of_transitions_for_sequence, day_of_week_for_sequence, mode_for_sequence, transitions)
Initialize the SetWeeklySchedule command
- Parameters
self (
SetWeeklySchedule) – the template class for this commanddevice (
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
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.GetWeeklySchedule
- 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(self, 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
self (
GetWeeklySchedule) – the template class for this commanddevice (
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
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.ClearWeeklySchedule
- 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(self, device)
Initialize the ClearWeeklySchedule command
- Parameters
self (
ClearWeeklySchedule) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.SetActiveScheduleRequest
- 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(self, device, schedule_handle)
Initialize the SetActiveScheduleRequest command
- Parameters
self (
SetActiveScheduleRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message toschedule_handle (
st.matter.data_types.OctetString1) –
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.SetActivePresetRequest
- ID: number
0x0006 the ID of this command
- NAME: str
“SetActivePresetRequest” the name of this command
- preset_handle: st.matter.data_types.OctetString1
- delay_minutes: st.matter.data_types.Uint16
- 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(self, device, preset_handle, delay_minutes)
Initialize the SetActivePresetRequest command
- Parameters
self (
SetActivePresetRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message topreset_handle (
st.matter.data_types.OctetString1) –delay_minutes (
st.matter.data_types.Uint16) –
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.StartPresetsSchedulesEditRequest
- ID: number
0x0007 the ID of this command
- NAME: str
“StartPresetsSchedulesEditRequest” the name of this command
- timeout_seconds: st.matter.data_types.Uint16
- build_test_command_response(device, endpoint_id, status)
Builds an StartPresetsSchedulesEditRequest 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(self, device, timeout_seconds)
Initialize the StartPresetsSchedulesEditRequest command
- Parameters
self (
StartPresetsSchedulesEditRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message totimeout_seconds (
st.matter.data_types.Uint16) –
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.CancelPresetsSchedulesEditRequest
- ID: number
0x0008 the ID of this command
- NAME: str
“CancelPresetsSchedulesEditRequest” the name of this command
- build_test_command_response(device, endpoint_id, status)
Builds an CancelPresetsSchedulesEditRequest 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(self, device)
Initialize the CancelPresetsSchedulesEditRequest command
- Parameters
self (
CancelPresetsSchedulesEditRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.CommitPresetsSchedulesRequest
- ID: number
0x0009 the ID of this command
- NAME: str
“CommitPresetsSchedulesRequest” the name of this command
- build_test_command_response(device, endpoint_id, status)
Builds an CommitPresetsSchedulesRequest 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(self, device)
Initialize the CommitPresetsSchedulesRequest command
- Parameters
self (
CommitPresetsSchedulesRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.CancelSetActivePresetRequest
- ID: number
0x000A the ID of this command
- NAME: str
“CancelSetActivePresetRequest” the name of this command
- build_test_command_response(device, endpoint_id, status)
Builds an CancelSetActivePresetRequest 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(self, device)
Initialize the CancelSetActivePresetRequest command
- Parameters
self (
CancelSetActivePresetRequest) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.Thermostat.SetTemperatureSetpointHoldPolicy
- ID: number
0x000B the ID of this command
- NAME: str
“SetTemperatureSetpointHoldPolicy” the name of this command
- temperature_setpoint_hold_policy: st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldPolicyBitmap
- build_test_command_response(device, endpoint_id, status)
Builds an SetTemperatureSetpointHoldPolicy 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(self, device, temperature_setpoint_hold_policy)
Initialize the SetTemperatureSetpointHoldPolicy command
- Parameters
self (
SetTemperatureSetpointHoldPolicy) – the template class for this commanddevice (
st.matter.Device) – the device to build this message totemperature_setpoint_hold_policy (
st.matter.generated.zap_clusters.Thermostat.types.TemperatureSetpointHoldPolicyBitmap) –
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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) –
Bitmap types
- class st.matter.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.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
- SETPOINTS: number
512
- QUEUED_PRESETS_SUPPORTED: 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_setpoints_set()
- Returns
True if the value of SETPOINTS is non-zero
- Return type
boolean
- set_setpoints()
Set the value of the bit in the SETPOINTS field to 1
- unset_setpoints()
Set the value of the bits in the SETPOINTS field to 0
- is_queued_presets_supported_set()
- Returns
True if the value of QUEUED_PRESETS_SUPPORTED is non-zero
- Return type
boolean
- set_queued_presets_supported()
Set the value of the bit in the QUEUED_PRESETS_SUPPORTED field to 1
- unset_queued_presets_supported()
Set the value of the bits in the QUEUED_PRESETS_SUPPORTED field to 0
- class st.matter.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.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.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.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.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.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.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.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.clusters.Thermostat.types.TemperatureSetpointHoldPolicyBitmap
- HOLD_DURATION_ELAPSED: number
1
- HOLD_DURATION_ELAPSED_OR_PRESET_CHANGED: number
2
- is_hold_duration_elapsed_set()
- Returns
True if the value of HOLD_DURATION_ELAPSED is non-zero
- Return type
boolean
- set_hold_duration_elapsed()
Set the value of the bit in the HOLD_DURATION_ELAPSED field to 1
- unset_hold_duration_elapsed()
Set the value of the bits in the HOLD_DURATION_ELAPSED field to 0
- is_hold_duration_elapsed_or_preset_changed_set()
- Returns
True if the value of HOLD_DURATION_ELAPSED_OR_PRESET_CHANGED is non-zero
- Return type
boolean
- set_hold_duration_elapsed_or_preset_changed()
Set the value of the bit in the HOLD_DURATION_ELAPSED_OR_PRESET_CHANGED field to 1
- unset_hold_duration_elapsed_or_preset_changed()
Set the value of the bits in the HOLD_DURATION_ELAPSED_OR_PRESET_CHANGED field to 0
Enum types
- class st.matter.clusters.Thermostat.types.ACCapacityFormatEnum: st.matter.data_types.Uint8
- byte_length: number
1
- BT_UH: number
0
- class st.matter.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.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.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.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.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.clusters.Thermostat.types.PresetScenarioEnum: st.matter.data_types.Uint8
- byte_length: number
1
- UNSPECIFIED: number
0
- OCCUPIED: number
1
- UNOCCUPIED: number
2
- SLEEP: number
3
- WAKE: number
4
- VACATION: number
5
- USER_DEFINED: number
6
- class st.matter.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.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.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.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.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.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.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.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.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.clusters.Thermostat.types.QueuedPresetStruct: st.matter.data_types.Structure
- preset_handle: st.matter.data_types.OctetString1
- transition_timestamp: st.matter.data_types.Uint32
- class st.matter.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.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