Identify

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

0x0003 the ID of this cluster

NAME: str

“Identify” the name of this cluster

attributes: st.zigbee.zcl.clusters.IdentifyServerAttributes or st.zigbee.zcl.clusters.IdentifyClientAttributes
commands: st.zigbee.zcl.clusters.IdentifyServerCommands or st.zigbee.zcl.clusters.IdentifyClientCommands
types: st.zigbee.zcl.clusters.IdentifyTypes

Identify Attributes

class st.zigbee.zcl.clusters.Identify.IdentifyTime
ID: number

0x0000 the ID of this attribute

NAME: str

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

Identify Commands

class st.zigbee.zcl.clusters.Identify.IdentifyQueryResponse
ID: number

0x00 the ID of this command

NAME: str

“IdentifyQueryResponse” the name of this command

timeout: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

IdentifyQueryResponse

set_field_names()
static build_test_rx(device, timeout)

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, timeout)

Initialize the IdentifyQueryResponse 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.Identify.Identify
ID: number

0x00 the ID of this command

NAME: str

“Identify” the name of this command

identify_time: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

Identify

set_field_names()
static build_test_rx(device, identify_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, identify_time)

Initialize the Identify 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.Identify.IdentifyQuery
ID: number

0x01 the ID of this command

NAME: str

“IdentifyQuery” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

IdentifyQuery

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 IdentifyQuery command

Parameters

  • self (IdentifyQuery) – 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.Identify.TriggerEffect
ID: number

0x40 the ID of this command

NAME: str

“TriggerEffect” the name of this command

effect_identifier: st.zigbee.zcl.clusters.Identify.types.EffectIdentifier
effect_variant: st.zigbee.zcl.clusters.Identify.types.EffectVariant
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

TriggerEffect

set_field_names()
static build_test_rx(device, effect_identifier, effect_variant)

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, effect_identifier, effect_variant)

Initialize the TriggerEffect command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

Identify Types

class st.zigbee.zcl.clusters.Identify.types.EffectIdentifier: st.zigbee.data_types.Uint8
byte_length: number

1

0

BREATHE: number

1

OKAY: number

2

CHANNEL_CHANGE: number

11

FINISH_EFFECT: number

254

STOP_EFFECT: number

255

class st.zigbee.zcl.clusters.Identify.types.EffectVariant: st.zigbee.data_types.Uint8
byte_length: number

1

DEFAULT: number

0