Thermostat

class st.zigbee.zcl.clusters.Thermostat

ID: number: 0x0201 the ID of this cluster

NAME: str: “Thermostat” the name of this cluster

attributes: st.zigbee.zcl.clusters.ThermostatServerAttributes or st.zigbee.zcl.clusters.ThermostatClientAttributes

commands: st.zigbee.zcl.clusters.ThermostatServerCommands or st.zigbee.zcl.clusters.ThermostatClientCommands

types: st.zigbee.zcl.clusters.ThermostatTypes

Thermostat Attributes

class st.zigbee.zcl.clusters.Thermostat.LocalTemperature

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

NAME: str: “LocalTemperature” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the LocalTemperature(…) syntax

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OutdoorTemperature

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

NAME: str: “OutdoorTemperature” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.Occupancy

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

NAME: str: “Occupancy” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8: the data type of this attribute

OCCUPIED: number: 1

is_occupied_set()

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

set_occupied(): Set the value of the bit in the OCCUPIED field to 1

unset_occupied(): Set the value of the bits in the OCCUPIED field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.AbsMinHeatSetpointLimit

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

NAME: str: “AbsMinHeatSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.AbsMaxHeatSetpointLimit

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

NAME: str: “AbsMaxHeatSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.AbsMinCoolSetpointLimit

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

NAME: str: “AbsMinCoolSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.AbsMaxCoolSetpointLimit

ID: number: 0x0006 the ID of this attribute

NAME: str: “AbsMaxCoolSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.PICoolingDemand

ID: number: 0x0007 the ID of this attribute

NAME: str: “PICoolingDemand” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.PIHeatingDemand

ID: number: 0x0008 the ID of this attribute

NAME: str: “PIHeatingDemand” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.HVACSystemTypeConfiguration

ID: number: 0x0009 the ID of this attribute

NAME: str: “HVACSystemTypeConfiguration” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8: the data type of this attribute

COOLING_SYSTEM_STAGE: number: 3

HEATING_SYSTEM_STAGE: number: 12

HEATING_SYSTEM_TYPE: number: 16

HEATING_FUEL_SOURCE: number: 32

is_cooling_system_stage_set()

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

set_cooling_system_stage(fieldVal)

Set the value of the bits in the COOLING_SYSTEM_STAGE field

Parameters: fieldVal (number) – the value to set the bitfield to

get_cooling_system_stage(): Get the value of the bits in the COOLING_SYSTEM_STAGE field

unset_cooling_system_stage(): Set the value of the bits in the COOLING_SYSTEM_STAGE field to 0

is_heating_system_stage_set()

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

set_heating_system_stage(fieldVal)

Set the value of the bits in the HEATING_SYSTEM_STAGE field

Parameters: fieldVal (number) – the value to set the bitfield to

get_heating_system_stage(): Get the value of the bits in the HEATING_SYSTEM_STAGE field

unset_heating_system_stage(): Set the value of the bits in the HEATING_SYSTEM_STAGE field to 0

is_heating_system_type_set()

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

set_heating_system_type(): Set the value of the bit in the HEATING_SYSTEM_TYPE field to 1

unset_heating_system_type(): Set the value of the bits in the HEATING_SYSTEM_TYPE field to 0

is_heating_fuel_source_set()

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

set_heating_fuel_source(): Set the value of the bit in the HEATING_FUEL_SOURCE field to 1

unset_heating_fuel_source(): Set the value of the bits in the HEATING_FUEL_SOURCE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Bitmap8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.LocalTemperatureCalibration

ID: number: 0x0010 the ID of this attribute

NAME: str: “LocalTemperatureCalibration” the name of this attribute

data_type: st.zigbee.data_types.Int8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OccupiedCoolingSetpoint

ID: number: 0x0011 the ID of this attribute

NAME: str: “OccupiedCoolingSetpoint” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OccupiedHeatingSetpoint

ID: number: 0x0012 the ID of this attribute

NAME: str: “OccupiedHeatingSetpoint” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.UnoccupiedCoolingSetpoint

ID: number: 0x0013 the ID of this attribute

