Ember ZigBee Light Link (ZLL) Data Types#

See zll-types.h for source code.

Modules#

sl_zigbee_zll_security_algorithm_data_t

sl_zigbee_zll_network_t

sl_zigbee_zll_device_info_record_t

sl_zigbee_zll_address_assignment_t

sl_zigbee_zll_initial_security_state_t

sl_zigbee_tok_type_stack_zll_data_t

sl_zigbee_tok_type_stack_zll_security_t

ZigBee Light Link Types#

enum
sl_zigbee_zll_state_t {
SL_ZIGBEE_ZLL_STATE_NONE = 0x0000
SL_ZIGBEE_ZLL_STATE_FACTORY_NEW = 0x0001
SL_ZIGBEE_ZLL_STATE_ADDRESS_ASSIGNMENT_CAPABLE = 0x0002
SL_ZIGBEE_ZLL_STATE_LINK_INITIATOR = 0x0010
SL_ZIGBEE_ZLL_STATE_LINK_PRIORITY_REQUEST = 0x0020
SL_ZIGBEE_ZLL_STATE_PROFILE_INTEROP = 0x0080
SL_ZIGBEE_ZLL_STATE_NON_ZLL_NETWORK = 0x0100
SL_ZIGBEE_ZLL_TOKEN_POINTS_TO_PSA_ID = 0x0200
}

A bitmask indicating the state of the ZLL device. This maps directly to the ZLL information field in the scan response.

enum
sl_zigbee_zll_key_index_t {
SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT = 0x00
SL_ZIGBEE_ZLL_KEY_INDEX_MASTER = 0x04
SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION = 0x0F
}

The key encryption algorithms supported by the stack.

enum
sl_zigbee_zll_policy_t {
SL_ZIGBEE_ZLL_POLICY_DISABLED = 0x00
SL_ZIGBEE_ZLL_POLICY_ENABLED = 0x01
SL_ZIGBEE_ZLL_POLICY_TARGET = 0x02
SL_ZIGBEE_ZLL_POLICY_STEALING_ENABLED = 0x04
SL_ZIGBEE_ZLL_POLICY_REMOTE_RESET_ENABLED = 0x08
}

This enumeration indicates whether or not the stack processes ZLL messages.

#define
SL_ZIGBEE_ZLL_PRIMARY_CHANNEL_MASK undefined

The list of primary ZLL channels.

#define
SL_ZIGBEE_ZLL_SECONDARY_CHANNEL_MASK undefined

The list of secondary ZLL channels.

#define
SL_ZIGBEE_ZLL_NULL_NODE_ID 0x0000

A distinguished network identifier in the ZLL network address space that indicates no free network identifiers were assigned to the device.

#define
SL_ZIGBEE_ZLL_MIN_NODE_ID 0x0001

The minimum network identifier in the ZLL network address space.

#define
SL_ZIGBEE_ZLL_MAX_NODE_ID 0xFFF7

The maximum network identifier in the ZLL network address space.

#define
SL_ZIGBEE_ZLL_NULL_GROUP_ID 0x0000

A distinguished group identifier in the ZLL group address space that indicates no free group identifiers were assigned to the device.

#define
SL_ZIGBEE_ZLL_MIN_GROUP_ID 0x0001

The minimum group identifier in the ZLL group address space.

#define
SL_ZIGBEE_ZLL_MAX_GROUP_ID 0xFEFF

The maximum group identifier in the ZLL group address space.

#define
SL_ZIGBEE_ZLL_CLUSTER_ID 0x1000

The ZigBee Light Link Commissioning cluster ID.

#define
SL_ZIGBEE_ZLL_PROFILE_ID 0xC05E

The ZigBee Light Link Profile ID.

#define
SL_ZIGBEE_ZLL_KEY_MASK_DEVELOPMENT (1 << SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT)

The key encryption bitmask corresponding to encryption key index SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT.

#define
SL_ZIGBEE_ZLL_KEY_MASK_MASTER (1 << SL_ZIGBEE_ZLL_KEY_INDEX_MASTER)

The key encryption bitmask corresponding to encryption key index SL_ZIGBEE_ZLL_KEY_INDEX_MASTER.

