ColorControl

class st.zigbee.zcl.clusters.ColorControl

ID: number

0x0300 the ID of this cluster

NAME: str

“ColorControl” the name of this cluster

attributes: st.zigbee.zcl.clusters.ColorControlServerAttributes or st.zigbee.zcl.clusters.ColorControlClientAttributes

commands: st.zigbee.zcl.clusters.ColorControlServerCommands or st.zigbee.zcl.clusters.ColorControlClientCommands

types: st.zigbee.zcl.clusters.ColorControlTypes

ColorControl Attributes

class st.zigbee.zcl.clusters.ColorControl.CurrentHue

ID: number

0x0000 the ID of this attribute

NAME: str

“CurrentHue” 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 CurrentHue(…) 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.ColorControl.CurrentSaturation

ID: number

0x0001 the ID of this attribute

NAME: str

“CurrentSaturation” 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 CurrentSaturation(…) 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.ColorControl.RemainingTime

ID: number

0x0002 the ID of this attribute

NAME: str

“RemainingTime” 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 RemainingTime(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.CurrentX

ID: number

0x0003 the ID of this attribute

NAME: str

“CurrentX” 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 CurrentX(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.CurrentY

ID: number

0x0004 the ID of this attribute

NAME: str

“CurrentY” 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 CurrentY(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.DriftCompensation

ID: number

0x0005 the ID of this attribute

NAME: str

“DriftCompensation” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

NONE: number

0

OTHER_OR_UNKNOWN: number

1

TEMPERATURE_MONITORING: number

2

OPTICAL_LUMINANCE_MONITORING_AND_FEEDBACK: number

3

OPTICAL_COLOR_MONITORING_AND_FEEDBACK: 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 DriftCompensation(…) 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.ColorControl.CompensationText

ID: number

0x0006 the ID of this attribute

NAME: str

“CompensationText” the name of this attribute

data_type: st.zigbee.data_types.CharString

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.CharString) – 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.CharString) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the CompensationText(…) syntax

Parameters

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

Return type

st.zigbee.data_types.CharString

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.CharString) – 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.ColorControl.ColorTemperatureMireds

ID: number

0x0007 the ID of this attribute

NAME: str

“ColorTemperatureMireds” 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 ColorTemperatureMireds(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.ColorMode

ID: number

0x0008 the ID of this attribute

NAME: str

“ColorMode” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

CURRENT_HUE_AND_CURRENT_SATURATION: number

0

CURRENT_X_AND_CURRENT_Y: number

1

COLOR_TEMPERATURE_MIREDS: 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 ColorMode(…) 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.ColorControl.Options

ID: number

0x000F the ID of this attribute

NAME: str

“Options” the name of this attribute

data_type: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

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.zcl.clusters.ColorControl.types.CcColorOptions) – 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.zcl.clusters.ColorControl.types.CcColorOptions) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the Options(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

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.zcl.clusters.ColorControl.types.CcColorOptions) – 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.zcl.clusters.ColorControl.types.CcColorOptions) – the value to write

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.EnhancedCurrentHue

ID: number

0x4000 the ID of this attribute

NAME: str

“EnhancedCurrentHue” 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 EnhancedCurrentHue(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.EnhancedColorMode

ID: number

0x4001 the ID of this attribute

NAME: str

“EnhancedColorMode” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

CURRENT_HUE_AND_CURRENT_SATURATION: number

0

CURRENT_X_AND_CURRENT_Y: number

1

COLOR_TEMPERATURE_MIREDS: number

2

ENHANCED_CURRENT_HUE_AND_CURRENT_SATURATION: 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 EnhancedColorMode(…) 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.ColorControl.ColorLoopActive

ID: number

0x4002 the ID of this attribute

NAME: str

“ColorLoopActive” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

COLOR_LOOP_INACTIVE: number

0

COLOR_LOOP_ACTIVE: number

1

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

base_type_obj (st.zigbee.data_types.Uint8) – 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.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 ColorLoopActive(…) 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.ColorControl.ColorLoopDirection

ID: number

0x4003 the ID of this attribute

NAME: str

“ColorLoopDirection” the name of this attribute

data_type: st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection

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.zcl.clusters.ColorControl.types.CcColorLoopDirection) – 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.zcl.clusters.ColorControl.types.CcColorLoopDirection) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ColorLoopDirection(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection

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.zcl.clusters.ColorControl.types.CcColorLoopDirection) – 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.ColorControl.ColorLoopTime