NAME: str: “UnoccupiedCoolingSetpoint” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.UnoccupiedHeatingSetpoint

ID: number: 0x0014 the ID of this attribute

NAME: str: “UnoccupiedHeatingSetpoint” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.MinHeatSetpointLimit

ID: number: 0x0015 the ID of this attribute

NAME: str: “MinHeatSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.MaxHeatSetpointLimit

ID: number: 0x0016 the ID of this attribute

NAME: str: “MaxHeatSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.MinCoolSetpointLimit

ID: number: 0x0017 the ID of this attribute

NAME: str: “MinCoolSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.MaxCoolSetpointLimit

ID: number: 0x0018 the ID of this attribute

NAME: str: “MaxCoolSetpointLimit” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.MinSetpointDeadBand

ID: number: 0x0019 the ID of this attribute

NAME: str: “MinSetpointDeadBand” the name of this attribute

data_type: st.zigbee.data_types.Int8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Int8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.RemoteSensing

ID: number: 0x001A the ID of this attribute

NAME: str: “RemoteSensing” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8: the data type of this attribute

LOCAL_TEMPERATURE_REMOTE: number: 1

OUTDOOR_TEMPERATURE_REMOTE: number: 2

OCCUPANCY_REMOTE: number: 4

is_local_temperature_remote_set()

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

set_local_temperature_remote(): Set the value of the bit in the LOCAL_TEMPERATURE_REMOTE field to 1

unset_local_temperature_remote(): Set the value of the bits in the LOCAL_TEMPERATURE_REMOTE field to 0

is_outdoor_temperature_remote_set()

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

set_outdoor_temperature_remote(): Set the value of the bit in the OUTDOOR_TEMPERATURE_REMOTE field to 1

unset_outdoor_temperature_remote(): Set the value of the bits in the OUTDOOR_TEMPERATURE_REMOTE field to 0

is_occupancy_remote_set()

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

set_occupancy_remote(): Set the value of the bit in the OCCUPANCY_REMOTE field to 1

unset_occupancy_remote(): Set the value of the bits in the OCCUPANCY_REMOTE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Bitmap8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ControlSequenceOfOperation

ID: number: 0x001B the ID of this attribute

NAME: str: “ControlSequenceOfOperation” the name of this attribute

data_type: st.zigbee.data_types.Enum8: 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_HEATING4PIPES: number: 4

COOLING_AND_HEATING4PIPES_WITH_REHEAT: number: 5

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SystemMode

ID: number: 0x001C the ID of this attribute

NAME: str: “SystemMode” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

OFF: number: 0

AUTO: number: 1

COOL: number: 3

HEAT: number: 4

EMERGENCY_HEATING: number: 5

PRECOOLING: number: 6

FAN_ONLY: number: 7

DRY: number: 8

SLEEP: number: 9

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.AlarmMask

ID: number: 0x001D the ID of this attribute

NAME: str: “AlarmMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8: the data type of this attribute

INITIALIZATION_FAILURE: number: 1

HARDWARE_FAILURE: number: 2

SELF_CALIBRATION_FAILURE: number: 4

is_initialization_failure_set()

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

set_initialization_failure(): Set the value of the bit in the INITIALIZATION_FAILURE field to 1

unset_initialization_failure(): Set the value of the bits in the INITIALIZATION_FAILURE field to 0

is_hardware_failure_set()

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

set_hardware_failure(): Set the value of the bit in the HARDWARE_FAILURE field to 1

unset_hardware_failure(): Set the value of the bits in the HARDWARE_FAILURE field to 0

is_self_calibration_failure_set()

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

set_self_calibration_failure(): Set the value of the bit in the SELF_CALIBRATION_FAILURE field to 1

unset_self_calibration_failure(): Set the value of the bits in the SELF_CALIBRATION_FAILURE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the AlarmMask(…) syntax

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ThermostatRunningMode

ID: number: 0x001E the ID of this attribute

NAME: str: “ThermostatRunningMode” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

OFF: number: 0

COOL: number: 3

HEAT: number: 4

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.StartOfWeek

