OTAUpgrade

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

0x0019 the ID of this cluster

NAME: str

“OTAUpgrade” the name of this cluster

attributes: st.zigbee.zcl.clusters.OTAUpgradeServerAttributes or st.zigbee.zcl.clusters.OTAUpgradeClientAttributes
commands: st.zigbee.zcl.clusters.OTAUpgradeServerCommands or st.zigbee.zcl.clusters.OTAUpgradeClientCommands
types: st.zigbee.zcl.clusters.OTAUpgradeTypes

OTAUpgrade Attributes

class st.zigbee.zcl.clusters.OTAUpgrade.UpgradeServerID
ID: number

0x0000 the ID of this attribute

NAME: str

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

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.FileOffset
ID: number

0x0001 the ID of this attribute

NAME: str

“FileOffset” the name of this attribute

data_type: st.zigbee.data_types.Uint32

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

This is also usable with the FileOffset(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Uint32

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.Uint32) – 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.OTAUpgrade.CurrentFileVersion
ID: number

0x0002 the ID of this attribute

NAME: str

“CurrentFileVersion” the name of this attribute

data_type: st.zigbee.data_types.Uint32

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

This is also usable with the CurrentFileVersion(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Uint32

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.Uint32) – 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.OTAUpgrade.CurrentZigBeeStackVersion
ID: number

0x0003 the ID of this attribute

NAME: str

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

Parameters

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

Return type

st.zigbee.data_types.Uint16

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

  • device (st.zigbee.Device) –

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

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

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.DownloadedFileVersion
ID: number

0x0004 the ID of this attribute

NAME: str

“DownloadedFileVersion” the name of this attribute

data_type: st.zigbee.data_types.Uint32

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

This is also usable with the DownloadedFileVersion(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Uint32

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.Uint32) – 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.OTAUpgrade.DownloadedZigBeeStackVersion
ID: number

0x0005 the ID of this attribute

NAME: str

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

Parameters

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

Return type

st.zigbee.data_types.Uint16

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

  • device (st.zigbee.Device) –

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

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

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.ImageUpgradeStatus
ID: number

0x0006 the ID of this attribute

NAME: str

“ImageUpgradeStatus” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

NORMAL: number

0

DOWNLOAD_IN_PROGRESS: number

1

DOWNLOAD_COMPLETE: number

2

WAITING_TO_UPGRADE: number

3

COUNT_DOWN: number

4

WAIT_FOR_MORE: number

5

WAITING_TO_UPGRADE_VIA_EXTERNAL_EVENT: number

6

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

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

build_test_attr_report(device, data)

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

Parameters
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 ImageUpgradeStatus(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Enum8

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters

  • device (st.zigbee.Device) –

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

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.ManufacturerID
ID: number

0x0007 the ID of this attribute

NAME: str

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

Parameters

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

Return type

st.zigbee.data_types.Uint16

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

  • device (st.zigbee.Device) –

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

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

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.ImageTypeID
ID: number

0x0008 the ID of this attribute

NAME: str

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

Parameters

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

Return type

st.zigbee.data_types.Uint16

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

  • device (st.zigbee.Device) –

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

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

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.MinimumBlockPeriod
ID: number

0x0009 the ID of this attribute

NAME: str

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

Parameters

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

Return type

st.zigbee.data_types.Uint16

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

  • device (st.zigbee.Device) –

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

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

  • rep_change (st.zigbee.data_types.Uint16) – The amount of change of the attribute to trigger a report

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.ImageStamp
ID: number

0x000A the ID of this attribute

NAME: str

“ImageStamp” the name of this attribute

data_type: st.zigbee.data_types.Uint32

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

This is also usable with the ImageStamp(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Uint32

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.Uint32) – 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.OTAUpgrade.UpgradeActivationPolicy
ID: number

0x000B the ID of this attribute

NAME: str

“UpgradeActivationPolicy” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

OTA_SERVER_ACTIVATION_ALLOWED: number

0

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

Parameters

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

Return type

st.zigbee.data_types.Enum8

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters

  • device (st.zigbee.Device) –

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

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

class st.zigbee.zcl.clusters.OTAUpgrade.UpgradeTimeoutPolicy
ID: number

0x000C the ID of this attribute

NAME: str

“UpgradeTimeoutPolicy” the name of this attribute

data_type: st.zigbee.data_types.Enum8

the data type of this attribute

APPLY_UPGRADE_AFTER_TIMEOUT: number

0

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

Parameters

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

Return type

st.zigbee.data_types.Enum8

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters

  • device (st.zigbee.Device) –

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

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

OTAUpgrade Commands

class st.zigbee.zcl.clusters.OTAUpgrade.ImageNotify
ID: number

0x00 the ID of this command

NAME: str

“ImageNotify” the name of this command

payload_type: st.zigbee.zcl.clusters.OTAUpgrade.types.PayloadType
query_jitter: st.zigbee.data_types.Uint8
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.data_types.Uint16
new_file_version: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ImageNotify

set_field_names()
static build_test_rx(device, payload_type, query_jitter, manufacturer_code, image_type, new_file_version)

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, payload_type, query_jitter, manufacturer_code, image_type, new_file_version)

