IASZone

class st.zigbee.zcl.clusters.IASZone

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

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

attributes: st.zigbee.zcl.clusters.IASZoneServerAttributes or st.zigbee.zcl.clusters.IASZoneClientAttributes

commands: st.zigbee.zcl.clusters.IASZoneServerCommands or st.zigbee.zcl.clusters.IASZoneClientCommands

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

IASZone Attributes

class st.zigbee.zcl.clusters.IASZone.ZoneState

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

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

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

NOT_ENROLLED: number: 0

ENROLLED: number: 1

augment_type(base_type_obj)

Add additional functionality to the base type object

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

build_test_attr_report(device, data)

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

Parameters

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

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

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

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ZoneState(…) 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.IASZone.ZoneType

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

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

data_type: st.zigbee.zcl.types.IasZoneType: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

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

Parameters

device (st.zigbee.Device) –
data (st.zigbee.zcl.types.IasZoneType) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

device (st.zigbee.Device) –
data (st.zigbee.zcl.types.IasZoneType) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ZoneType(…) syntax

Parameters: vararg (vararg) – the values needed to construct a IasZoneType
Return type: st.zigbee.zcl.types.IasZoneType

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.types.IasZoneType) – 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.IASZone.ZoneStatus

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

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

data_type: st.zigbee.zcl.types.IasZoneStatus: the data type of this attribute

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

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

Parameters

device (st.zigbee.Device) –
data (st.zigbee.zcl.types.IasZoneStatus) – the attribute value

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

device (st.zigbee.Device) –
data (st.zigbee.zcl.types.IasZoneStatus) – the attribute value

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ZoneStatus(…) syntax

Parameters: vararg (vararg) – the values needed to construct a IasZoneStatus
Return type: st.zigbee.zcl.types.IasZoneStatus

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.types.IasZoneStatus) – 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.IASZone.IASCIEAddress

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

NAME: str: “IASCIEAddress” 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

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

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

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

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 IASCIEAddress(…) 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

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

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IASZone.ZoneID

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

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

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

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

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

Parameters

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

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

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

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the ZoneID(…) 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.IASZone.NumberOfZoneSensitivityLevelsSupported

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

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

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

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

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

Parameters

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

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

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

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the NumberOfZoneSensitivityLevelsSupported(…) 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.IASZone.CurrentZoneSensitivityLevel

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

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

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

augment_type(base_type_obj)

Parameters: base_type_obj (any) –

build_test_attr_report(device, data)

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

Parameters

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

Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters

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

Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the CurrentZoneSensitivityLevel(…) syntax

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

read(device)

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

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

configure_reporting(device, min_rep_int, max_rep_int, rep_change)

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

Parameters

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

write(device, value)

Write a value to this attribute on a device

Parameters

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

set_parent_cluster(cluster)

Parameters: cluster (any) –

IASZone Commands

class st.zigbee.zcl.clusters.IASZone.ZoneStatusChangeNotification

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

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

zone_status: st.zigbee.data_types.IasZoneStatus

extended_status: st.zigbee.data_types.Bitmap8

zone_id: st.zigbee.data_types.Uint8

delay: st.zigbee.data_types.Uint16

get_fields()

static deserialize(buf)

Deserialize this command

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

set_field_names()

static build_test_rx(device, zone_status, extended_status, zone_id, delay)

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
zone_status (st.zigbee.data_types.IasZoneStatus) –
extended_status (st.zigbee.data_types.Bitmap8) –
zone_id (st.zigbee.data_types.Uint8) –
delay (st.zigbee.data_types.Uint16) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, zone_status, extended_status, zone_id, delay)

Initialize the ZoneStatusChangeNotification command

Parameters

self (ZoneStatusChangeNotification) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
zone_status (st.zigbee.data_types.IasZoneStatus) –
extended_status (st.zigbee.data_types.Bitmap8) –
zone_id (st.zigbee.data_types.Uint8) –
delay (st.zigbee.data_types.Uint16) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IASZone.ZoneEnrollRequest

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

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

zone_type: st.zigbee.data_types.IasZoneType

manufacturer_code: st.zigbee.data_types.Uint16

get_fields()

static deserialize(buf)

Deserialize this command

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

set_field_names()

static build_test_rx(device, zone_type, manufacturer_code)

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
zone_type (st.zigbee.data_types.IasZoneType) –
manufacturer_code (st.zigbee.data_types.Uint16) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, zone_type, manufacturer_code)

Initialize the ZoneEnrollRequest command

Parameters

self (ZoneEnrollRequest) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
zone_type (st.zigbee.data_types.IasZoneType) –
manufacturer_code (st.zigbee.data_types.Uint16) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IASZone.ZoneEnrollResponse

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

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

enroll_response_code: st.zigbee.zcl.clusters.IASZone.types.EnrollResponseCode

zone_id: st.zigbee.data_types.Uint8

get_fields()

static deserialize(buf)

Deserialize this command

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

set_field_names()

static build_test_rx(device, enroll_response_code, zone_id)

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
enroll_response_code (st.zigbee.zcl.clusters.IASZone.types.EnrollResponseCode) –
zone_id (st.zigbee.data_types.Uint8) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, enroll_response_code, zone_id)

Initialize the ZoneEnrollResponse command

Parameters

self (ZoneEnrollResponse) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
enroll_response_code (st.zigbee.zcl.clusters.IASZone.types.EnrollResponseCode) –
zone_id (st.zigbee.data_types.Uint8) –

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.IASZone.InitiateNormalOperationMode

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

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

get_fields()

static deserialize(buf)

Deserialize this command

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

set_field_names()

static build_test_rx(device)

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

Parameters: device (st.zigbee.Device) – the device to build the message from
Returns: The full Zigbee message containing this command body
Return type: st.zigbee.ZigbeeMessageRx

init(self, device)

Initialize the InitiateNormalOperationMode command

Parameters

self (InitiateNormalOperationMode) – the template class for this command
device (st.zigbee.Device) – the device to build this message to

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

class st.zigbee.zcl.clusters.IASZone.InitiateTestMode

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

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

test_mode_duration: st.zigbee.data_types.Uint8

current_zone_sensitivity_level: st.zigbee.data_types.Uint8

get_fields()

static deserialize(buf)

Deserialize this command

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

set_field_names()

static build_test_rx(device, test_mode_duration, current_zone_sensitivity_level)

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
test_mode_duration (st.zigbee.data_types.Uint8) –
current_zone_sensitivity_level (st.zigbee.data_types.Uint8) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, test_mode_duration, current_zone_sensitivity_level)

Initialize the InitiateTestMode command

Parameters

self (InitiateTestMode) – the template class for this command
device (st.zigbee.Device) – the device to build this message to
test_mode_duration (st.zigbee.data_types.Uint8) –
current_zone_sensitivity_level (st.zigbee.data_types.Uint8) –

Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)

Parameters: cluster (any) –

IASZone Types

class st.zigbee.zcl.clusters.IASZone.types.EnrollResponseCode: st.zigbee.data_types.Enum8 

byte_length: number: 1

SUCCESS: number: 0

NOT_SUPPORTED: number: 1

NO_ENROLL_PERMIT: number: 2

TOO_MANY_ZONES: number: 3