ID: number: 0x0020 the ID of this attribute

NAME: str: “StartOfWeek” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

SUNDAY: number: 0

MONDAY: number: 1

TUESDAY: number: 2

WEDNESDAY: number: 3

THURSDAY: number: 4

FRIDAY: number: 5

SUNDAY: number: 6

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.NumberOfWeeklyTransitions

ID: number: 0x0021 the ID of this attribute

NAME: str: “NumberOfWeeklyTransitions” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.NumberOfDailyTransitions

ID: number: 0x0022 the ID of this attribute

NAME: str: “NumberOfDailyTransitions” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.TemperatureSetpointHold

ID: number: 0x0023 the ID of this attribute

NAME: str: “TemperatureSetpointHold” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

SETPOINT_HOLD_OFF: number: 0

SETPOINT_HOLD_ON: number: 1

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.TemperatureSetpointHoldDuration

ID: number: 0x0024 the ID of this attribute

NAME: str: “TemperatureSetpointHoldDuration” the name of this attribute

data_type: st.zigbee.data_types.Uint16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ThermostatProgrammingOperationMode

ID: number: 0x0025 the ID of this attribute

NAME: str: “ThermostatProgrammingOperationMode” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8: the data type of this attribute

PROGRAMMING_MODE: number: 1

AUTO_OR_RECOVERY: number: 2

ECONOMY_OR_ENERGY_STAR: number: 4

is_programming_mode_set()

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

set_programming_mode(): Set the value of the bit in the PROGRAMMING_MODE field to 1

unset_programming_mode(): Set the value of the bits in the PROGRAMMING_MODE field to 0

is_auto_or_recovery_set()

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

set_auto_or_recovery(): Set the value of the bit in the AUTO_OR_RECOVERY field to 1

unset_auto_or_recovery(): Set the value of the bits in the AUTO_OR_RECOVERY field to 0

is_economy_or_energy_star_set()

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

set_economy_or_energy_star(): Set the value of the bit in the ECONOMY_OR_ENERGY_STAR field to 1

unset_economy_or_energy_star(): Set the value of the bits in the ECONOMY_OR_ENERGY_STAR field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Bitmap8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ThermostatRunningState

ID: number: 0x0029 the ID of this attribute

NAME: str: “ThermostatRunningState” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16: the data type of this attribute

HEAT_ON: number: 1

COOL_ON: number: 2

FAN_ON: number: 4

HEAT_SECOND_STAGE_ON: number: 8

COOL_SECOND_STAGE_ON: number: 16

FAN_SECOND_STAGE_ON: number: 32

FAN_THIRD_STAGE_ON: number: 64

is_heat_on_set()

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

set_heat_on(): Set the value of the bit in the HEAT_ON field to 1

unset_heat_on(): Set the value of the bits in the HEAT_ON field to 0

is_cool_on_set()

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

set_cool_on(): Set the value of the bit in the COOL_ON field to 1

unset_cool_on(): Set the value of the bits in the COOL_ON field to 0

is_fan_on_set()

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

set_fan_on(): Set the value of the bit in the FAN_ON field to 1

unset_fan_on(): Set the value of the bits in the FAN_ON field to 0

is_heat_second_stage_on_set()

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

set_heat_second_stage_on(): Set the value of the bit in the HEAT_SECOND_STAGE_ON field to 1

unset_heat_second_stage_on(): Set the value of the bits in the HEAT_SECOND_STAGE_ON field to 0

is_cool_second_stage_on_set()

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

set_cool_second_stage_on(): Set the value of the bit in the COOL_SECOND_STAGE_ON field to 1

unset_cool_second_stage_on(): Set the value of the bits in the COOL_SECOND_STAGE_ON field to 0

is_fan_second_stage_on_set()

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

set_fan_second_stage_on(): Set the value of the bit in the FAN_SECOND_STAGE_ON field to 1

unset_fan_second_stage_on(): Set the value of the bits in the FAN_SECOND_STAGE_ON field to 0

is_fan_third_stage_on_set()

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