Initialize the ImageNotify 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.OTAUpgrade.QueryNextImageResponse
ID: number

0x02 the ID of this command

NAME: str

“QueryNextImageResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
image_size: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

QueryNextImageResponse

set_field_names()
static build_test_rx(device, status, manufacturer_code, image_type, file_version, image_size)

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, status, manufacturer_code, image_type, file_version, image_size)

Initialize the QueryNextImageResponse 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.OTAUpgrade.ImageBlockResponse
ID: number

0x05 the ID of this command

NAME: str

“ImageBlockResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
file_offset: st.zigbee.data_types.Uint32
image_data: st.zigbee.data_types.OctetString
current_time: st.zigbee.data_types.Uint32
request_time: st.zigbee.data_types.Uint32
minimum_block_period: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ImageBlockResponse

set_field_names()
static build_test_rx(device, status, manufacturer_code, image_type, file_version, file_offset, image_data, current_time, request_time, minimum_block_period)

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, status, manufacturer_code, image_type, file_version, file_offset, image_data, current_time, request_time, minimum_block_period)

Initialize the ImageBlockResponse 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.OTAUpgrade.UpgradeEndResponse
ID: number

0x07 the ID of this command

NAME: str

“UpgradeEndResponse” the name of this command

manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
current_time: st.zigbee.data_types.UtcTime
upgrade_time: st.zigbee.data_types.UtcTime
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

UpgradeEndResponse

set_field_names()
static build_test_rx(device, manufacturer_code, image_type, file_version, current_time, upgrade_time)

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, manufacturer_code, image_type, file_version, current_time, upgrade_time)

Initialize the UpgradeEndResponse 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.OTAUpgrade.QueryDeviceSpecificFileResponse
ID: number

0x09 the ID of this command

NAME: str

“QueryDeviceSpecificFileResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeIdDeviceSpecific
file_version: st.zigbee.data_types.Uint32
image_size: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

QueryDeviceSpecificFileResponse

set_field_names()
static build_test_rx(device, status, manufacturer_code, image_type, file_version, image_size)

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, status, manufacturer_code, image_type, file_version, image_size)

Initialize the QueryDeviceSpecificFileResponse 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.OTAUpgrade.QueryNextImageRequest
ID: number

0x01 the ID of this command

NAME: str

“QueryNextImageRequest” the name of this command

field_control: st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
current_file_version: st.zigbee.data_types.Uint32
hardware_version: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

QueryNextImageRequest

set_field_names()
static build_test_rx(device, field_control, manufacturer_code, image_type, current_file_version, hardware_version)

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, field_control, manufacturer_code, image_type, current_file_version, hardware_version)

Initialize the QueryNextImageRequest 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.OTAUpgrade.ImageBlockRequest
ID: number

0x03 the ID of this command

NAME: str

“ImageBlockRequest” the name of this command

field_control: st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
file_offset: st.zigbee.data_types.Uint32
maximum_data_size: st.zigbee.data_types.Uint8
request_node_address: st.zigbee.data_types.IeeeAddress
minimum_block_period: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ImageBlockRequest

set_field_names()
static build_test_rx(device, field_control, manufacturer_code, image_type, file_version, file_offset, maximum_data_size, request_node_address, minimum_block_period)

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, field_control, manufacturer_code, image_type, file_version, file_offset, maximum_data_size, request_node_address, minimum_block_period)