ID: number

0x4004 the ID of this attribute

NAME: str

“ColorLoopTime” 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 ColorLoopTime(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.ColorLoopStartEnhancedHue

ID: number

0x4005 the ID of this attribute

NAME: str

“ColorLoopStartEnhancedHue” 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 ColorLoopStartEnhancedHue(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.ColorLoopStoredEnhancedHue

ID: number

0x4006 the ID of this attribute

NAME: str

“ColorLoopStoredEnhancedHue” 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 ColorLoopStoredEnhancedHue(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.ColorCapabilities

ID: number

0x400A the ID of this attribute

NAME: str

“ColorCapabilities” the name of this attribute

data_type: st.zigbee.data_types.Bitmap16

the data type of this attribute

HUE_SATURATION_SUPPORTED: number

1

ENHANCED_HUE_SUPPORTED: number

2

COLOR_LOOP_SUPPORTED: number

4

XY_SUPPORTED: number

8

COLOR_TEMPERATURE_SUPPORTED: number

16

is_hue_saturation_supported_set()

Returns

True if the value of HUE_SATURATION_SUPPORTED is non-zero

Return type

boolean

set_hue_saturation_supported()

Set the value of the bit in the HUE_SATURATION_SUPPORTED field to 1

unset_hue_saturation_supported()

Set the value of the bits in the HUE_SATURATION_SUPPORTED field to 0

is_enhanced_hue_supported_set()

Returns

True if the value of ENHANCED_HUE_SUPPORTED is non-zero

Return type

boolean

set_enhanced_hue_supported()

Set the value of the bit in the ENHANCED_HUE_SUPPORTED field to 1

unset_enhanced_hue_supported()

Set the value of the bits in the ENHANCED_HUE_SUPPORTED field to 0

is_color_loop_supported_set()

Returns

True if the value of COLOR_LOOP_SUPPORTED is non-zero

Return type

boolean

set_color_loop_supported()

Set the value of the bit in the COLOR_LOOP_SUPPORTED field to 1

unset_color_loop_supported()

Set the value of the bits in the COLOR_LOOP_SUPPORTED field to 0

is_xy_supported_set()

Returns

True if the value of XY_SUPPORTED is non-zero

Return type

boolean

set_xy_supported()

Set the value of the bit in the XY_SUPPORTED field to 1

unset_xy_supported()

Set the value of the bits in the XY_SUPPORTED field to 0

is_color_temperature_supported_set()

Returns

True if the value of COLOR_TEMPERATURE_SUPPORTED is non-zero

Return type

boolean

set_color_temperature_supported()

Set the value of the bit in the COLOR_TEMPERATURE_SUPPORTED field to 1

unset_color_temperature_supported()

Set the value of the bits in the COLOR_TEMPERATURE_SUPPORTED 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 ColorCapabilities(…) 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.ColorControl.ColorTempPhysicalMinMireds

ID: number

0x400B the ID of this attribute

NAME: str

“ColorTempPhysicalMinMireds” 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 ColorTempPhysicalMinMireds(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.ColorTempPhysicalMaxMireds

ID: number

0x400C the ID of this attribute

NAME: str

“ColorTempPhysicalMaxMireds” 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 ColorTempPhysicalMaxMireds(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.CoupleColorTempToLevelMinMireds

ID: number

0x400D the ID of this attribute

NAME: str

“CoupleColorTempToLevelMinMireds” 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 CoupleColorTempToLevelMinMireds(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.StartUpColorTemperatureMireds

ID: number

0x4010 the ID of this attribute

NAME: str

“StartUpColorTemperatureMireds” 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 StartUpColorTemperatureMireds(…) 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.ColorControl.NumberOfPrimaries

ID: number

0x0010 the ID of this attribute

NAME: str

“NumberOfPrimaries” 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 NumberOfPrimaries(…) 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.ColorControl.Primary1X

ID: number

0x0011 the ID of this attribute

NAME: str

“Primary1X” 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 Primary1X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary1Y

ID: number

0x0012 the ID of this attribute

NAME: str

“Primary1Y” 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 Primary1Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary1Intensity

ID: number

0x0013 the ID of this attribute

NAME: str

“Primary1Intensity” 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 Primary1Intensity(…) 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.ColorControl.Primary2X

ID: number

0x0015 the ID of this attribute

NAME: str

“Primary2X” 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 Primary2X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary2Y

ID: number

0x0016 the ID of this attribute

NAME: str

“Primary2Y” 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 Primary2Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary2Intensity

ID: number

0x0017 the ID of this attribute

NAME: str

“Primary2Intensity” 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 Primary2Intensity(…) 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.ColorControl.Primary3X

ID: number

0x0019 the ID of this attribute

NAME: str

“Primary3X” 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 Primary3X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary3Y

ID: number

0x001A the ID of this attribute

NAME: str

“Primary3Y” 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 Primary3Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary3Intensity

ID: number

0x001B the ID of this attribute

NAME: str

“Primary3Intensity” 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 Primary3Intensity(…) 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.ColorControl.Primary4X

ID: number

0x0020 the ID of this attribute

NAME: str

“Primary4X” 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 Primary4X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary4Y

ID: number

0x0021 the ID of this attribute

NAME: str

“Primary4Y” 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 Primary4Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary4Intensity

ID: number

0x0022 the ID of this attribute

NAME: str

“Primary4Intensity” 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 Primary4Intensity(…) 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.ColorControl.Primary5X

ID: number

0x0024 the ID of this attribute

NAME: str

“Primary5X” 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 Primary5X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary5Y

ID: number

0x0025 the ID of this attribute

NAME: str

“Primary5Y” 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 Primary5Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary5Intensity

ID: number

0x0026 the ID of this attribute

NAME: str

“Primary5Intensity” 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 Primary5Intensity(…) 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.ColorControl.Primary6X

ID: number

0x0028 the ID of this attribute

NAME: str

“Primary6X” 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 Primary6X(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary6Y

ID: number

0x0029 the ID of this attribute

NAME: str

“Primary6Y” 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 Primary6Y(…) 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

set_parent_cluster(cluster)

Parameters

cluster (any) –

class st.zigbee.zcl.clusters.ColorControl.Primary6Intensity

ID: number

0x002A the ID of this attribute

NAME: str

“Primary6Intensity” 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 Primary6Intensity(…) 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.ColorControl.WhitePointX

ID: number

0x0030 the ID of this attribute

NAME: str

“WhitePointX” 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 WhitePointX(…) 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.ColorControl.WhitePointY

ID: number

0x0031 the ID of this attribute

NAME: str

“WhitePointY” 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 WhitePointY(…) 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.ColorControl.ColorPointRX

ID: number

0x0032 the ID of this attribute

NAME: str

“ColorPointRX” 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 ColorPointRX(…) 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.ColorControl.ColorPointRY

ID: number

0x0033 the ID of this attribute

NAME: str

“ColorPointRY” 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 ColorPointRY(…) 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.ColorControl.ColorPointRIntensity

ID: number

0x0034 the ID of this attribute

NAME: str

“ColorPointRIntensity” 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 ColorPointRIntensity(…) 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.ColorControl.ColorPointGX

ID: number

0x0036 the ID of this attribute

NAME: str

“ColorPointGX” 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 ColorPointGX(…) 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.ColorControl.ColorPointGY

ID: number

0x0037 the ID of this attribute

NAME: str

“ColorPointGY” 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 ColorPointGY(…) 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.ColorControl.ColorPointGIntensity

ID: number

0x0038 the ID of this attribute

NAME: str

“ColorPointGIntensity” 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 ColorPointGIntensity(…) 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.ColorControl.ColorPointBX

ID: number

0x003A the ID of this attribute

NAME: str

“ColorPointBX” 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 ColorPointBX(…) 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.ColorControl.ColorPointBY

ID: number

0x003B the ID of this attribute

NAME: str

“ColorPointBY” 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 ColorPointBY(…) 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.ColorControl.ColorPointBIntensity

ID: number

0x003C the ID of this attribute

NAME: str

“ColorPointBIntensity” 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 ColorPointBIntensity(…) 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) –

ColorControl Commands

class st.zigbee.zcl.clusters.ColorControl.MoveToHue

ID: number

0x00 the ID of this command

NAME: str

“MoveToHue” the name of this command

hue: st.zigbee.data_types.Uint8

direction: st.zigbee.zcl.clusters.ColorControl.types.CcDirection

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveToHue

set_field_names()

static build_test_rx(device, hue, direction, transition_time, options_mask, options_override)

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

• hue (st.zigbee.data_types.Uint8) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcDirection) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, hue, direction, transition_time, options_mask, options_override)

Initialize the MoveToHue command

Parameters

• self (MoveToHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• hue (st.zigbee.data_types.Uint8) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcDirection) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveHue

ID: number

0x01 the ID of this command

NAME: str

“MoveHue” the name of this command

move_mode: st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode

rate: st.zigbee.data_types.Uint8

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveHue

set_field_names()

static build_test_rx(device, move_mode, rate, options_mask, options_override)

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

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, move_mode, rate, options_mask, options_override)

Initialize the MoveHue command

Parameters

• self (MoveHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.StepHue

ID: number

0x02 the ID of this command

NAME: str

“StepHue” the name of this command

step_mode: st.zigbee.zcl.clusters.ColorControl.types.CcStepMode

step_size: st.zigbee.data_types.Uint8

transition_time: st.zigbee.data_types.Uint8

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

StepHue

set_field_names()

static build_test_rx(device, step_mode, step_size, transition_time, options_mask, options_override)

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

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, step_mode, step_size, transition_time, options_mask, options_override)

Initialize the StepHue command

Parameters

• self (StepHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveToSaturation

ID: number

0x03 the ID of this command

NAME: str

“MoveToSaturation” the name of this command

saturation: st.zigbee.data_types.Uint8

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveToSaturation

set_field_names()

static build_test_rx(device, saturation, transition_time, options_mask, options_override)

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

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, saturation, transition_time, options_mask, options_override)

Initialize the MoveToSaturation command

Parameters

• self (MoveToSaturation) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveSaturation

ID: number

0x04 the ID of this command

NAME: str

“MoveSaturation” the name of this command

move_mode: st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode

rate: st.zigbee.data_types.Uint8

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveSaturation

set_field_names()

static build_test_rx(device, move_mode, rate, options_mask, options_override)

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

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, move_mode, rate, options_mask, options_override)

Initialize the MoveSaturation command

Parameters

• self (MoveSaturation) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.StepSaturation

ID: number

0x05 the ID of this command

NAME: str

“StepSaturation” the name of this command

step_mode: st.zigbee.zcl.clusters.ColorControl.types.CcStepMode

step_size: st.zigbee.data_types.Uint8

transition_time: st.zigbee.data_types.Uint8

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

StepSaturation

set_field_names()

static build_test_rx(device, step_mode, step_size, transition_time, options_mask, options_override)

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

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, step_mode, step_size, transition_time, options_mask, options_override)

Initialize the StepSaturation command

Parameters

• self (StepSaturation) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint8) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveToHueAndSaturation

ID: number

0x06 the ID of this command

NAME: str

“MoveToHueAndSaturation” the name of this command

hue: st.zigbee.data_types.Uint8

saturation: st.zigbee.data_types.Uint8

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveToHueAndSaturation

set_field_names()

static build_test_rx(device, hue, saturation, transition_time, options_mask, options_override)

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

• hue (st.zigbee.data_types.Uint8) –

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, hue, saturation, transition_time, options_mask, options_override)

Initialize the MoveToHueAndSaturation command

Parameters

• self (MoveToHueAndSaturation) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• hue (st.zigbee.data_types.Uint8) –

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveToColor

ID: number

0x07 the ID of this command

NAME: str

“MoveToColor” the name of this command

color_x: st.zigbee.data_types.Uint16

color_y: st.zigbee.data_types.Uint16

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveToColor

set_field_names()

static build_test_rx(device, color_x, color_y, transition_time, options_mask, options_override)

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

• color_x (st.zigbee.data_types.Uint16) –

• color_y (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, color_x, color_y, transition_time, options_mask, options_override)

Initialize the MoveToColor command

Parameters

• self (MoveToColor) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• color_x (st.zigbee.data_types.Uint16) –

• color_y (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveColor

ID: number

0x08 the ID of this command

NAME: str

“MoveColor” the name of this command

rate_x: st.zigbee.data_types.Int16

rate_y: st.zigbee.data_types.Int16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveColor

set_field_names()

static build_test_rx(device, rate_x, rate_y, options_mask, options_override)

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

• rate_x (st.zigbee.data_types.Int16) –

• rate_y (st.zigbee.data_types.Int16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, rate_x, rate_y, options_mask, options_override)

Initialize the MoveColor command

Parameters

• self (MoveColor) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• rate_x (st.zigbee.data_types.Int16) –

• rate_y (st.zigbee.data_types.Int16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.StepColor

ID: number

0x09 the ID of this command

NAME: str

“StepColor” the name of this command

step_x: st.zigbee.data_types.Int16

step_y: st.zigbee.data_types.Int16

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

StepColor

set_field_names()

static build_test_rx(device, step_x, step_y, transition_time, options_mask, options_override)

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

• step_x (st.zigbee.data_types.Int16) –

• step_y (st.zigbee.data_types.Int16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, step_x, step_y, transition_time, options_mask, options_override)

Initialize the StepColor command

Parameters

• self (StepColor) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• step_x (st.zigbee.data_types.Int16) –

• step_y (st.zigbee.data_types.Int16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveToColorTemperature

ID: number

0x0A the ID of this command

NAME: str

“MoveToColorTemperature” the name of this command

color_temperature_mireds: st.zigbee.data_types.Uint16

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveToColorTemperature

set_field_names()

static build_test_rx(device, color_temperature_mireds, transition_time, options_mask, options_override)

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

• color_temperature_mireds (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, color_temperature_mireds, transition_time, options_mask, options_override)

Initialize the MoveToColorTemperature command

Parameters

• self (MoveToColorTemperature) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• color_temperature_mireds (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.EnhancedMoveToHue

ID: number

0x40 the ID of this command

NAME: str

“EnhancedMoveToHue” the name of this command

enhanced_hue: st.zigbee.data_types.Uint16

direction: st.zigbee.zcl.clusters.ColorControl.types.CcDirection

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedMoveToHue

set_field_names()

static build_test_rx(device, enhanced_hue, direction, transition_time, options_mask, options_override)

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

• enhanced_hue (st.zigbee.data_types.Uint16) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcDirection) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, enhanced_hue, direction, transition_time, options_mask, options_override)

Initialize the EnhancedMoveToHue command

Parameters

• self (EnhancedMoveToHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• enhanced_hue (st.zigbee.data_types.Uint16) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcDirection) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.EnhancedMoveHue

ID: number

0x41 the ID of this command

NAME: str

“EnhancedMoveHue” the name of this command

move_mode: st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode

rate: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedMoveHue

set_field_names()

static build_test_rx(device, move_mode, rate, options_mask, options_override)

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

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, move_mode, rate, options_mask, options_override)

Initialize the EnhancedMoveHue command

Parameters

• self (EnhancedMoveHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.EnhancedStepHue

ID: number

0x42 the ID of this command

NAME: str

“EnhancedStepHue” the name of this command

step_mode: st.zigbee.zcl.clusters.ColorControl.types.CcStepMode

step_size: st.zigbee.data_types.Uint16

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedStepHue

set_field_names()

static build_test_rx(device, step_mode, step_size, transition_time, options_mask, options_override)

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

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, step_mode, step_size, transition_time, options_mask, options_override)

Initialize the EnhancedStepHue command

Parameters

• self (EnhancedStepHue) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.EnhancedMoveToHueAndSaturation

ID: number

0x43 the ID of this command

NAME: str

“EnhancedMoveToHueAndSaturation” the name of this command

enhanced_hue: st.zigbee.data_types.Uint16

saturation: st.zigbee.data_types.Uint8

transition_time: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedMoveToHueAndSaturation

set_field_names()

static build_test_rx(device, enhanced_hue, saturation, transition_time, options_mask, options_override)

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

• enhanced_hue (st.zigbee.data_types.Uint16) –

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, enhanced_hue, saturation, transition_time, options_mask, options_override)

