Groups

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

0x0004 the ID of this cluster

NAME: str

“Groups” the name of this cluster

attributes: st.zigbee.zcl.clusters.GroupsServerAttributes or st.zigbee.zcl.clusters.GroupsClientAttributes
commands: st.zigbee.zcl.clusters.GroupsServerCommands or st.zigbee.zcl.clusters.GroupsClientCommands
types: st.zigbee.zcl.clusters.GroupsTypes

Groups Attributes

class st.zigbee.zcl.clusters.Groups.NameSupport
ID: number

0x0000 the ID of this attribute

NAME: str

“NameSupport” the name of this attribute

data_type: st.zigbee.data_types.Bitmap8

the data type of this attribute

SUPPORTED: number

128

is_supported_set()
Returns

True if the value of SUPPORTED is non-zero

Return type

boolean

set_supported()

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

unset_supported()

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

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters

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

build_test_attr_report(device, data)

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

Parameters
Returns

containing an AttributeReport body

Return type

st.zigbee.ZigbeeMessageRx

build_test_read_attr_response(device, data)

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

Parameters
Returns

containing an ReadAttributeResponse body

Return type

st.zigbee.ZigbeeMessageRx

new_value(...)

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

This is also usable with the NameSupport(…) syntax

Parameters

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

Return type

st.zigbee.data_types.Bitmap8

read(device)

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

Parameters

device (st.zigbee.Device) –

Returns

containing a ReadAttribute body

Return type

st.zigbee.ZigbeeMessageTx

configure_reporting(device, min_rep_int, max_rep_int)

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

Parameters

  • device (st.zigbee.Device) –

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

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

Returns

containing a ConfigureReporting body

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

Groups Commands

class st.zigbee.zcl.clusters.Groups.AddGroupResponse
ID: number

0x00 the ID of this command

NAME: str

“AddGroupResponse” the name of this command

status: st.zigbee.data_types.Enum8
group_id: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

AddGroupResponse

set_field_names()
static build_test_rx(device, status, group_id)

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

Initialize the AddGroupResponse 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.Groups.ViewGroupResponse
ID: number

0x01 the ID of this command

NAME: str

“ViewGroupResponse” the name of this command

status: st.zigbee.data_types.Enum8
group_id: st.zigbee.data_types.Uint16
group_name: st.zigbee.data_types.CharString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ViewGroupResponse

set_field_names()
static build_test_rx(device, status, group_id, group_name)

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, group_id, group_name)

Initialize the ViewGroupResponse 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.Groups.GetGroupMembershipResponse
ID: number

0x02 the ID of this command

NAME: str

“GetGroupMembershipResponse” the name of this command

capacity: st.zigbee.data_types.Uint8
group_list_list: list[st.zigbee.data_types.Uint16]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetGroupMembershipResponse

set_field_names()
static build_test_rx(device, capacity, group_list)

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, capacity, group_list)

Initialize the GetGroupMembershipResponse command

Parameters

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

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

  • capacity (st.zigbee.data_types.Uint8) –

  • group_list (list[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.Groups.RemoveGroupResponse
ID: number

0x03 the ID of this command

NAME: str

“RemoveGroupResponse” the name of this command

status: st.zigbee.data_types.Enum8
group_id: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RemoveGroupResponse

set_field_names()
static build_test_rx(device, status, group_id)

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

Initialize the RemoveGroupResponse 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.Groups.AddGroup
ID: number

0x00 the ID of this command

NAME: str

“AddGroup” the name of this command

group_id: st.zigbee.data_types.Uint16
group_name: st.zigbee.data_types.CharString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

AddGroup

set_field_names()
static build_test_rx(device, group_id, group_name)

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, group_id, group_name)

Initialize the AddGroup 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.Groups.ViewGroup
ID: number

0x01 the ID of this command

NAME: str

“ViewGroup” the name of this command

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

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ViewGroup

set_field_names()
static build_test_rx(device, group_id)

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

Initialize the ViewGroup 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.Groups.GetGroupMembership
ID: number

0x02 the ID of this command

NAME: str

“GetGroupMembership” the name of this command

group_list_list: list[st.zigbee.data_types.Uint16]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetGroupMembership

set_field_names()
static build_test_rx(device, group_list)

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

  • group_list (list[st.zigbee.data_types.Uint16]) –

Returns

The full Zigbee message containing this command body

Return type

st.zigbee.ZigbeeMessageRx

init(self, device, group_list)

Initialize the GetGroupMembership command

Parameters

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

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

  • group_list (list[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.Groups.RemoveGroup
ID: number

0x03 the ID of this command

NAME: str

“RemoveGroup” the name of this command

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

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RemoveGroup

set_field_names()
static build_test_rx(device, group_id)

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

Initialize the RemoveGroup 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.Groups.RemoveAllGroups
ID: number

0x04 the ID of this command

NAME: str

“RemoveAllGroups” the name of this command

get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RemoveAllGroups

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

Parameters

  • self (RemoveAllGroups) – 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.Groups.AddGroupIfIdentifying
ID: number

0x05 the ID of this command

NAME: str

“AddGroupIfIdentifying” the name of this command

group_id: st.zigbee.data_types.Uint16
group_name: st.zigbee.data_types.CharString
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

AddGroupIfIdentifying

set_field_names()
static build_test_rx(device, group_id, group_name)

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, group_id, group_name)

Initialize the AddGroupIfIdentifying command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –