TemperatureControl¶

Attributes¶

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.TemperatureSetpoint¶

ID: number¶: 0x0000 the ID of this attribute

NAME: str¶: “TemperatureSetpoint” 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 TemperatureSetpoint(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: TemperatureSetpoint => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an TemperatureSetpoint 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.MinTemperature¶

ID: number¶: 0x0001 the ID of this attribute

NAME: str¶: “MinTemperature” 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 MinTemperature(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: MinTemperature => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an MinTemperature 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.MaxTemperature¶

ID: number¶: 0x0002 the ID of this attribute

NAME: str¶: “MaxTemperature” 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 MaxTemperature(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: MaxTemperature => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an MaxTemperature 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.Step¶

ID: number¶: 0x0003 the ID of this attribute

NAME: str¶: “Step” 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 Step(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: Step => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an Step 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.SelectedTemperatureLevel¶

ID: number¶: 0x0004 the ID of this attribute

NAME: str¶: “SelectedTemperatureLevel” 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 SelectedTemperatureLevel(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: SelectedTemperatureLevel => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an SelectedTemperatureLevel 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.SupportedTemperatureLevels¶

ID: number¶: 0x0005 the ID of this attribute

NAME: str¶: “SupportedTemperatureLevels” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

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

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the SupportedTemperatureLevels(…) 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: SupportedTemperatureLevels => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an SupportedTemperatureLevels 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:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.AcceptedCommandList¶

ID: number¶: 0xFFF9 the ID of this attribute

NAME: str¶: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

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

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Array
Return type:: 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.TemperatureControl.server.attributes.AttributeList¶

ID: number¶: 0xFFFB the ID of this attribute

NAME: str¶: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

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

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Array
Return type:: 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:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Server Commands¶

class st.matter.generated.zap_clusters.TemperatureControl.server.commands.SetTemperature: st.matter.data_types.Structure ¶

ID: number¶: 0x0000 the ID of this command

NAME: str¶: “SetTemperature” the name of this command

target_temperature: st.matter.data_types.Int16¶

target_temperature_level: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an SetTemperature 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(device, target_temperature, target_temperature_level)¶

Initialize the SetTemperature command

Parameters:

device (st.matter.Device) – the device to build this message to
target_temperature (st.matter.data_types.Int16)
target_temperature_level (st.matter.data_types.Uint8)

Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.TemperatureControl.types.Feature¶

TEMPERATURE_NUMBER: number¶: 1

TEMPERATURE_LEVEL: number¶: 2

TEMPERATURE_STEP: number¶: 4

is_temperature_number_set()¶

Returns:: True if the value of TEMPERATURE_NUMBER is non-zero
Return type:: boolean

set_temperature_number()¶: Set the value of the bit in the TEMPERATURE_NUMBER field to 1

unset_temperature_number()¶: Set the value of the bits in the TEMPERATURE_NUMBER field to 0

is_temperature_level_set()¶

Returns:: True if the value of TEMPERATURE_LEVEL is non-zero
Return type:: boolean

set_temperature_level()¶: Set the value of the bit in the TEMPERATURE_LEVEL field to 1

unset_temperature_level()¶: Set the value of the bits in the TEMPERATURE_LEVEL field to 0

is_temperature_step_set()¶

Returns:: True if the value of TEMPERATURE_STEP is non-zero
Return type:: boolean

set_temperature_step()¶: Set the value of the bit in the TEMPERATURE_STEP field to 1

unset_temperature_step()¶: Set the value of the bits in the TEMPERATURE_STEP field to 0