TouchlinkCommissioning

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

0x1000 the ID of this cluster

NAME: str

“TouchlinkCommissioning” the name of this cluster

attributes: st.zigbee.zcl.clusters.TouchlinkCommissioningServerAttributes or st.zigbee.zcl.clusters.TouchlinkCommissioningClientAttributes
commands: st.zigbee.zcl.clusters.TouchlinkCommissioningServerCommands or st.zigbee.zcl.clusters.TouchlinkCommissioningClientCommands
types: st.zigbee.zcl.clusters.TouchlinkCommissioningTypes

TouchlinkCommissioning Attributes

TouchlinkCommissioning Commands

class st.zigbee.zcl.clusters.TouchlinkCommissioning.ScanResponse
ID: number

0x01 the ID of this command

NAME: str

“ScanResponse” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
rssi_correction: st.zigbee.data_types.Uint8
zigbee_information: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlZigbeeInformation
key_bitmask: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.KeyBitmask
response_identifier: st.zigbee.data_types.Uint32
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
network_update_identifier: st.zigbee.data_types.Uint8
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
network_address: st.zigbee.data_types.Uint16
number_of_sub_devices: st.zigbee.data_types.Uint8
total_group_identifiers: st.zigbee.data_types.Uint8
endpoint_identifier: st.zigbee.data_types.Uint8
profile_identifier: st.zigbee.data_types.Uint16
device_identifier: st.zigbee.data_types.Uint16
version: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlVersion
group_identifier_count: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ScanResponse

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, rssi_correction, zigbee_information, touchlink_information, key_bitmask, response_identifier, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier, network_address, number_of_sub_devices, total_group_identifiers, endpoint_identifier, profile_identifier, device_identifier, version, group_identifier_count)

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, inter_pan_transaction_identifier, rssi_correction, zigbee_information, touchlink_information, key_bitmask, response_identifier, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier, network_address, number_of_sub_devices, total_group_identifiers, endpoint_identifier, profile_identifier, device_identifier, version, group_identifier_count)

Initialize the ScanResponse 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.TouchlinkCommissioning.DeviceInformationResponse
ID: number

0x03 the ID of this command

NAME: str

“DeviceInformationResponse” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
number_of_sub_devices: st.zigbee.data_types.Uint8
start_index: st.zigbee.data_types.Uint8
device_information_record_list_list: list[st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlDeviceInformationRecord]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

DeviceInformationResponse

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, number_of_sub_devices, start_index, device_information_record_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, inter_pan_transaction_identifier, number_of_sub_devices, start_index, device_information_record_list)

Initialize the DeviceInformationResponse 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.TouchlinkCommissioning.NetworkStartResponse
ID: number

0x11 the ID of this command

NAME: str

“NetworkStartResponse” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
status: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlStatus
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
network_update_identifier: st.zigbee.data_types.Uint8
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkStartResponse

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, status, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier)

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, inter_pan_transaction_identifier, status, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier)

Initialize the NetworkStartResponse 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.TouchlinkCommissioning.NetworkJoinRouterResponse
ID: number

0x13 the ID of this command

NAME: str

“NetworkJoinRouterResponse” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
status: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkJoinRouterResponse

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

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, inter_pan_transaction_identifier, status)

Initialize the NetworkJoinRouterResponse 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.TouchlinkCommissioning.NetworkJoinEndDeviceResponse
ID: number

0x15 the ID of this command

NAME: str

“NetworkJoinEndDeviceResponse” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
status: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlStatus
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkJoinEndDeviceResponse

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

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, inter_pan_transaction_identifier, status)

Initialize the NetworkJoinEndDeviceResponse 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.TouchlinkCommissioning.EndpointInformation
ID: number

0x40 the ID of this command

NAME: str

“EndpointInformation” the name of this command

ieee_address: st.zigbee.data_types.IeeeAddress
network_address: st.zigbee.data_types.Uint16
endpoint_identifier: st.zigbee.data_types.Uint8
profile_identifier: st.zigbee.data_types.Uint16
device_identifier: st.zigbee.data_types.Uint16
version: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlVersion
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

EndpointInformation

set_field_names()
static build_test_rx(device, ieee_address, network_address, endpoint_identifier, profile_identifier, device_identifier, 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, ieee_address, network_address, endpoint_identifier, profile_identifier, device_identifier, version)

Initialize the EndpointInformation 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.TouchlinkCommissioning.GetGroupIdentifiersResponse
ID: number

0x41 the ID of this command

NAME: str

“GetGroupIdentifiersResponse” the name of this command

total: st.zigbee.data_types.Uint8
start_index: st.zigbee.data_types.Uint8
group_information_record_list_list: list[st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlGroupInformationRecord]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetGroupIdentifiersResponse

set_field_names()
static build_test_rx(device, total, start_index, group_information_record_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, total, start_index, group_information_record_list)

Initialize the GetGroupIdentifiersResponse command

Parameters

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

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

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

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

  • group_information_record_list (list[st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlGroupInformationRecord]) –

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.TouchlinkCommissioning.GetEndpointListResponse
ID: number

0x42 the ID of this command

NAME: str