Initialize the EnhancedMoveToHueAndSaturation command

Parameters

• self (EnhancedMoveToHueAndSaturation) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• enhanced_hue (st.zigbee.data_types.Uint16) –

• saturation (st.zigbee.data_types.Uint8) –

• transition_time (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.ColorLoopSet

ID: number

0x44 the ID of this command

NAME: str

“ColorLoopSet” the name of this command

update_flags: st.zigbee.zcl.clusters.ColorControl.types.UpdateFlags

action: st.zigbee.zcl.clusters.ColorControl.types.Action

direction: st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection

time: st.zigbee.data_types.Uint16

start_hue: st.zigbee.data_types.Uint16

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ColorLoopSet

set_field_names()

static build_test_rx(device, update_flags, action, direction, time, start_hue, options_mask, options_override)

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

• update_flags (st.zigbee.zcl.clusters.ColorControl.types.UpdateFlags) –

• action (st.zigbee.zcl.clusters.ColorControl.types.Action) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection) –

• time (st.zigbee.data_types.Uint16) –

• start_hue (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, update_flags, action, direction, time, start_hue, options_mask, options_override)

Initialize the ColorLoopSet command

Parameters

• self (ColorLoopSet) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• update_flags (st.zigbee.zcl.clusters.ColorControl.types.UpdateFlags) –

