Commissioning

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

0x0015 the ID of this cluster

NAME: str

“Commissioning” the name of this cluster

attributes: st.zigbee.zcl.clusters.CommissioningServerAttributes or st.zigbee.zcl.clusters.CommissioningClientAttributes
commands: st.zigbee.zcl.clusters.CommissioningServerCommands or st.zigbee.zcl.clusters.CommissioningClientCommands
types: st.zigbee.zcl.clusters.CommissioningTypes

Commissioning Attributes

class st.zigbee.zcl.clusters.Commissioning.ShortAddress
ID: number

0x0000 the ID of this attribute

NAME: str

“ShortAddress” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the ShortAddress(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ExtendedPANId
ID: number

0x0001 the ID of this attribute

NAME: str

“ExtendedPANId” the name of this attribute

data_type: st.zigbee.data_types.IeeeAddress

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 IeeeAddress object of this attribute with any additional features provided for the attribute

This is also usable with the ExtendedPANId(…) syntax

Parameters

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

Return type

st.zigbee.data_types.IeeeAddress

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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.PANId
ID: number

0x0002 the ID of this attribute

NAME: str

“PANId” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the PANId(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ChannelMask
ID: number

0x0003 the ID of this attribute

NAME: str

“ChannelMask” the name of this attribute

data_type: st.zigbee.data_types.Bitmap32

the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

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

build_test_attr_report(device, data)

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

Parameters
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 Bitmap32 object of this attribute with any additional features provided for the attribute

This is also usable with the ChannelMask(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Bitmap32

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters

  • device (st.zigbee.Device) –

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

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ProtocolVersion
ID: number

0x0004 the ID of this attribute

NAME: str

“ProtocolVersion” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

ZIGBEE2006OR_LATER: number

2

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
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 ProtocolVersion(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.StackProfile
ID: number

0x0005 the ID of this attribute

NAME: str

“StackProfile” the name of this attribute

data_type: st.zigbee.data_types.Uint8

the data type of this attribute

ZIGBEE_STACK_PROFILE: number

1

ZIGBEE_PRO_STACK_PROFILE: number

2

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
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 StackProfile(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.StartupControl
ID: number

0x0006 the ID of this attribute

NAME: str

“StartupControl” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

ON_A_NETWORK: number

0

FORM_NETWORK: number

1

REJOIN_NETWORK: number

2

JOIN_USING_MAC_ASSOCIATION: 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
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 StartupControl(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.TrustCenterAddress
ID: number

0x0010 the ID of this attribute

NAME: str

“TrustCenterAddress” the name of this attribute

data_type: st.zigbee.data_types.IeeeAddress

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 IeeeAddress object of this attribute with any additional features provided for the attribute

This is also usable with the TrustCenterAddress(…) syntax

Parameters

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

Return type

st.zigbee.data_types.IeeeAddress

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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.TrustCenterMasterKey
ID: number

0x0011 the ID of this attribute

NAME: str

“TrustCenterMasterKey” the name of this attribute

data_type: st.zigbee.zcl.clusters.Commissioning.types.CsKey

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 CsKeyType object of this attribute with any additional features provided for the attribute

This is also usable with the TrustCenterMasterKey(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.Commissioning.types.CsKey

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.Commissioning.types.CsKey) – 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.NetworkKey
ID: number

0x0012 the ID of this attribute

NAME: str

“NetworkKey” the name of this attribute

data_type: st.zigbee.zcl.clusters.Commissioning.types.CsKey

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 CsKeyType object of this attribute with any additional features provided for the attribute

This is also usable with the NetworkKey(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.Commissioning.types.CsKey

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.Commissioning.types.CsKey) – 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.UseInsecureJoin
ID: number

0x0013 the ID of this attribute

NAME: str

“UseInsecureJoin” 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 UseInsecureJoin(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.PreconfiguredLinkKey
ID: number

0x0014 the ID of this attribute

NAME: str

“PreconfiguredLinkKey” the name of this attribute

data_type: st.zigbee.zcl.clusters.Commissioning.types.CsKey

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 CsKeyType object of this attribute with any additional features provided for the attribute

This is also usable with the PreconfiguredLinkKey(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.Commissioning.types.CsKey

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.Commissioning.types.CsKey) – 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.NetworkKeySeqNum
ID: number

0x0015 the ID of this attribute

NAME: str

“NetworkKeySeqNum” 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 NetworkKeySeqNum(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.NetworkKeyType
ID: number

0x0016 the ID of this attribute

NAME: str

“NetworkKeyType” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

STANDARD_KEY: number

1

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

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

build_test_attr_report(device, data)

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

Parameters
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 NetworkKeyType(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.NetworkManagerAddress
ID: number

0x0017 the ID of this attribute

NAME: str

“NetworkManagerAddress” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the NetworkManagerAddress(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ScanAttempts
ID: number

0x0020 the ID of this attribute

NAME: str

“ScanAttempts” 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 ScanAttempts(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.TimeBetweenScans
ID: number

0x0021 the ID of this attribute

NAME: str

“TimeBetweenScans” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the TimeBetweenScans(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.RejoinInterval
ID: number

0x0022 the ID of this attribute

NAME: str

“RejoinInterval” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the RejoinInterval(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.MaxRejoinInterval
ID: number

0x0023 the ID of this attribute

NAME: str

“MaxRejoinInterval” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the MaxRejoinInterval(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.IndirectPollRate
ID: number

0x0030 the ID of this attribute

NAME: str

“IndirectPollRate” 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
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 Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the IndirectPollRate(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ParentRetryThreshold
ID: number

0x0031 the ID of this attribute

NAME: str

“ParentRetryThreshold” 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 ParentRetryThreshold(…) 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.Commissioning.ConcentratorFlag
ID: number

0x0040 the ID of this attribute

NAME: str

“ConcentratorFlag” 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 ConcentratorFlag(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ConcentratorRadius
ID: number

0x0041 the ID of this attribute

NAME: str

“ConcentratorRadius” 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 ConcentratorRadius(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.Commissioning.ConcentratorDiscoveryTime
ID: number

0x0042 the ID of this attribute

NAME: str

“ConcentratorDiscoveryTime” 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 ConcentratorDiscoveryTime(…) 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
set_parent_cluster(cluster)
Parameters

cluster (any) –

Commissioning Commands

class st.zigbee.zcl.clusters.Commissioning.RestartDeviceResponse
ID: number

0x00 the ID of this command

NAME: str

“RestartDeviceResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RestartDeviceResponse

set_field_names()
static build_test_rx(device, status)

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

  • status (st.zigbee.data_types.ZclStatus) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the RestartDeviceResponse command

Parameters

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

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

  • status (st.zigbee.data_types.ZclStatus) –

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.Commissioning.SaveStartupParametersResponse
ID: number

0x01 the ID of this command

NAME: str

“SaveStartupParametersResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

SaveStartupParametersResponse

set_field_names()
static build_test_rx(device, status)

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

  • status (st.zigbee.data_types.ZclStatus) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the SaveStartupParametersResponse command

Parameters

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

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

  • status (st.zigbee.data_types.ZclStatus) –

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.Commissioning.RestoreStartupParametersResponse
ID: number

0x02 the ID of this command

NAME: str

“RestoreStartupParametersResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RestoreStartupParametersResponse

set_field_names()
static build_test_rx(device, status)

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

  • status (st.zigbee.data_types.ZclStatus) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the RestoreStartupParametersResponse command

Parameters

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

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

  • status (st.zigbee.data_types.ZclStatus) –

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.Commissioning.ResetStartupParametersResponse
ID: number

0x03 the ID of this command

NAME: str

“ResetStartupParametersResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ResetStartupParametersResponse

set_field_names()
static build_test_rx(device, status)

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

  • status (st.zigbee.data_types.ZclStatus) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, status)

Initialize the ResetStartupParametersResponse command

Parameters

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

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

  • status (st.zigbee.data_types.ZclStatus) –

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.Commissioning.RestartDevice
ID: number

0x00 the ID of this command

NAME: str

“RestartDevice” the name of this command

options: st.zigbee.zcl.clusters.Commissioning.types.Options
delay: st.zigbee.data_types.Uint8
jitter: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RestartDevice

set_field_names()
static build_test_rx(device, options, delay, jitter)

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

Parameters
Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, options, delay, jitter)

Initialize the RestartDevice command

Parameters
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.Commissioning.SaveStartupParameters
ID: number

0x01 the ID of this command

NAME: str

“SaveStartupParameters” the name of this command

options: st.zigbee.data_types.Bitmap8
index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

SaveStartupParameters

set_field_names()
static build_test_rx(device, options, index)

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

Parameters
Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, options, index)

Initialize the SaveStartupParameters command

Parameters
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.Commissioning.RestoreStartupParameters
ID: number

0x02 the ID of this command

NAME: str

“RestoreStartupParameters” the name of this command

options: st.zigbee.data_types.Bitmap8
index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RestoreStartupParameters

set_field_names()
static build_test_rx(device, options, index)

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

Parameters
Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, options, index)

Initialize the RestoreStartupParameters command

Parameters
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.Commissioning.ResetStartupParameters
ID: number

0x03 the ID of this command

NAME: str

“ResetStartupParameters” the name of this command

options: st.zigbee.zcl.clusters.Commissioning.types.Options
index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ResetStartupParameters

set_field_names()
static build_test_rx(device, options, index)

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

Parameters
Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, options, index)

Initialize the ResetStartupParameters command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

Commissioning Types

class st.zigbee.zcl.clusters.Commissioning.types.CsKey: st.zigbee.data_types.Seckey128
class st.zigbee.zcl.clusters.Commissioning.types.Options: st.zigbee.data_types.Bitmap8
byte_length: number

1

RESET_CURRENT: number

1

RESET_ALL: number

2

ERASE_INDEX: number

4

is_reset_current_set()
Returns

True if the value of RESET_CURRENT is non-zero

Return type

boolean

set_reset_current()

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

unset_reset_current()

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

is_reset_all_set()
Returns

True if the value of RESET_ALL is non-zero

Return type

boolean

set_reset_all()

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

unset_reset_all()

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

is_erase_index_set()
Returns

True if the value of ERASE_INDEX is non-zero

Return type

boolean

set_erase_index()

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

unset_erase_index()

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

class st.zigbee.zcl.clusters.Commissioning.types.StartupMode: st.zigbee.data_types.Enum8
byte_length: number

1

RESTART_USING_STARTUP_PARAMETERS: number

0

RESTART_USING_CURRENT_STATE: number

1

class st.zigbee.zcl.clusters.Commissioning.types.Options: st.zigbee.data_types.Bitmap8
byte_length: number

1

RESET_CURRENT: number

1

RESET_ALL: number

2

ERASE_INDEX: number

4

is_reset_current_set()
Returns

True if the value of RESET_CURRENT is non-zero

Return type

boolean

set_reset_current()

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

unset_reset_current()

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

is_reset_all_set()
Returns

True if the value of RESET_ALL is non-zero

Return type

boolean

set_reset_all()

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

unset_reset_all()

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

is_erase_index_set()
Returns

True if the value of ERASE_INDEX is non-zero

Return type

boolean

set_erase_index()

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

unset_erase_index()

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