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


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

#define EMBER_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 EMBER_ZLL_NULL_NODE_ID 0x0000

#define EMBER_ZLL_MIN_NODE_ID 0x0001

#define EMBER_ZLL_MAX_NODE_ID 0xFFF7

#define EMBER_ZLL_NULL_GROUP_ID 0x0000

#define EMBER_ZLL_MIN_GROUP_ID 0x0001

#define EMBER_ZLL_MAX_GROUP_ID 0xFEFF

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum EmberZllState
#else
typedef uint16_t EmberZllState;
enum
#endif
{
  EMBER_ZLL_STATE_NONE                       = 0x0000,
  EMBER_ZLL_STATE_FACTORY_NEW                = 0x0001,
  EMBER_ZLL_STATE_ADDRESS_ASSIGNMENT_CAPABLE = 0x0002,
  EMBER_ZLL_STATE_LINK_INITIATOR             = 0x0010,
  EMBER_ZLL_STATE_LINK_PRIORITY_REQUEST      = 0x0020,
  EMBER_ZLL_STATE_PROFILE_INTEROP            = 0x0080,
  EMBER_ZLL_STATE_NON_ZLL_NETWORK            = 0x0100,
  EMBER_ZLL_TOKEN_POINTS_TO_PSA_ID           = 0x0200,
};

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

typedef struct {
  EmberZigbeeNetwork zigbeeNetwork;
  EmberZllSecurityAlgorithmData securityAlgorithm;
  EmberEUI64 eui64;
  EmberNodeId nodeId;
  EmberZllState state;
  EmberNodeType nodeType;
  uint8_t numberSubDevices;
  uint8_t totalGroupIdentifiers;
  uint8_t rssiCorrection;
} EmberZllNetwork;

typedef struct {
  EmberEUI64 ieeeAddress;
  uint8_t endpointId;
  uint16_t profileId;
  uint16_t deviceId;
  uint8_t version;
  uint8_t groupIdCount;
} EmberZllDeviceInfoRecord;

typedef struct {
  EmberNodeId nodeId;
  EmberNodeId freeNodeIdMin;
  EmberNodeId freeNodeIdMax;
  EmberMulticastId groupIdMin;
  EmberMulticastId groupIdMax;
  EmberMulticastId freeGroupIdMin;
  EmberMulticastId freeGroupIdMax;
} EmberZllAddressAssignment;

#define EMBER_ZLL_CLUSTER_ID 0x1000

#define EMBER_ZLL_PROFILE_ID 0xC05E

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum EmberZllKeyIndex
#else
typedef uint8_t EmberZllKeyIndex;
enum
#endif
{
  EMBER_ZLL_KEY_INDEX_DEVELOPMENT   = 0x00,
  EMBER_ZLL_KEY_INDEX_MASTER        = 0x04,
  EMBER_ZLL_KEY_INDEX_CERTIFICATION = 0x0F,
};

#define EMBER_ZLL_KEY_MASK_DEVELOPMENT (1 << EMBER_ZLL_KEY_INDEX_DEVELOPMENT)

#define EMBER_ZLL_KEY_MASK_MASTER (1 << EMBER_ZLL_KEY_INDEX_MASTER)

#define EMBER_ZLL_KEY_MASK_CERTIFICATION (1 << EMBER_ZLL_KEY_INDEX_CERTIFICATION)

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

#define EMBER_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;
  EmberZllKeyIndex keyIndex;
  EmberKeyData encryptionKey;
  EmberKeyData preconfiguredKey;
} EmberZllInitialSecurityState;

#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum EmberZllPolicy
#else
typedef uint8_t EmberZllPolicy;
enum
#endif
{
  EMBER_ZLL_POLICY_DISABLED = 0x00,
  EMBER_ZLL_POLICY_ENABLED = 0x01,
  EMBER_ZLL_POLICY_TARGET = 0x02,
  EMBER_ZLL_POLICY_STEALING_ENABLED = 0x04,
  EMBER_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;
} EmberTokTypeStackZllData;

typedef struct {
  uint32_t bitmask;
  uint8_t keyIndex;
  uint8_t encryptionKey[EMBER_ENCRYPTION_KEY_SIZE];
  uint8_t preconfiguredKey[EMBER_ENCRYPTION_KEY_SIZE];
} EmberTokTypeStackZllSecurity;

#endif // SILABS_ZLL_TYPES_H

Modules#

EmberZllSecurityAlgorithmData

EmberZllNetwork

EmberZllDeviceInfoRecord

EmberZllAddressAssignment

EmberZllInitialSecurityState

EmberTokTypeStackZllData

EmberTokTypeStackZllSecurity

0x0000

0x0001

0xFFF7

0x0000

0x0001

0xFEFF

0x1000

0xC05E

(1 << EMBER_ZLL_KEY_INDEX_DEVELOPMENT)

(1 << EMBER_ZLL_KEY_INDEX_MASTER)

(1 << EMBER_ZLL_KEY_INDEX_CERTIFICATION)