• action (st.zigbee.zcl.clusters.ColorControl.types.Action) –

• direction (st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection) –

• time (st.zigbee.data_types.Uint16) –

• start_hue (st.zigbee.data_types.Uint16) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.StopMoveStep

ID: number

0x47 the ID of this command

NAME: str

“StopMoveStep” the name of this command

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

StopMoveStep

set_field_names()

static build_test_rx(device, options_mask, options_override)

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

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, options_mask, options_override)

Initialize the StopMoveStep command

Parameters

• self (StopMoveStep) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.MoveColorTemperature

ID: number

0x4B the ID of this command

NAME: str

“MoveColorTemperature” the name of this command

move_mode: st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode

rate: st.zigbee.data_types.Uint16

color_temperature_minimum_mireds: st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField

color_temperature_maximum_mireds: st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

MoveColorTemperature

set_field_names()

static build_test_rx(device, move_mode, rate, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)

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

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint16) –

• color_temperature_minimum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField) –

• color_temperature_maximum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, move_mode, rate, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)

Initialize the MoveColorTemperature command

Parameters

• self (MoveColorTemperature) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• move_mode (st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode) –

• rate (st.zigbee.data_types.Uint16) –

• color_temperature_minimum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField) –

• color_temperature_maximum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

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.ColorControl.StepColorTemperature

