ThermostatUserInterfaceConfiguration

Attributes

class st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.server.attributes.TemperatureDisplayMode
ID: number

0x0000 the ID of this attribute

NAME: str

“TemperatureDisplayMode” the name of this attribute

data_type: st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.TemperatureDisplayModeEnum

the data type of this attribute

new_value(...)

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

This is also usable with the TemperatureDisplayMode(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a TemperatureDisplayModeEnum

Return type:

st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.TemperatureDisplayModeEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: TemperatureDisplayMode => 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 TemperatureDisplayMode 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.ThermostatUserInterfaceConfiguration.server.attributes.KeypadLockout
ID: number

0x0001 the ID of this attribute

NAME: str

“KeypadLockout” the name of this attribute

data_type: st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.KeypadLockoutEnum

the data type of this attribute

new_value(...)

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

This is also usable with the KeypadLockout(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a KeypadLockoutEnum

Return type:

st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.KeypadLockoutEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: KeypadLockout => 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 KeypadLockout 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.ThermostatUserInterfaceConfiguration.server.attributes.ScheduleProgrammingVisibility
ID: number

0x0002 the ID of this attribute

NAME: str

“ScheduleProgrammingVisibility” the name of this attribute

data_type: st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.ScheduleProgrammingVisibilityEnum

the data type of this attribute

new_value(...)

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

This is also usable with the ScheduleProgrammingVisibility(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a ScheduleProgrammingVisibilityEnum

Return type:

st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.ScheduleProgrammingVisibilityEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: ScheduleProgrammingVisibility => 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 ScheduleProgrammingVisibility 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.ThermostatUserInterfaceConfiguration.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:
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.ThermostatUserInterfaceConfiguration.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:
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)

Enum types

class st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.KeypadLockoutEnum: st.matter.data_types.Uint8
byte_length: number

1

NO_LOCKOUT: number

0

LOCKOUT1: number

1

LOCKOUT2: number

2

LOCKOUT3: number

3

LOCKOUT4: number

4

LOCKOUT5: number

5

class st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.ScheduleProgrammingVisibilityEnum: st.matter.data_types.Uint8
byte_length: number

1

SCHEDULE_PROGRAMMING_PERMITTED: number

0

SCHEDULE_PROGRAMMING_DENIED: number

1

class st.matter.generated.zap_clusters.ThermostatUserInterfaceConfiguration.types.TemperatureDisplayModeEnum: st.matter.data_types.Uint8
byte_length: number

1

CELSIUS: number

0

FAHRENHEIT: number

1