#define
SL_ZIGBEE_ZLL_KEY_MASK_CERTIFICATION (1 << SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION)

THe key encryption bitmask corresponding to encryption key index SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION.

#define
SL_ZIGBEE_ZLL_CERTIFICATION_ENCRYPTION_KEY undefined

The encryption key for use during development and certification in conjunction with SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION.

#define
SL_ZIGBEE_ZLL_CERTIFICATION_PRECONFIGURED_LINK_KEY undefined

The pre-configured link key for use during development and certification in conjunction with SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION.

Variables#

uint32_t
responseId
uint16_t
bitmask
sl_802154_long_addr_t
eui64
sl_802154_short_addr_t
nodeId
sl_802154_long_addr_t
ieeeAddress
uint8_t
endpointId
uint16_t
profileId
uint16_t
deviceId
uint8_t
version
sl_802154_short_addr_t
nodeId
sl_802154_short_addr_t
freeNodeIdMin
sl_802154_short_addr_t
freeNodeIdMax
uint32_t
bitmask
uint32_t
bitmask
uint16_t
myGroupIdMin
uint32_t
bitmask
uint8_t
keyIndex

ZigBee Light Link Types Documentation#

sl_zigbee_zll_state_t#

sl_zigbee_zll_state_t

A bitmask indicating the state of the ZLL device. This maps directly to the ZLL information field in the scan response.

Enumerator
SL_ZIGBEE_ZLL_STATE_NONE

No state.

SL_ZIGBEE_ZLL_STATE_FACTORY_NEW

The device is factory new.

SL_ZIGBEE_ZLL_STATE_ADDRESS_ASSIGNMENT_CAPABLE

The device is capable of assigning addresses to other devices.

SL_ZIGBEE_ZLL_STATE_LINK_INITIATOR

The device is initiating a link operation.

SL_ZIGBEE_ZLL_STATE_LINK_PRIORITY_REQUEST

The device is requesting link priority.

SL_ZIGBEE_ZLL_STATE_PROFILE_INTEROP

The device is a ZigBee 3.0 device.

SL_ZIGBEE_ZLL_STATE_NON_ZLL_NETWORK

The device is on a non-ZLL network.

SL_ZIGBEE_ZLL_TOKEN_POINTS_TO_PSA_ID

Internal use: the ZLL token's key values point to a PSA key identifier


sl_zigbee_zll_key_index_t#

sl_zigbee_zll_key_index_t

The key encryption algorithms supported by the stack.

Enumerator
SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT

The key encryption algorithm for use during development.

SL_ZIGBEE_ZLL_KEY_INDEX_MASTER

The key encryption algorithm shared by all certified devices.

SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION

The key encryption algorithm for use during development and certification.


sl_zigbee_zll_policy_t#

sl_zigbee_zll_policy_t

This enumeration indicates whether or not the stack processes ZLL messages.

Enumerator
SL_ZIGBEE_ZLL_POLICY_DISABLED

Initial state - all touchlinking is disabled.

SL_ZIGBEE_ZLL_POLICY_ENABLED

Indicates that ZLL processing is enabled.

SL_ZIGBEE_ZLL_POLICY_TARGET

Indicates that ZLL target is enabled.

SL_ZIGBEE_ZLL_POLICY_STEALING_ENABLED

Indicates that stealing and network update are enabled for non factory new devices.

SL_ZIGBEE_ZLL_POLICY_REMOTE_RESET_ENABLED

Indicates that remote reset is enabled for non factory new devices.


Variable Documentation#

transactionId#

uint32_t sl_zigbee_zll_security_algorithm_data_t::transactionId

responseId#

uint32_t sl_zigbee_zll_security_algorithm_data_t::responseId

bitmask#

uint16_t sl_zigbee_zll_security_algorithm_data_t::bitmask

zigbeeNetwork#

sl_zigbee_zigbee_network_t sl_zigbee_zll_network_t::zigbeeNetwork

securityAlgorithm#

sl_zigbee_zll_security_algorithm_data_t sl_zigbee_zll_network_t::securityAlgorithm

eui64#

