Basic

class st.zigbee.zcl.clusters.Basic
ID: number

0x0000 the ID of this cluster

NAME: str

“Basic” the name of this cluster

attributes: st.zigbee.zcl.clusters.BasicServerAttributes or st.zigbee.zcl.clusters.BasicClientAttributes
commands: st.zigbee.zcl.clusters.BasicServerCommands or st.zigbee.zcl.clusters.BasicClientCommands
types: st.zigbee.zcl.clusters.BasicTypes

Basic Attributes

class st.zigbee.zcl.clusters.Basic.ZCLVersion
ID: number

0x0000 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.ApplicationVersion
ID: number

0x0001 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.StackVersion
ID: number

0x0002 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.HWVersion
ID: number

0x0003 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.ManufacturerName
ID: number

0x0004 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.ModelIdentifier
ID: number

0x0005 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.DateCode
ID: number

0x0006 the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.PowerSource
ID: number

0x0007 the ID of this attribute

NAME: str

“PowerSource” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

UNKNOWN: number

0

SINGLE_PHASE_MAINS: number

1

THREE_PHASE_MAINS: number

2

BATTERY: number

3

DC_SOURCE: number

4

EMERGENCY_MAINS_CONSTANTLY_POWERED: number

5

EMERGENCY_MAINS_AND_TRANSFER_SWITCH: number

6

UNKNOWN_WITH_BATTERY_BACKUP: number

128

SINGLE_PHASE_MAINS_WITH_BATTERY_BACKUP: number

129

THREE_PHASE_MAINS_WITH_BATTERY_BACKUP: number

130

BATTERY_WITH_BATTERY_BACKUP: number

131

DC_SOURCE_WITH_BATTERY_BACKUP: number

132

EMERGENCY_MAINS_CONSTANTLY_POWERED_WITH_BATTERY_BACKUP: number

133

EMERGENCY_MAINS_AND_TRANSFER_SWITCH_WITH_BATTERY_BACKUP: number

134

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:
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:
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 PowerSource(…) 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

class st.zigbee.zcl.clusters.Basic.GenericDeviceClass
ID: number

0x0008 the ID of this attribute

NAME: str

“GenericDeviceClass” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

LIGHTING: number

0

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

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

build_test_attr_report(device, data)

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

Parameters:
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:
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 GenericDeviceClass(…) 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

class st.zigbee.zcl.clusters.Basic.GenericDeviceType
ID: number

0x0009 the ID of this attribute

NAME: str

“GenericDeviceType” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

INCANDESCENT: number

0

SPOTLIGHT_HALOGEN: number

1

HALOGEN_BULB: number

2

CFL: number

3

LINEAR_FLUORESCENT: number

4

LED_BULB: number

5

SPOTLIGHT_LED: number

6

LED_STRIP: number

7

LED_TUBE: number

8

GENERIC_INDOOR_LUMINAIRE_OR_LIGHT_FIXTURE: number

9

GENERIC_OUTDOOR_LUMINAIRE_OR_LIGHT_FIXTURE: number

10

PENDANT_LUMINAIRE_OR_LIGHT_FIXTURE: number

11

FLOOR_STANDING_LUMINAIRE_OR_LIGHT_FIXTURE: number

12

GENERIC_CONTROLLER: number

224

WALL_SWITCH: number

225

PORTABLE_REMOTE_CONTROLLER: number

226

MOTION_SENSOR_OR_LIGHT_SENSOR: number

227

GENERIC_ACTUATOR: number

240

WALL_SOCKET: number

241

GATEWAY_OR_BRIDGE: number

242

PLUG_IN_UNIT: number

243

RETROFIT_ACTUATOR: number

244

UNSPECIFIED: number

255

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:
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:
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 GenericDeviceType(…) 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

class st.zigbee.zcl.clusters.Basic.ProductCode
ID: number

0x000A the ID of this attribute

NAME: str

“ProductCode” the name of this attribute

data_type: st.zigbee.data_types.OctetString

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:
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:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ProductCode(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.OctetString

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.OctetString) – The amount of change of the attribute to trigger a report

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

class st.zigbee.zcl.clusters.Basic.ProductURL
ID: number

0x000B the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.ManufacturerVersionDetails
ID: number

0x000C the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.SerialNumber
ID: number

0x000D the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.ProductLabel
ID: number

0x000E the ID of this attribute

NAME: str

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

class st.zigbee.zcl.clusters.Basic.LocationDescription
ID: number

0x0010 the ID of this attribute

NAME: str

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

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.Basic.PhysicalEnvironment
ID: number

0x0011 the ID of this attribute

NAME: str

“PhysicalEnvironment” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

UNSPECIFIED_ENVIRONMENT: number

0

DEPRECATED: number

1

BAR: number

2

COURTYARD: number

3

BATHROOM: number

4

BEDROOM: number

5

BILLIARD_ROOM: number

6

UTILITY_ROOM: number

7

CELLAR: number

8

STORAGE_CLOSET: number

9

THEATER: number

10

OFFICE: number

11

DECK: number

12

DEN: number

13

DINING_ROOM: number

14

ELECTRICAL_ROOM: number

15

ELEVATOR: number

16

ENTRY: number

17

FAMILY_ROOM: number

18

MAIN_FLOOR: number

19

UPSTAIRS: number

20

DOWNSTAIRS: number

21

BASEMENT_LOWER_LEVEL: number

22

GALLERY: number

23

GAME_ROOM: number

24

GARAGE: number

25

GYM: number

26

HALLWAY: number

27

HOUSE: number

28

KITCHEN: number

29

LAUNDRY_ROOM: number

30

LIBRARY: number

31

MASTER_BEDROOM: number

32

MUD_ROOM: number

33

NURSERY: number

34

PANTRY: number

35

OFFICE: number

36

OUTSIDE: number

37

POOL: number

38

PORCH: number

39

SEWING_ROOM: number

40

SITTING_ROOM: number

41

STAIRWAY: number

42

YARD: number

43

ATTIC: number

44

HOT_TUB: number

45

LIVING_ROOM: number

46

SAUNA: number

47

SHOP_OR_WORKSHOP: number

48

GUEST_BEDROOM: number

49

GUEST_BATH: number

50

POWDER_ROOM: number

51

BACK_YARD: number

52

FRONT_YARD: number

53

PATIO: number

54

DRIVEWAY: number

55

SUN_ROOM: number

56

LIVING_ROOM: number

57

SPA: number

58

WHIRLPOOL: number

59

SHED: number

60

EQUIPMENT_STORAGE: number

61

HOBBY_OR_CRAFT_ROOM: number

62

FOUNTAIN: number

63

POND: number

64

RECEPTION_ROOM: number

65

BREAKFAST_ROOM: number

66

NOOK: number

67

GARDEN: number

68

BALCONY: number

69

PANIC_ROOM: number

70

TERRACE: number

71

ROOF: number

72

TOILET: number

73

TOILET_MAIN: number

74

OUTSIDE_TOILET: number

75

SHOWER_ROOM: number

76

STUDY: number

77

FRONT_GARDEN: number

78

BACK_GARDEN: number

79

KETTLE: number

80

TELEVISION: number

81

STOVE: number

82

MICROWAVE: number

83

TOASTER: number

84

VACUUM: number

85

APPLIANCE: number

86

FRONT_DOOR: number

87

BACK_DOOR: number

88

FRIDGE_DOOR: number

89

MEDICATION_CABINET_DOOR: number

96

WARDROBE_DOOR: number

97

FRONT_CUPBOARD_DOOR: number

98

OTHER_DOOR: number

99

WAITING_ROOM: number

100

TRIAGE_ROOM: number

101

DOCTORS_OFFICE: number

102

PATIENTS_PRIVATE_ROOM: number

103

CONSULTATION_ROOM: number

104

NURSE_STATION: number

105

WARD: number

106

CORRIDOR: number

107

OPERATING_THEATRE: number

108

DENTAL_SURGERY_ROOM: number

109

MEDICAL_IMAGING_ROOM: number

110

DECONTAMINATION_ROOM: number

111

ATRIUM: number

112

MIRROR: number

113

UNKNOWN_ENVIRONMENT: number

255

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:
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:
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 PhysicalEnvironment(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Enum8

read(device)

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

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters:

  • device (st.zigbee.Device)

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

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

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.Basic.DeviceEnabled
ID: number

0x0012 the ID of this attribute

NAME: str

“DeviceEnabled” the name of this attribute

data_type: st.zigbee.data_types.Boolean

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:
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:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the DeviceEnabled(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Boolean

read(device)

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

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters:

  • device (st.zigbee.Device)

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

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

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.Basic.AlarmMask
ID: number

0x0013 the ID of this attribute

NAME: str

“AlarmMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

GENERAL_HARDWARE_FAULT: number

1

GENERAL_SOFTWARE_FAULT: number

2

is_general_hardware_fault_set()
Returns:

True if the value of GENERAL_HARDWARE_FAULT is non-zero

Return type:

boolean

set_general_hardware_fault()

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

unset_general_hardware_fault()

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

is_general_software_fault_set()
Returns:

True if the value of GENERAL_SOFTWARE_FAULT is non-zero

Return type:

boolean

set_general_software_fault()

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

unset_general_software_fault()

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

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

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

build_test_attr_report(device, data)

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

Parameters:
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:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the AlarmMask(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Bitmap8

read(device)

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

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters:

  • device (st.zigbee.Device)

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

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

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.Basic.DisableLocalConfig
ID: number

0x0014 the ID of this attribute

NAME: str

“DisableLocalConfig” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

DISABLE_RESET_TO_FACTORY_DEFAULTS: number

1

DISABLE_DEVICE_CONFIGURATION: number

2

is_disable_reset_to_factory_defaults_set()
Returns:

True if the value of DISABLE_RESET_TO_FACTORY_DEFAULTS is non-zero

Return type:

boolean

set_disable_reset_to_factory_defaults()

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

unset_disable_reset_to_factory_defaults()

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

is_disable_device_configuration_set()
Returns:

True if the value of DISABLE_DEVICE_CONFIGURATION is non-zero

Return type:

boolean

set_disable_device_configuration()

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

unset_disable_device_configuration()

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

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters:

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

build_test_attr_report(device, data)

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

Parameters:
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:
Returns:

containing an ReadAttributeResponse body

Return type:

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the DisableLocalConfig(…) syntax

Parameters:

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

Return type:

st.zigbee.data_types.Bitmap8

read(device)

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

Parameters:

device (st.zigbee.Device)

Returns:

containing a ReadAttribute body

Return type:

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters:

  • device (st.zigbee.Device)

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

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

Returns:

containing a ConfigureReporting body

Return type:

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters:
class st.zigbee.zcl.clusters.Basic.SWBuildID
ID: number

0x4000 the ID of this attribute

NAME: str

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

Basic Commands

class st.zigbee.zcl.clusters.Basic.ResetToFactoryDefaults
ID: number

0x00 the ID of this command

NAME: str

“ResetToFactoryDefaults” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters:

buf (buf) – the bytes of the command body

Return type:

ResetToFactoryDefaults

set_field_names()
static build_test_rx(device)

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

Parameters:

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

Returns:

The full Zigbee message containing this command body

Return type:

st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the ResetToFactoryDefaults command

Parameters:

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

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

Returns:

the full command addressed to the device

Return type:

st.zigbee.ZigbeeMessageTx