ID: number

0x4C the ID of this command

NAME: str

“StepColorTemperature” the name of this command

step_mode: st.zigbee.zcl.clusters.ColorControl.types.CcStepMode

step_size: st.zigbee.data_types.Uint16

transition_time: st.zigbee.data_types.Uint16

color_temperature_minimum_mireds: st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField

color_temperature_maximum_mireds: st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField

options_mask: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

options_override: st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions

get_fields()

static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

StepColorTemperature

set_field_names()

static build_test_rx(device, step_mode, step_size, transition_time, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)

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

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• color_temperature_minimum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField) –

• color_temperature_maximum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, step_mode, step_size, transition_time, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)

Initialize the StepColorTemperature command

Parameters

• self (StepColorTemperature) – the template class for this command

• device (st.zigbee.Device) – the device to build this message to

• step_mode (st.zigbee.zcl.clusters.ColorControl.types.CcStepMode) –

• step_size (st.zigbee.data_types.Uint16) –

• transition_time (st.zigbee.data_types.Uint16) –

• color_temperature_minimum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField) –

• color_temperature_maximum_mireds (st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField) –

• options_mask (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

• options_override (st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters

cluster (any) –

ColorControl Types

class st.zigbee.zcl.clusters.ColorControl.types.CcColorOptions: st.zigbee.data_types.Bitmap8

byte_length: number

1

EXECUTE_IF_OFF: number

1

is_execute_if_off_set()

Returns

True if the value of EXECUTE_IF_OFF is non-zero

Return type

boolean

set_execute_if_off()

Set the value of the bit in the EXECUTE_IF_OFF field to 1

unset_execute_if_off()

Set the value of the bits in the EXECUTE_IF_OFF field to 0

class st.zigbee.zcl.clusters.ColorControl.types.CcDirection: st.zigbee.data_types.Enum8

byte_length: number

1

SHORTEST_DISTANCE: number

0

LONGEST_DISTANCE: number

1

UP: number

2

DOWN: number

3

class st.zigbee.zcl.clusters.ColorControl.types.CcMoveMode: st.zigbee.data_types.Enum8

byte_length: number

1

STOP: number

0

UP: number

1

DOWN: number

3

class st.zigbee.zcl.clusters.ColorControl.types.CcStepMode: st.zigbee.data_types.Enum8

byte_length: number

1

UP: number

1

DOWN: number

3

class st.zigbee.zcl.clusters.ColorControl.types.CcMinMiredsField: st.zigbee.data_types.Uint16

class st.zigbee.zcl.clusters.ColorControl.types.CcMaxMiredsField: st.zigbee.data_types.Uint16

class st.zigbee.zcl.clusters.ColorControl.types.CcColorLoopDirection: st.zigbee.data_types.Uint8

byte_length: number

1

DECREMENT_ENHANCED_CURRENT_HUE: number

0

INCREMENT_ENHANCED_CURRENT_HUE: number

1

class st.zigbee.zcl.clusters.ColorControl.types.UpdateFlags: st.zigbee.data_types.Bitmap8

byte_length: number

1

UPDATE_ACTION: number

1

UPDATE_DIRECTION: number

2

UPDATE_TIME: number

4

UPDATE_START_HUE: number

8

is_update_action_set()

Returns

True if the value of UPDATE_ACTION is non-zero

Return type

boolean

set_update_action()

Set the value of the bit in the UPDATE_ACTION field to 1

unset_update_action()

Set the value of the bits in the UPDATE_ACTION field to 0

is_update_direction_set()

Returns

True if the value of UPDATE_DIRECTION is non-zero

Return type

boolean

set_update_direction()

Set the value of the bit in the UPDATE_DIRECTION field to 1

unset_update_direction()

Set the value of the bits in the UPDATE_DIRECTION field to 0

is_update_time_set()

Returns

True if the value of UPDATE_TIME is non-zero

Return type

boolean

set_update_time()

Set the value of the bit in the UPDATE_TIME field to 1

unset_update_time()

Set the value of the bits in the UPDATE_TIME field to 0

is_update_start_hue_set()

Returns

True if the value of UPDATE_START_HUE is non-zero

Return type

boolean

set_update_start_hue()

Set the value of the bit in the UPDATE_START_HUE field to 1

unset_update_start_hue()

Set the value of the bits in the UPDATE_START_HUE field to 0

class st.zigbee.zcl.clusters.ColorControl.types.Action: st.zigbee.data_types.Enum8

byte_length: number

1

DEACTIVATE_COLOR_LOOP: number

0

ACTIVATE_COLOR_LOOP_FROM_COLOR_LOOP_START_ENHANCED_HUE: number

1

ACTIVATE_COLOR_LOOP_FROM_ENHANCED_CURRENT_HUE: number

2