set_fan_third_stage_on(): Set the value of the bit in the FAN_THIRD_STAGE_ON field to 1

unset_fan_third_stage_on(): Set the value of the bits in the FAN_THIRD_STAGE_ON field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SetpointChangeSource

ID: number: 0x0030 the ID of this attribute

NAME: str: “SetpointChangeSource” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

MANUAL: number: 0

SCHEDULE_OR_INTERNAL_PROGRAMMING: number: 1

EXTERNAL: number: 2

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SetpointChangeAmount

ID: number: 0x0031 the ID of this attribute

NAME: str: “SetpointChangeAmount” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SetpointChangeSourceTimestamp

ID: number: 0x0032 the ID of this attribute

NAME: str: “SetpointChangeSourceTimestamp” the name of this attribute

data_type: st.zigbee.data_types.UtcTime: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.UtcTime) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.UtcTime) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.UtcTime) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OccupiedSetback

ID: number: 0x0034 the ID of this attribute

NAME: str: “OccupiedSetback” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OccupiedSetbackMin

ID: number: 0x0035 the ID of this attribute

NAME: str: “OccupiedSetbackMin” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.OccupiedSetbackMax

ID: number: 0x0036 the ID of this attribute

NAME: str: “OccupiedSetbackMax” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.UnoccupiedSetback

ID: number: 0x0037 the ID of this attribute

NAME: str: “UnoccupiedSetback” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.UnoccupiedSetbackMin

ID: number: 0x0038 the ID of this attribute

NAME: str: “UnoccupiedSetbackMin” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.UnoccupiedSetbackMax

ID: number: 0x0039 the ID of this attribute

NAME: str: “UnoccupiedSetbackMax” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.EmergencyHeatDelta

ID: number: 0x003A the ID of this attribute

NAME: str: “EmergencyHeatDelta” the name of this attribute

data_type: st.zigbee.data_types.Uint8: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint8

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint8) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACType

ID: number: 0x0040 the ID of this attribute

NAME: str: “ACType” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

COOLING_AND_FIXED_SPEED: number: 1

HEAT_PUMP_AND_FIXED_SPEED: number: 2

COOLING_AND_INVERTER: number: 3

HEAT_PUMP_AND_INVERTER: number: 4

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACCapacity

ID: number: 0x0041 the ID of this attribute

NAME: str: “ACCapacity” the name of this attribute

data_type: st.zigbee.data_types.Uint16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Uint16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Uint16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Uint16) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACRefrigerantType

ID: number: 0x0042 the ID of this attribute

NAME: str: “ACRefrigerantType” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

R22: number: 1

R410A: number: 2

R407C: number: 3

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACCompressorType

ID: number: 0x0043 the ID of this attribute

NAME: str: “ACCompressorType” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

T1: number: 1

T2: number: 2

T3: number: 3

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACErrorCode

ID: number: 0x0044 the ID of this attribute

NAME: str: “ACErrorCode” the name of this attribute

data_type: st.zigbee.data_types.Bitmap32: the data type of this attribute

COMPRESSOR_FAILURE_OR_REFRIGERANT_LEAKAGE: number: 1

ROOM_TEMPERATURE_SENSOR_FAILURE: number: 2

OUTDOOR_TEMPERATURE_SENSOR_FAILURE: number: 4

INDOOR_COIL_TEMPERATURE_SENSOR_FAILURE: number: 8

FAN_FAILURE: number: 16

is_compressor_failure_or_refrigerant_leakage_set()

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

set_compressor_failure_or_refrigerant_leakage(): Set the value of the bit in the COMPRESSOR_FAILURE_OR_REFRIGERANT_LEAKAGE field to 1

unset_compressor_failure_or_refrigerant_leakage(): Set the value of the bits in the COMPRESSOR_FAILURE_OR_REFRIGERANT_LEAKAGE field to 0

is_room_temperature_sensor_failure_set()

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

set_room_temperature_sensor_failure(): Set the value of the bit in the ROOM_TEMPERATURE_SENSOR_FAILURE field to 1

