Scenes

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

0x0005 the ID of this cluster

NAME: str

“Scenes” the name of this cluster

attributes: st.zigbee.zcl.clusters.ScenesServerAttributes or st.zigbee.zcl.clusters.ScenesClientAttributes
commands: st.zigbee.zcl.clusters.ScenesServerCommands or st.zigbee.zcl.clusters.ScenesClientCommands
types: st.zigbee.zcl.clusters.ScenesTypes
get_attribute_by_id(command_id)

Find an attribute by id

Parameters

command_id (number) –

get_server_command_by_id(command_id)

Find a server command by id

Parameters

command_id (number) –

get_client_command_by_id(command_id)

Find a client command by id

Parameters

command_id (number) –

Scenes Attributes

class st.zigbee.zcl.clusters.Scenes.SceneCount
ID: number

0x0000 the ID of this attribute

NAME: str

“SceneCount” 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 SceneCount(…) 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.Scenes.CurrentScene
ID: number

0x0001 the ID of this attribute

NAME: str

“CurrentScene” 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 CurrentScene(…) 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.Scenes.CurrentGroup
ID: number

0x0002 the ID of this attribute

NAME: str

“CurrentGroup” the name of this attribute

data_type: st.zigbee.zcl.clusters.Scenes.types.SGroupId

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

This is also usable with the CurrentGroup(…) syntax

Parameters

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

Return type

st.zigbee.zcl.clusters.Scenes.types.SGroupId

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.Scenes.types.SGroupId) – 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.Scenes.SceneValid
ID: number

0x0003 the ID of this attribute

NAME: str

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

set_parent_cluster(cluster)
Parameters

cluster (any) –

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

0x0004 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

SCENE_NAMES_SUPPORTED: number

128

is_scene_names_supported_set()
Returns

True if the value of SCENE_NAMES_SUPPORTED is non-zero

Return type

boolean

set_scene_names_supported()

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

unset_scene_names_supported()

Set the value of the bits in the SCENE_NAMES_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) –

class st.zigbee.zcl.clusters.Scenes.LastConfiguredBy
ID: number

0x0005 the ID of this attribute

NAME: str

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

Scenes Commands

class st.zigbee.zcl.clusters.Scenes.AddSceneResponse
ID: number

0x00 the ID of this command

NAME: str

“AddSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

AddSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_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, scene_id)

Initialize the AddSceneResponse 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.Scenes.ViewSceneResponse
ID: number

0x01 the ID of this command

NAME: str

“ViewSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_id: st.zigbee.data_types.Uint8
transition_time: st.zigbee.data_types.Uint16
scene_name: st.zigbee.zcl.clusters.Scenes.types.SSceneName
extension_field_sets_list: list[st.zigbee.zcl.clusters.Scenes.types.SExtensionFieldSetList]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ViewSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_id, transition_time, scene_name, extension_field_sets)

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, scene_id, transition_time, scene_name, extension_field_sets)

Initialize the ViewSceneResponse 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.Scenes.RemoveSceneResponse
ID: number

0x02 the ID of this command

NAME: str

“RemoveSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

RemoveSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_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, scene_id)

Initialize the RemoveSceneResponse 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.Scenes.RemoveAllScenesResponse
ID: number

0x03 the ID of this command

NAME: str

“RemoveAllScenesResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RemoveAllScenesResponse

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 RemoveAllScenesResponse 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.Scenes.StoreSceneResponse
ID: number

0x04 the ID of this command

NAME: str

“StoreSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

StoreSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_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, scene_id)

Initialize the StoreSceneResponse 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.Scenes.GetSceneMembershipResponse
ID: number

0x06 the ID of this command

NAME: str

“GetSceneMembershipResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
capacity: st.zigbee.data_types.Uint8
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_list_list: list[st.zigbee.data_types.Uint8]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetSceneMembershipResponse

set_field_names()
static build_test_rx(device, status, capacity, group_id, scene_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, status, capacity, group_id, scene_list)

Initialize the GetSceneMembershipResponse 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.Scenes.EnhancedAddSceneResponse
ID: number

0x40 the ID of this command

NAME: str

“EnhancedAddSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

EnhancedAddSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_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, scene_id)

Initialize the EnhancedAddSceneResponse 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.Scenes.EnhancedViewSceneResponse
ID: number

0x41 the ID of this command

NAME: str

“EnhancedViewSceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_id: st.zigbee.data_types.Uint8
transition_time: st.zigbee.data_types.Uint16
scene_name: st.zigbee.zcl.clusters.Scenes.types.SSceneName
extension_field_sets_list: list[st.zigbee.zcl.clusters.Scenes.types.SExtensionFieldSetList]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedViewSceneResponse

set_field_names()
static build_test_rx(device, status, group_id, scene_id, transition_time, scene_name, extension_field_sets)

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, scene_id, transition_time, scene_name, extension_field_sets)

Initialize the EnhancedViewSceneResponse 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.Scenes.CopySceneResponse
ID: number

0x42 the ID of this command

NAME: str

“CopySceneResponse” the name of this command