“GetEndpointListResponse” the name of this command

total: st.zigbee.data_types.Uint8
start_index: st.zigbee.data_types.Uint8
endpoint_information_record_list_list: list[st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlEndpointInformationRecord]
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetEndpointListResponse

set_field_names()
static build_test_rx(device, total, start_index, endpoint_information_record_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, total, start_index, endpoint_information_record_list)

Initialize the GetEndpointListResponse command

Parameters

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

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

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

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

  • endpoint_information_record_list (list[st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlEndpointInformationRecord]) –

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.TouchlinkCommissioning.ScanRequest
ID: number

0x00 the ID of this command

NAME: str

“ScanRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
zigbee_information: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlZigbeeInformation
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ScanRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, zigbee_information, touchlink_information)

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, inter_pan_transaction_identifier, zigbee_information, touchlink_information)

Initialize the ScanRequest 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.TouchlinkCommissioning.DeviceInformationRequest
ID: number

0x02 the ID of this command

NAME: str

“DeviceInformationRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
start_index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

DeviceInformationRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, start_index)

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, inter_pan_transaction_identifier, start_index)

Initialize the DeviceInformationRequest 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.TouchlinkCommissioning.IdentifyRequest
ID: number

0x06 the ID of this command

NAME: str

“IdentifyRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
identify_duration: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

IdentifyRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, identify_duration)

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, inter_pan_transaction_identifier, identify_duration)

Initialize the IdentifyRequest 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.TouchlinkCommissioning.ResetToFactoryNewRequest
ID: number

0x07 the ID of this command

NAME: str

“ResetToFactoryNewRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

ResetToFactoryNewRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier)

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

Initialize the ResetToFactoryNewRequest 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.TouchlinkCommissioning.NetworkStartRequest
ID: number

0x10 the ID of this command

NAME: str

“NetworkStartRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
key_index: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlKeyIndex
encrypted_network_key: st.zigbee.data_types.Seckey128
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
network_address: st.zigbee.data_types.Uint16
group_identifiers_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
group_identifiers_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
initiator_ieee_address: st.zigbee.data_types.IeeeAddress
initiator_network_address: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkStartRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end, initiator_ieee_address, initiator_network_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, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end, initiator_ieee_address, initiator_network_address)

Initialize the NetworkStartRequest 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.TouchlinkCommissioning.NetworkJoinRouterRequest
ID: number

0x12 the ID of this command

NAME: str

“NetworkJoinRouterRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
key_index: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlKeyIndex
encrypted_network_key: st.zigbee.data_types.Seckey128
network_update_identifier: st.zigbee.data_types.Uint8
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
network_address: st.zigbee.data_types.Uint16
group_identifiers_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
group_identifiers_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkJoinRouterRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, network_update_identifier, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end)

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, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, network_update_identifier, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end)

Initialize the NetworkJoinRouterRequest 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.TouchlinkCommissioning.NetworkJoinEndDeviceRequest
ID: number

0x14 the ID of this command

NAME: str

“NetworkJoinEndDeviceRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
key_index: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlKeyIndex
encrypted_network_key: st.zigbee.data_types.Seckey128
network_update_identifier: st.zigbee.data_types.Uint8
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
network_address: st.zigbee.data_types.Uint16
group_identifiers_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
group_identifiers_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_network_address_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_begin: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
free_group_identifier_range_end: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkJoinEndDeviceRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, network_update_identifier, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end)

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, inter_pan_transaction_identifier, extended_pan_identifier, key_index, encrypted_network_key, network_update_identifier, logical_channel, pan_identifier, network_address, group_identifiers_begin, group_identifiers_end, free_network_address_range_begin, free_network_address_range_end, free_group_identifier_range_begin, free_group_identifier_range_end)

Initialize the NetworkJoinEndDeviceRequest 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.TouchlinkCommissioning.NetworkUpdateRequest
ID: number

0x16 the ID of this command

NAME: str

“NetworkUpdateRequest” the name of this command

inter_pan_transaction_identifier: st.zigbee.data_types.Uint32
extended_pan_identifier: st.zigbee.data_types.IeeeAddress
network_update_identifier: st.zigbee.data_types.Uint8
logical_channel: st.zigbee.data_types.Uint8
pan_identifier: st.zigbee.data_types.Uint16
network_address: st.zigbee.data_types.Uint16
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

NetworkUpdateRequest

set_field_names()
static build_test_rx(device, inter_pan_transaction_identifier, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier, network_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, inter_pan_transaction_identifier, extended_pan_identifier, network_update_identifier, logical_channel, pan_identifier, network_address)

Initialize the NetworkUpdateRequest 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.TouchlinkCommissioning.GetGroupIdentifiersRequest
ID: number

0x41 the ID of this command

NAME: str

“GetGroupIdentifiersRequest” the name of this command

start_index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetGroupIdentifiersRequest

set_field_names()
static build_test_rx(device, start_index)

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

Initialize the GetGroupIdentifiersRequest 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.TouchlinkCommissioning.GetEndpointListRequest
ID: number

0x42 the ID of this command

NAME: str

“GetEndpointListRequest” the name of this command