unset_room_temperature_sensor_failure(): Set the value of the bits in the ROOM_TEMPERATURE_SENSOR_FAILURE field to 0

is_outdoor_temperature_sensor_failure_set()

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

set_outdoor_temperature_sensor_failure(): Set the value of the bit in the OUTDOOR_TEMPERATURE_SENSOR_FAILURE field to 1

unset_outdoor_temperature_sensor_failure(): Set the value of the bits in the OUTDOOR_TEMPERATURE_SENSOR_FAILURE field to 0

is_indoor_coil_temperature_sensor_failure_set()

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

set_indoor_coil_temperature_sensor_failure(): Set the value of the bit in the INDOOR_COIL_TEMPERATURE_SENSOR_FAILURE field to 1

unset_indoor_coil_temperature_sensor_failure(): Set the value of the bits in the INDOOR_COIL_TEMPERATURE_SENSOR_FAILURE field to 0

is_fan_failure_set()

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

set_fan_failure(): Set the value of the bit in the FAN_FAILURE field to 1

unset_fan_failure(): Set the value of the bits in the FAN_FAILURE field to 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap32) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Bitmap32) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Bitmap32) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACLouverPosition

ID: number: 0x0045 the ID of this attribute

NAME: str: “ACLouverPosition” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

FULLY_CLOSED: number: 1

FULLY_OPEN: number: 2

QUARTER_OPEN: number: 3

HALF_OPEN: number: 4

THREE_QUARTERS_OPEN: number: 5

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACCoilTemperature

ID: number: 0x0046 the ID of this attribute

NAME: str: “ACCoilTemperature” the name of this attribute