status: st.zigbee.data_types.ZclStatus
group_identifier_from: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_identifier_from: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

CopySceneResponse

set_field_names()
static build_test_rx(device, status, group_identifier_from, scene_identifier_from)

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_identifier_from, scene_identifier_from)

Initialize the CopySceneResponse 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.Scenes.AddScene
ID: number

0x00 the ID of this command

NAME: str

“AddScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_id: st.zigbee.data_types.Uint8
transition_time: st.zigbee.data_types.Uint16
scene_name: st.zigbee.zcl.clusters.Scenes.types.SSceneName
extension_field_sets_list: list[st.zigbee.zcl.clusters.Scenes.types.SExtensionFieldSetList]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

AddScene

set_field_names()
static build_test_rx(device, group_id, scene_id, transition_time, scene_name, extension_field_sets)

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, scene_id, transition_time, scene_name, extension_field_sets)

Initialize the AddScene 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.Scenes.ViewScene
ID: number

0x01 the ID of this command

NAME: str

“ViewScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

ViewScene

set_field_names()
static build_test_rx(device, group_id, scene_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, scene_id)

Initialize the ViewScene 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.Scenes.RemoveScene
ID: number

0x02 the ID of this command

NAME: str

“RemoveScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

RemoveScene

set_field_names()
static build_test_rx(device, group_id, scene_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, scene_id)

Initialize the RemoveScene 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.Scenes.RemoveAllScenes
ID: number

0x03 the ID of this command

NAME: str

“RemoveAllScenes” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

RemoveAllScenes

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 RemoveAllScenes 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.Scenes.StoreScene
ID: number

0x04 the ID of this command

NAME: str

“StoreScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

StoreScene

set_field_names()
static build_test_rx(device, group_id, scene_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, scene_id)

Initialize the StoreScene 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.Scenes.RecallScene
ID: number

0x05 the ID of this command

NAME: str

“RecallScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_id: st.zigbee.data_types.Uint8
transition_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

RecallScene

set_field_names()
static build_test_rx(device, group_id, scene_id, transition_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, group_id, scene_id, transition_time)

Initialize the RecallScene 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.Scenes.GetSceneMembership
ID: number

0x06 the ID of this command

NAME: str

“GetSceneMembership” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetSceneMembership

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 GetSceneMembership 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.Scenes.EnhancedAddScene
ID: number

0x40 the ID of this command

NAME: str

“EnhancedAddScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_id: st.zigbee.data_types.Uint8
transition_time: st.zigbee.data_types.Uint16
scene_name: st.zigbee.zcl.clusters.Scenes.types.SSceneName
extension_field_sets_list: list[st.zigbee.zcl.clusters.Scenes.types.SExtensionFieldSetList]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EnhancedAddScene

set_field_names()
static build_test_rx(device, group_id, scene_id, transition_time, scene_name, extension_field_sets)

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, scene_id, transition_time, scene_name, extension_field_sets)

Initialize the EnhancedAddScene 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.Scenes.EnhancedViewScene
ID: number

0x41 the ID of this command

NAME: str

“EnhancedViewScene” the name of this command

group_id: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_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

EnhancedViewScene

set_field_names()
static build_test_rx(device, group_id, scene_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, scene_id)

Initialize the EnhancedViewScene 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.Scenes.CopyScene
ID: number

0x42 the ID of this command

NAME: str

“CopyScene” the name of this command

mode: st.zigbee.zcl.clusters.Scenes.types.Mode
group_identifier_from: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_identifier_from: st.zigbee.data_types.Uint8
group_identifier_to: st.zigbee.zcl.clusters.Scenes.types.SGroupId
scene_identifier_to: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

CopyScene

set_field_names()
static build_test_rx(device, mode, group_identifier_from, scene_identifier_from, group_identifier_to, scene_identifier_to)

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, mode, group_identifier_from, scene_identifier_from, group_identifier_to, scene_identifier_to)

Initialize the CopyScene command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

Scenes Types

class st.zigbee.zcl.clusters.Scenes.types.SSceneName: st.zigbee.data_types.CharString
class st.zigbee.zcl.clusters.Scenes.types.SExtensionFieldSetList
NAME: SExtensionFieldSetList
cluster_id: st.zigbee.data_types.Uint16
extension_field_set: st.zigbee.data_types.OctetString
get_length()
Returns

the length in bytes of this frame

Return type

number

_serialize()
Returns

this class serialized to bytes

Return type

str

pretty_print()
Returns

this class in a human readable format

Return type

str

static deserialize(buf)
Parameters

buf (Reader) – the buf to parse this class from

Returns

the length in bytes of this frame

Return type

number

static init(cluster_id, extension_field_set)
Parameters
class st.zigbee.zcl.clusters.Scenes.types.SGroupId: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.Scenes.types.Mode: st.zigbee.data_types.Bitmap8
byte_length: number

1

COPY_ALL_SCENES: number

1

is_copy_all_scenes_set()
Returns

True if the value of COPY_ALL_SCENES is non-zero

Return type

boolean

set_copy_all_scenes()

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

unset_copy_all_scenes()

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