sl_802154_long_addr_t sl_zigbee_zll_network_t::eui64

nodeId#

sl_802154_short_addr_t sl_zigbee_zll_network_t::nodeId

state#

sl_zigbee_zll_state_t sl_zigbee_zll_network_t::state

nodeType#

sl_zigbee_node_type_t sl_zigbee_zll_network_t::nodeType

numberSubDevices#

uint8_t sl_zigbee_zll_network_t::numberSubDevices

totalGroupIdentifiers#

uint8_t sl_zigbee_zll_network_t::totalGroupIdentifiers

rssiCorrection#

uint8_t sl_zigbee_zll_network_t::rssiCorrection

ieeeAddress#

sl_802154_long_addr_t sl_zigbee_zll_device_info_record_t::ieeeAddress

endpointId#

uint8_t sl_zigbee_zll_device_info_record_t::endpointId

profileId#

uint16_t sl_zigbee_zll_device_info_record_t::profileId

deviceId#

uint16_t sl_zigbee_zll_device_info_record_t::deviceId

version#

uint8_t sl_zigbee_zll_device_info_record_t::version

groupIdCount#

uint8_t sl_zigbee_zll_device_info_record_t::groupIdCount

nodeId#

sl_802154_short_addr_t sl_zigbee_zll_address_assignment_t::nodeId

freeNodeIdMin#

sl_802154_short_addr_t sl_zigbee_zll_address_assignment_t::freeNodeIdMin

freeNodeIdMax#

sl_802154_short_addr_t sl_zigbee_zll_address_assignment_t::freeNodeIdMax

groupIdMin#

sl_zigbee_multicast_id_t sl_zigbee_zll_address_assignment_t::groupIdMin

groupIdMax#

sl_zigbee_multicast_id_t sl_zigbee_zll_address_assignment_t::groupIdMax

freeGroupIdMin#

sl_zigbee_multicast_id_t sl_zigbee_zll_address_assignment_t::freeGroupIdMin

freeGroupIdMax#

sl_zigbee_multicast_id_t sl_zigbee_zll_address_assignment_t::freeGroupIdMax

bitmask#

uint32_t sl_zigbee_zll_initial_security_state_t::bitmask

This bitmask is unused. All values are reserved for future use.


keyIndex#

sl_zigbee_zll_key_index_t sl_zigbee_zll_initial_security_state_t::keyIndex

The key encryption algorithm advertised by the application.


encryptionKey#

sl_zigbee_key_data_t sl_zigbee_zll_initial_security_state_t::encryptionKey

The encryption key for use by algorithms that require it.


preconfiguredKey#

sl_zigbee_key_data_t sl_zigbee_zll_initial_security_state_t::preconfiguredKey

The pre-configured link key used during classical ZigBee commissioning.


bitmask#

uint32_t sl_zigbee_tok_type_stack_zll_data_t::bitmask

freeNodeIdMin#

uint16_t sl_zigbee_tok_type_stack_zll_data_t::freeNodeIdMin

freeNodeIdMax#

uint16_t sl_zigbee_tok_type_stack_zll_data_t::freeNodeIdMax

myGroupIdMin#

uint16_t sl_zigbee_tok_type_stack_zll_data_t::myGroupIdMin

freeGroupIdMin#

uint16_t sl_zigbee_tok_type_stack_zll_data_t::freeGroupIdMin

freeGroupIdMax#

uint16_t sl_zigbee_tok_type_stack_zll_data_t::freeGroupIdMax

rssiCorrection#

uint8_t sl_zigbee_tok_type_stack_zll_data_t::rssiCorrection

bitmask#

uint32_t sl_zigbee_tok_type_stack_zll_security_t::bitmask

keyIndex#

uint8_t sl_zigbee_tok_type_stack_zll_security_t::keyIndex

encryptionKey#

uint8_t sl_zigbee_tok_type_stack_zll_security_t::encryptionKey[SL_ZIGBEE_ENCRYPTION_KEY_SIZE]

preconfiguredKey#

uint8_t sl_zigbee_tok_type_stack_zll_security_t::preconfiguredKey[SL_ZIGBEE_ENCRYPTION_KEY_SIZE]