data_type: st.zigbee.data_types.Int16: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Int16) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

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.zigbee.data_types.Int16

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute
rep_change (st.zigbee.data_types.Int16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ACCapacityFormat

ID: number: 0x0047 the ID of this attribute

NAME: str: “ACCapacityFormat” the name of this attribute

data_type: st.zigbee.data_types.Enum8: the data type of this attribute

BT_UH: number: 0

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

Build a Rx Zigbee message as if a device reported this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

Build a Rx Zigbee message as if a device sent a read response for this attribute

Parameters

device (st.zigbee.Device) –
data (st.zigbee.data_types.Enum8) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

read(device)

Construct a st.zigbee.ZigbeeMessageTx to read this attribute from a device

Parameters: device (st.zigbee.Device) –
Returns: containing a ReadAttribute body
Return type: st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

Construct a st.zigbee.ZigbeeMessageTx to configure this attribute for reporting on a device

Parameters

device (st.zigbee.Device) –
min_rep_int (number or st.zigbee.data_types.Uint16) – the minimum interval allowed between reports of this attribute
max_rep_int (number or st.zigbee.data_types.Uint16) – the maximum interval allowed between reports of this attribute

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

device (st.zigbee.Device) –
value (st.zigbee.data_types.Enum8) – the value to write

set_parent_cluster(cluster)

Parameters: cluster (any) –

Thermostat Commands

class st.zigbee.zcl.clusters.Thermostat.GetWeeklyScheduleResponse

ID: number: 0x00 the ID of this command

NAME: str: “GetWeeklyScheduleResponse” the name of this command

number_of_transitions: st.zigbee.data_types.Uint8

day_of_week: st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek

mode: st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode

transitions_list: list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: GetWeeklyScheduleResponse

set_field_names()

static build_test_rx(device, number_of_transitions, day_of_week, mode, transitions)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from
number_of_transitions (st.zigbee.data_types.Uint8) –
day_of_week (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –
transitions (list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, number_of_transitions, day_of_week, mode, transitions)

Initialize the GetWeeklyScheduleResponse command

Parameters

self (GetWeeklyScheduleResponse) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
number_of_transitions (st.zigbee.data_types.Uint8) –
day_of_week (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –
transitions (list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.GetRelayStatusLogResponse

ID: number: 0x01 the ID of this command

NAME: str: “GetRelayStatusLogResponse” the name of this command

time_of_day: st.zigbee.data_types.Uint16

relay_status: st.zigbee.data_types.Bitmap8

local_temperature: st.zigbee.data_types.Int16

humidity_percentage: st.zigbee.data_types.Uint8

set_point: st.zigbee.data_types.Int16

unread_entries: st.zigbee.data_types.Uint16

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: GetRelayStatusLogResponse

set_field_names()

static build_test_rx(device, time_of_day, relay_status, local_temperature, humidity_percentage, set_point, unread_entries)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from
time_of_day (st.zigbee.data_types.Uint16) –
relay_status (st.zigbee.data_types.Bitmap8) –
local_temperature (st.zigbee.data_types.Int16) –
humidity_percentage (st.zigbee.data_types.Uint8) –
set_point (st.zigbee.data_types.Int16) –
unread_entries (st.zigbee.data_types.Uint16) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, time_of_day, relay_status, local_temperature, humidity_percentage, set_point, unread_entries)

Initialize the GetRelayStatusLogResponse command

Parameters

self (GetRelayStatusLogResponse) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
time_of_day (st.zigbee.data_types.Uint16) –
relay_status (st.zigbee.data_types.Bitmap8) –
local_temperature (st.zigbee.data_types.Int16) –
humidity_percentage (st.zigbee.data_types.Uint8) –
set_point (st.zigbee.data_types.Int16) –
unread_entries (st.zigbee.data_types.Uint16) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SetpointRaiseOrLower

ID: number: 0x00 the ID of this command

NAME: str: “SetpointRaiseOrLower” the name of this command

mode: st.zigbee.zcl.clusters.Thermostat.types.Mode

amount: st.zigbee.data_types.Int8

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: SetpointRaiseOrLower

set_field_names()

static build_test_rx(device, mode, amount)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from
mode (st.zigbee.zcl.clusters.Thermostat.types.Mode) –
amount (st.zigbee.data_types.Int8) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, mode, amount)

Initialize the SetpointRaiseOrLower command

Parameters

self (SetpointRaiseOrLower) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
mode (st.zigbee.zcl.clusters.Thermostat.types.Mode) –
amount (st.zigbee.data_types.Int8) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.SetWeeklySchedule

ID: number: 0x01 the ID of this command

NAME: str: “SetWeeklySchedule” the name of this command

number_of_transitions: st.zigbee.data_types.Uint8

day_of_week: st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek

mode: st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode

transitions_list: list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: SetWeeklySchedule

set_field_names()

static build_test_rx(device, number_of_transitions, day_of_week, mode, transitions)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from
number_of_transitions (st.zigbee.data_types.Uint8) –
day_of_week (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –
transitions (list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, number_of_transitions, day_of_week, mode, transitions)

Initialize the SetWeeklySchedule command

Parameters

self (SetWeeklySchedule) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
number_of_transitions (st.zigbee.data_types.Uint8) –
day_of_week (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –
transitions (list[st.zigbee.zcl.clusters.Thermostat.types.TransitionType]) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.GetWeeklySchedule

ID: number: 0x02 the ID of this command

NAME: str: “GetWeeklySchedule” the name of this command

days_to_return: st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek

mode_to_return: st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: GetWeeklySchedule

set_field_names()

static build_test_rx(device, days_to_return, mode_to_return)

Build a version of this message as if it came from the device

Parameters

device (st.zigbee.Device) – the device to build the message from
days_to_return (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode_to_return (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, days_to_return, mode_to_return)

Initialize the GetWeeklySchedule command

Parameters

self (GetWeeklySchedule) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
days_to_return (st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek) –
mode_to_return (st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.ClearWeeklySchedule

ID: number: 0x03 the ID of this command

NAME: str: “ClearWeeklySchedule” the name of this command

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: ClearWeeklySchedule

set_field_names()

static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters: device (st.zigbee.Device) – the device to build the message from
Returns: The full Zigbee message containing this command body
Return type: st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ClearWeeklySchedule command

Parameters

self (ClearWeeklySchedule) – the template class for this command
device (st.zigbee.Device) – the device to build this message to

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.Thermostat.GetRelayStatusLog

ID: number: 0x04 the ID of this command

NAME: str: “GetRelayStatusLog” the name of this command

get_fields()

static deserialize(buf)

Deserialize this command

Parameters: buf (buf) – the bytes of the command body
Return type: GetRelayStatusLog

set_field_names()

static build_test_rx(device)

Build a version of this message as if it came from the device

Parameters: device (st.zigbee.Device) – the device to build the message from
Returns: The full Zigbee message containing this command body
Return type: st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the GetRelayStatusLog command

Parameters

self (GetRelayStatusLog) – the template class for this command
device (st.zigbee.Device) – the device to build this message to

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

Thermostat Types

class st.zigbee.zcl.clusters.Thermostat.types.TransitionType

NAME: TransitionType

transition_time: st.zigbee.data_types.Uint16

heat_set_point: st.zigbee.data_types.Int16

cool_set_point: st.zigbee.data_types.Int16

get_length()

Returns: the length in bytes of this frame
Return type: number

_serialize()

Returns: this class serialized to bytes
Return type: str

pretty_print()

Returns: this class in a human readable format
Return type: str

static deserialize(buf)

Parameters: buf (Reader) – the buf to parse this class from
Returns: the length in bytes of this frame
Return type: number

static init(transition_time, heat_set_point, cool_set_point)

Parameters

transition_time (st.zigbee.data_types.Uint16) –
heat_set_point (st.zigbee.data_types.Int16) –
cool_set_point (st.zigbee.data_types.Int16) –

class st.zigbee.zcl.clusters.Thermostat.types.DayOfWeek: st.zigbee.data_types.Bitmap8 

byte_length: number: 1

SUNDAY: number: 1

MONDAY: number: 2

TUESDAY: number: 4

WEDNESDAY: number: 8

THURSDAY: number: 16

FRIDAY: number: 32

SATURDAY: number: 64

AWAY_OR_VACATION: number: 128

is_sunday_set()

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

set_sunday(): Set the value of the bit in the SUNDAY field to 1

unset_sunday(): Set the value of the bits in the SUNDAY field to 0

is_monday_set()

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

set_monday(): Set the value of the bit in the MONDAY field to 1

unset_monday(): Set the value of the bits in the MONDAY field to 0

is_tuesday_set()

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

set_tuesday(): Set the value of the bit in the TUESDAY field to 1

unset_tuesday(): Set the value of the bits in the TUESDAY field to 0

is_wednesday_set()

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

set_wednesday(): Set the value of the bit in the WEDNESDAY field to 1

unset_wednesday(): Set the value of the bits in the WEDNESDAY field to 0

is_thursday_set()

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

set_thursday(): Set the value of the bit in the THURSDAY field to 1

unset_thursday(): Set the value of the bits in the THURSDAY field to 0

is_friday_set()

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

set_friday(): Set the value of the bit in the FRIDAY field to 1

unset_friday(): Set the value of the bits in the FRIDAY field to 0

is_saturday_set()

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

set_saturday(): Set the value of the bit in the SATURDAY field to 1

unset_saturday(): Set the value of the bits in the SATURDAY field to 0

is_away_or_vacation_set()

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

set_away_or_vacation(): Set the value of the bit in the AWAY_OR_VACATION field to 1

unset_away_or_vacation(): Set the value of the bits in the AWAY_OR_VACATION field to 0

class st.zigbee.zcl.clusters.Thermostat.types.ScheduleMode: st.zigbee.data_types.Bitmap8 

byte_length: number: 1

HEAT: number: 1

COOL: number: 2

is_heat_set()

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

set_heat(): Set the value of the bit in the HEAT field to 1

unset_heat(): Set the value of the bits in the HEAT field to 0

is_cool_set()

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

set_cool(): Set the value of the bit in the COOL field to 1

unset_cool(): Set the value of the bits in the COOL field to 0

class st.zigbee.zcl.clusters.Thermostat.types.Mode: st.zigbee.data_types.Enum8 

byte_length: number: 1

HEAT: number: 0

COOL: number: 1

BOTH: number: 2