Ember data type definitions.

See Ember ZigBee Light Link (ZLL) Data Types for details.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.

/***************************************************************************/
#ifndef SILABS_ZLL_TYPES_H
#define SILABS_ZLL_TYPES_H

#include "stack/include/sl_zigbee_types.h"


#define SL_ZIGBEE_ZLL_PRIMARY_CHANNEL_MASK ((uint32_t)(BIT32(11)   \
                                                       | BIT32(15) \
                                                       | BIT32(20) \
                                                       | BIT32(25)))

#define SL_ZIGBEE_ZLL_SECONDARY_CHANNEL_MASK ((uint32_t)(BIT32(12)   \
                                                         | BIT32(13) \
                                                         | BIT32(14) \
                                                         | BIT32(16) \
                                                         | BIT32(17) \
                                                         | BIT32(18) \
                                                         | BIT32(19) \
                                                         | BIT32(21) \
                                                         | BIT32(22) \
                                                         | BIT32(23) \
                                                         | BIT32(24) \
                                                         | BIT32(26)))

#define SL_ZIGBEE_ZLL_NULL_NODE_ID 0x0000

#define SL_ZIGBEE_ZLL_MIN_NODE_ID 0x0001

#define SL_ZIGBEE_ZLL_MAX_NODE_ID 0xFFF7

#define SL_ZIGBEE_ZLL_NULL_GROUP_ID 0x0000

#define SL_ZIGBEE_ZLL_MIN_GROUP_ID 0x0001

#define SL_ZIGBEE_ZLL_MAX_GROUP_ID 0xFEFF

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum sl_zigbee_zll_state_t
#else
typedef uint16_t sl_zigbee_zll_state_t;
enum
#endif
{
  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,
};

typedef struct {
  uint32_t transactionId;
  uint32_t responseId;
  uint16_t bitmask;
} sl_zigbee_zll_security_algorithm_data_t;

typedef struct {
  sl_zigbee_zigbee_network_t zigbeeNetwork;
  sl_zigbee_zll_security_algorithm_data_t securityAlgorithm;
  sl_802154_long_addr_t eui64;
  sl_802154_short_addr_t nodeId;
  sl_zigbee_zll_state_t state;
  sl_zigbee_node_type_t nodeType;
  uint8_t numberSubDevices;
  uint8_t totalGroupIdentifiers;
  uint8_t rssiCorrection;
} sl_zigbee_zll_network_t;

typedef struct {
  sl_802154_long_addr_t ieeeAddress;
  uint8_t endpointId;
  uint16_t profileId;
  uint16_t deviceId;
  uint8_t version;
  uint8_t groupIdCount;
} sl_zigbee_zll_device_info_record_t;

typedef struct {
  sl_802154_short_addr_t nodeId;
  sl_802154_short_addr_t freeNodeIdMin;
  sl_802154_short_addr_t freeNodeIdMax;
  sl_zigbee_multicast_id_t groupIdMin;
  sl_zigbee_multicast_id_t groupIdMax;
  sl_zigbee_multicast_id_t freeGroupIdMin;
  sl_zigbee_multicast_id_t freeGroupIdMax;
} sl_zigbee_zll_address_assignment_t;

#define SL_ZIGBEE_ZLL_CLUSTER_ID 0x1000

#define SL_ZIGBEE_ZLL_PROFILE_ID 0xC05E

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum sl_zigbee_zll_key_index_t
#else
typedef uint8_t sl_zigbee_zll_key_index_t;
enum
#endif
{
  SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT   = 0x00,
  SL_ZIGBEE_ZLL_KEY_INDEX_MASTER        = 0x04,
  SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION = 0x0F,
};

#define SL_ZIGBEE_ZLL_KEY_MASK_DEVELOPMENT (1 << SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT)

#define SL_ZIGBEE_ZLL_KEY_MASK_MASTER (1 << SL_ZIGBEE_ZLL_KEY_INDEX_MASTER)

#define SL_ZIGBEE_ZLL_KEY_MASK_CERTIFICATION (1 << SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION)

#define SL_ZIGBEE_ZLL_CERTIFICATION_ENCRYPTION_KEY  \
  { 0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, \
    0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF }

#define SL_ZIGBEE_ZLL_CERTIFICATION_PRECONFIGURED_LINK_KEY \
  { 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7,        \
    0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF }

typedef struct {
  uint32_t bitmask;
  sl_zigbee_zll_key_index_t keyIndex;
  sl_zigbee_key_data_t encryptionKey;
  sl_zigbee_key_data_t preconfiguredKey;
} sl_zigbee_zll_initial_security_state_t;

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum sl_zigbee_zll_policy_t
#else
typedef uint8_t sl_zigbee_zll_policy_t;
enum
#endif
{
  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,
};


typedef struct {
  uint32_t bitmask;
  uint16_t freeNodeIdMin;
  uint16_t freeNodeIdMax;
  uint16_t myGroupIdMin;
  uint16_t freeGroupIdMin;
  uint16_t freeGroupIdMax;
  uint8_t rssiCorrection;
} sl_zigbee_tok_type_stack_zll_data_t;

typedef struct {
  uint32_t bitmask;
  uint8_t keyIndex;
  uint8_t encryptionKey[SL_ZIGBEE_ENCRYPTION_KEY_SIZE];
  uint8_t preconfiguredKey[SL_ZIGBEE_ENCRYPTION_KEY_SIZE];
} sl_zigbee_tok_type_stack_zll_security_t;

#endif // SILABS_ZLL_TYPES_H

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

0x0000

0x0001

0xFFF7

0x0000

0x0001

0xFEFF

0x1000

0xC05E

(1 << SL_ZIGBEE_ZLL_KEY_INDEX_DEVELOPMENT)

(1 << SL_ZIGBEE_ZLL_KEY_INDEX_MASTER)

(1 << SL_ZIGBEE_ZLL_KEY_INDEX_CERTIFICATION)