Initialize the ImageBlockRequest 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.OTAUpgrade.ImagePageRequest
ID: number

0x04 the ID of this command

NAME: str

“ImagePageRequest” the name of this command

field_control: st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
file_offset: st.zigbee.data_types.Uint32
maximum_data_size: st.zigbee.data_types.Uint8
page_size: st.zigbee.data_types.Uint16
response_spacing: st.zigbee.data_types.Uint16
request_node_address: st.zigbee.data_types.IeeeAddress
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ImagePageRequest

set_field_names()
static build_test_rx(device, field_control, manufacturer_code, image_type, file_version, file_offset, maximum_data_size, page_size, response_spacing, request_node_address)

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, field_control, manufacturer_code, image_type, file_version, file_offset, maximum_data_size, page_size, response_spacing, request_node_address)

Initialize the ImagePageRequest 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.OTAUpgrade.UpgradeEndRequest
ID: number

0x06 the ID of this command

NAME: str

“UpgradeEndRequest” the name of this command

status: st.zigbee.data_types.ZclStatus
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId
file_version: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

UpgradeEndRequest

set_field_names()
static build_test_rx(device, status, manufacturer_code, image_type, file_version)

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, status, manufacturer_code, image_type, file_version)

Initialize the UpgradeEndRequest 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.OTAUpgrade.QueryDeviceSpecificFileRequest
ID: number

0x08 the ID of this command

NAME: str

“QueryDeviceSpecificFileRequest” the name of this command

request_node_address: st.zigbee.data_types.IeeeAddress
manufacturer_code: st.zigbee.data_types.Uint16
image_type: st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeIdDeviceSpecific
file_version: st.zigbee.data_types.Uint32
current_zigbee_stack_version: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

QueryDeviceSpecificFileRequest

set_field_names()
static build_test_rx(device, request_node_address, manufacturer_code, image_type, file_version, current_zigbee_stack_version)

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, request_node_address, manufacturer_code, image_type, file_version, current_zigbee_stack_version)

Initialize the QueryDeviceSpecificFileRequest command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

OTAUpgrade Types

class st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeId: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.OTAUpgrade.types.ImageTypeIdDeviceSpecific: st.zigbee.data_types.Uint16
byte_length: number

2

CLIENT_SECURITY_CREDENTIALS: number

65472

CLIENT_CONFIGURATION: number

65473

SERVER_LOG: number

65474

PICTURE: number

65475

class st.zigbee.zcl.clusters.OTAUpgrade.types.PayloadType: st.zigbee.data_types.Enum8
byte_length: number

1

QUERY_JITTER: number

0

QUERY_JITTER_AND_MANUFACTURER_CODE: number

1

QUERY_JITTER_MANUFACTURER_CODE_AND_IMAGE_TYPE: number

2

QUERY_JITTER_MANUFACTURER_CODE_IMAGE_TYPE_AND_NEW_FILE_VERSION: number

3

class st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl: st.zigbee.data_types.Bitmap8
byte_length: number

1

REQUEST_NODE_IEEE_ADDRESS_PRESENT: number

1

is_request_node_ieee_address_present_set()
Returns

True if the value of REQUEST_NODE_IEEE_ADDRESS_PRESENT is non-zero

Return type

boolean

set_request_node_ieee_address_present()

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

unset_request_node_ieee_address_present()

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

class st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl: st.zigbee.data_types.Bitmap8
byte_length: number

1

REQUEST_NODE_IEEE_ADDRESS_PRESENT: number

1

is_request_node_ieee_address_present_set()
Returns

True if the value of REQUEST_NODE_IEEE_ADDRESS_PRESENT is non-zero

Return type

boolean

set_request_node_ieee_address_present()

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

unset_request_node_ieee_address_present()

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

class st.zigbee.zcl.clusters.OTAUpgrade.types.FieldControl: st.zigbee.data_types.Bitmap8
byte_length: number

1

REQUEST_NODE_IEEE_ADDRESS_PRESENT: number

1

is_request_node_ieee_address_present_set()
Returns

True if the value of REQUEST_NODE_IEEE_ADDRESS_PRESENT is non-zero

Return type

boolean

set_request_node_ieee_address_present()

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

unset_request_node_ieee_address_present()

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