Thermostat 

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int8

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

st.matter.data_types.Int8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int8

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

st.matter.data_types.Int8

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) –

Returns

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 for
endpoint_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.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 RemoteSensing(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.data_types.Uint8: the data type of this attribute

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

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Uint8) – the base data type object to add functionality to

new_value(...)

Create a Uint8 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 Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.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 SystemMode(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.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 ThermostatRunningMode(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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 for
endpoint_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.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 StartOfWeek(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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.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 TemperatureSetpointHold(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Uint16

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

st.matter.data_types.Uint16

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) –

Returns

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 for
endpoint_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.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 ThermostatProgrammingOperationMode(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

the value to write

Return type

subscribe(device, endpoint_id)

Reporting policy: ThermostatProgrammingOperationMode => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

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 for
endpoint_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.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 ThermostatRunningState(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint16
Return type: st.matter.data_types.Uint16

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 for
endpoint_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.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 SetpointChangeSource(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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: st.matter.data_types.Uint32

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 for
endpoint_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: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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 for
endpoint_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: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.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 ACType(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Uint16

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

st.matter.data_types.Uint16

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) –

Returns

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 for
endpoint_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.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 ACRefrigerantType(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.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 ACCompressorType(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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.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 ACErrorCode(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint32
Return type: st.matter.data_types.Uint32

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

st.matter.data_types.Uint32

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.Uint32) –

Returns

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 for
endpoint_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.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 ACLouverPosition(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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: st.matter.data_types.Int16

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 for
endpoint_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.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 ACCapacityformat(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Uint8
Return type: st.matter.data_types.Uint8

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) –

Returns

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 for
endpoint_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

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: st.matter.data_types.Array

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 for
endpoint_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

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: st.matter.data_types.Array

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 for
endpoint_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: data_types.Uint8

day_of_week_for_sequence: st.matter.clusters.Thermostat.types.DayOfWeek

mode_for_sequence: st.matter.clusters.Thermostat.types.ModeForSequence

transitions: st.matter.clusters.Thermostat.types.ThermostatScheduleTransition

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 to
endpoint_id (number or nil) –
number_of_transitions_for_sequence (data_types.Uint8) –
day_of_week_for_sequence (st.matter.clusters.Thermostat.types.DayOfWeek) –
mode_for_sequence (st.matter.clusters.Thermostat.types.ModeForSequence) –
transitions (st.matter.clusters.Thermostat.types.ThermostatScheduleTransition) –

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.clusters.Thermostat.types.SetpointAdjustMode

amount: 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 to
endpoint_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 command
device (st.matter.Device) – the device to build this message to
mode (st.matter.clusters.Thermostat.types.SetpointAdjustMode) –
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: data_types.Uint8

day_of_week_for_sequence: st.matter.clusters.Thermostat.types.DayOfWeek

mode_for_sequence: st.matter.clusters.Thermostat.types.ModeForSequence

transitions: st.matter.clusters.Thermostat.types.ThermostatScheduleTransition

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 to
endpoint_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 command
device (st.matter.Device) – the device to build this message to
number_of_transitions_for_sequence (st.matter.data_types.Uint8) –
day_of_week_for_sequence (st.matter.clusters.Thermostat.types.DayOfWeek) –
mode_for_sequence (st.matter.clusters.Thermostat.types.ModeForSequence) –
transitions (st.matter.clusters.Thermostat.types.ThermostatScheduleTransition) –

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.clusters.Thermostat.types.DayOfWeek

mode_to_return: st.matter.clusters.Thermostat.types.ModeForSequence

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 command
device (st.matter.Device) – the device to build this message to
days_to_return (st.matter.clusters.Thermostat.types.DayOfWeek) –
mode_to_return (st.matter.clusters.Thermostat.types.ModeForSequence) –

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 to
endpoint_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 command
device (st.matter.Device) – the device to build this message to

Returns

of type INVOKE

Return type