start_index: st.zigbee.data_types.Uint8
get_fields()
static deserialize(buf)

Deserialize this command

Parameters

buf (buf) – the bytes of the command body

Return type

GetEndpointListRequest

set_field_names()
static build_test_rx(device, start_index)

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

Initialize the GetEndpointListRequest command

Parameters
Returns

the full command addressed to the device

Return type

st.zigbee.ZigbeeMessageTx

set_parent_cluster(cluster)
Parameters

cluster (any) –

TouchlinkCommissioning Types

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlKeyIndex: st.zigbee.data_types.Uint8
byte_length: number

1

DEVELOPMENT_KEY: number

0

MASTER_KEY: number

4

CERTIFICATION_KEY: number

15

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlZigbeeInformation: st.zigbee.data_types.Bitmap8
byte_length: number

1

LOGICAL_TYPE: number

3

RX_ON_WHEN_IDLE: number

4

is_logical_type_set()
Returns

True if the value of LOGICAL_TYPE is non-zero

Return type

boolean

set_logical_type(fieldVal)

Set the value of the bits in the LOGICAL_TYPE field

Parameters

fieldVal (number) – the value to set the bitfield to

get_logical_type()

Get the value of the bits in the LOGICAL_TYPE field

unset_logical_type()

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

is_rx_on_when_idle_set()
Returns

True if the value of RX_ON_WHEN_IDLE is non-zero

Return type

boolean

set_rx_on_when_idle()

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

unset_rx_on_when_idle()

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

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlTouchlinkInformation: st.zigbee.data_types.Bitmap8
byte_length: number

1

FACTORY_NEW: number

1

ADDRESS_ASSIGNMENT: number

2

16

32

PROFILE_INTEROP: number

128

is_factory_new_set()
Returns

True if the value of FACTORY_NEW is non-zero

Return type

boolean

set_factory_new()

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

unset_factory_new()

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

is_address_assignment_set()
Returns

True if the value of ADDRESS_ASSIGNMENT is non-zero

Return type

boolean

set_address_assignment()

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

unset_address_assignment()

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

Returns

True if the value of LINK_INITIATOR is non-zero

Return type

boolean

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

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

Returns

True if the value of TOUCHLINK_PRIORITY_REQUEST is non-zero

Return type

boolean

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

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

is_profile_interop_set()
Returns

True if the value of PROFILE_INTEROP is non-zero

Return type

boolean

set_profile_interop()

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

unset_profile_interop()

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

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlVersion: st.zigbee.data_types.Uint8
byte_length: number

1

APPLICATION_DEVICE_VERSION: number

15

is_application_device_version_set()
Returns

True if the value of APPLICATION_DEVICE_VERSION is non-zero

Return type

boolean

set_application_device_version(fieldVal)

Set the value of the bits in the APPLICATION_DEVICE_VERSION field

Parameters

fieldVal (number) – the value to set the bitfield to

get_application_device_version()

Get the value of the bits in the APPLICATION_DEVICE_VERSION field

unset_application_device_version()

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

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlDeviceInformationRecord
NAME: TlDeviceInformationRecord
ieee_address: st.zigbee.data_types.IeeeAddress
endpoint_identifier: st.zigbee.data_types.Uint8
profile_indentifier: st.zigbee.data_types.Uint16
device_identifier: st.zigbee.data_types.Uint16
version: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlVersion
group_identifier_count: st.zigbee.data_types.Uint8
sort: st.zigbee.data_types.Uint8
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(ieee_address, endpoint_identifier, profile_indentifier, device_identifier, version, group_identifier_count, sort)
Parameters
class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlStatus: st.zigbee.data_types.Uint8
byte_length: number

1

SUCCESS: number

0

FAILURE: number

1

class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlGroupInformationRecord
NAME: TlGroupInformationRecord
group_identifier: st.zigbee.data_types.Uint16
group_type: st.zigbee.data_types.Uint8
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(group_identifier, group_type)
Parameters
class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlEndpointInformationRecord
NAME: TlEndpointInformationRecord
network_address: st.zigbee.data_types.Uint16
endpoint_identifier: st.zigbee.data_types.Uint8
profile_identifier: st.zigbee.data_types.Uint16
device_identifier: st.zigbee.data_types.Uint16
version: st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlVersion
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(network_address, endpoint_identifier, profile_identifier, device_identifier, version)
Parameters
class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.TlRangeBeginEnd: st.zigbee.data_types.Uint16
class st.zigbee.zcl.clusters.TouchlinkCommissioning.types.KeyBitmask: st.zigbee.data_types.Bitmap16
byte_length: number

2

DEVELOPMENT_KEY: number

1

MASTER_KEY: number

16

CERTIFICATION_KEY: number

32768

is_development_key_set()
Returns

True if the value of DEVELOPMENT_KEY is non-zero

Return type

boolean

set_development_key()

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

unset_development_key()

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

is_master_key_set()
Returns

True if the value of MASTER_KEY is non-zero

Return type

boolean

set_master_key()

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

unset_master_key()

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

is_certification_key_set()
Returns

True if the value of CERTIFICATION_KEY is non-zero

Return type

boolean

set_certification_key()

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

unset_certification_key()

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