Configuration#

EMBER_API_MAJOR_VERSION#

#define EMBER_API_MAJOR_VERSION

2

The major version number of the Ember stack release that the application is built against.

EMBER_API_MINOR_VERSION#

#define EMBER_API_MINOR_VERSION

0

The minor version number of the Ember stack release that the application is built against.

EMBER_STACK_PROFILE#

#define EMBER_STACK_PROFILE

0

Specify the stack profile. The default is Profile 0.

You can set this to Profile 1 (Zigbee) or Profile 2 (Zigbee Pro) in your application's configuration header (.h) file using:

#define EMBER_STACK_PROFILE 1

or

#define EMBER_STACK_PROFILE 2

SL_ZIGBEE_STACK_COMPLIANCE_REVISION#

#define SL_ZIGBEE_STACK_COMPLIANCE_REVISION

22

EMBER_MAX_END_DEVICE_CHILDREN#

#define EMBER_MAX_END_DEVICE_CHILDREN

6

The maximum number of end device children that a router will support.

EMBER_SECURITY_LEVEL#

#define EMBER_SECURITY_LEVEL

5

The security level used for security at the MAC and network layers. The supported values are 0 (no security) and 5 (payload is encrypted and a four-byte MIC is used for authentication).

EMBER_CHILD_TABLE_SIZE#

#define EMBER_CHILD_TABLE_SIZE

EMBER_MAX_END_DEVICE_CHILDREN

The maximum number of children that a node may have.

For the mesh stack, this defaults to the value of EMBER_MAX_END_DEVICE_CHILDREN. In the mesh stack router children are not stored in the child table.

Each child table entry requires 4 bytes of RAM and a 10 byte token.

Application definitions for EMBER_CHILD_TABLE_SIZE that are larger than the default value are ignored and the default value used instead.

EMBER_KEY_TABLE_SIZE#

#define EMBER_KEY_TABLE_SIZE

0

The maximum number of link and master keys that a node can store, not including the Trust Center Link Key. The stack maintains special storage for the Trust Center Link Key.

For the Trust Center, this controls how many totally unique Trust Center Link Keys may be stored. The rest of the devices in the network will use a global or hashed link key.

For normal nodes, this controls the number of Application Link Keys it can store. The Trust Center Link Key is stored separately from this table.

EMBER_CERTIFICATE_TABLE_SIZE#

#define EMBER_CERTIFICATE_TABLE_SIZE

0

The number of entries for the field upgradeable certificate table. Normally, certificates, such as SE certs, are stored in the runtime-unmodifiable MFG area. However, those devices wishing to add new certificates after manufacturing will have to use the normal token space. This defines the size of that table. For most devices 0 is appropriate since there is no need to change certificates in the field. For those wishing to field upgrade devices with new certificates, 1 is the correct size. Anything more is wasting SimEEPROM.

EMBER_MAX_DEPTH#

#define EMBER_MAX_DEPTH

15

The maximum depth of the tree in ZigBee 2006. This implicitly determines the maximum diameter of the network (EMBER_MAX_HOPS) if that value is not overridden.

EMBER_MAX_HOPS#

#define EMBER_MAX_HOPS

(2 * EMBER_MAX_DEPTH)

The maximum number of hops for a message.

The default maximum number of hops is two times the maximum depth (EMBER_MAX_DEPTH). This is the fallback value when the radius is not supplied by the Application (i.e., 0) or the stack is sending a message.

EMBER_PACKET_BUFFER_COUNT#

#define EMBER_PACKET_BUFFER_COUNT

75

The number of Packet Buffers available to the Stack. The default is 75.

Each buffer requires 36 bytes of RAM (32 for the buffer itself plus 4 bytes of overhead).

EMBER_MAX_BEACONS_TO_STORE#

#define EMBER_MAX_BEACONS_TO_STORE

( (EMBER_PACKET_BUFFER_COUNT <= 75) ? (EMBER_PACKET_BUFFER_COUNT >> 1) : 37)

The maximum number of beacons to record when performing an active scan to find networks. Legacy APIs such as emberJoinNetwork and the several emberFindAndRejoinNetwork APIs set the number of beacons to record to 1, while the Network Steering plugin will attempt to record the maximum number of beacons.

It is important not to consume all packet buffers in a system, else the transmission and reception of packets will fail, since TX and RX packets are held in packet buffers.

BEACON_STORAGE_TIMEOUT_MS#

#define BEACON_STORAGE_TIMEOUT_MS

(3 * 60 * 1000)

The amount of time after which any caches beacons are purged from the cache in RAM. Each beacon stored consumes one packet buffer. The timeout for beacons begins once the first beacon is added to the cache.

EMBER_MAX_NEIGHBOR_TABLE_SIZE#

#define EMBER_MAX_NEIGHBOR_TABLE_SIZE

26

The maximum number of router neighbors the stack can keep track of.

A neighbor is a node within radio range. The maximum allowed value is 26. End device children are stored in the child table, not the neighbor table. The default is 16. Setting this value lower than 8 is not recommended.

Each neighbor table entry consumes 18 bytes of RAM (6 for the table itself and 12 bytes of security data).

EMBER_NEIGHBOR_TABLE_SIZE#

#define EMBER_NEIGHBOR_TABLE_SIZE

16

EMBER_INDIRECT_TRANSMISSION_TIMEOUT#

#define EMBER_INDIRECT_TRANSMISSION_TIMEOUT

3000

The maximum amount of time (in milliseconds) that the MAC will hold a message for indirect transmission to a child.

The default is 3000 milliseconds (3 sec). The maximum value is 30 seconds (30000 milliseconds). Larger values will cause rollover confusion.

EMBER_MAX_INDIRECT_TRANSMISSION_TIMEOUT#

#define EMBER_MAX_INDIRECT_TRANSMISSION_TIMEOUT

30000

EMBER_SEND_MULTICASTS_TO_SLEEPY_ADDRESS#

#define EMBER_SEND_MULTICASTS_TO_SLEEPY_ADDRESS

false

Define the behavior for the address that the multicasts are sent to. The normal address is RxOnWhenIdle=true (0xFFFD). However, setting this to true can change locally generated multicasts to be sent to the sleepy broadcast address (0xFFFF). Changing the default is NOT Zigbee Pro compliant and may not be inter-operable.

EMBER_END_DEVICE_KEEP_ALIVE_SUPPORT_MODE#

#define EMBER_END_DEVICE_KEEP_ALIVE_SUPPORT_MODE

EMBER_KEEP_ALIVE_SUPPORT_ALL

SECONDS_10#

#define SECONDS_10

0

The default index into the R21 Child Aging timeout The default value is a timeout of 256 minutes.

MINUTES_2#

#define MINUTES_2

1

MINUTES_4#

#define MINUTES_4

2

MINUTES_8#

#define MINUTES_8

3

MINUTES_16#

#define MINUTES_16

4

MINUTES_32#

#define MINUTES_32

5

MINUTES_64#

#define MINUTES_64

6

MINUTES_128#

#define MINUTES_128

7

MINUTES_256#

#define MINUTES_256

8

MINUTES_512#

#define MINUTES_512

9

MINUTES_1024#

#define MINUTES_1024

10

MINUTES_2048#

#define MINUTES_2048

11

MINUTES_4096#

#define MINUTES_4096

12

MINUTES_8192#

#define MINUTES_8192

13

MINUTES_16384#

#define MINUTES_16384

14

EMBER_END_DEVICE_POLL_TIMEOUT#

#define EMBER_END_DEVICE_POLL_TIMEOUT

MINUTES_256

EMBER_SHORT_CHILD_TIMEOUT#

#define EMBER_SHORT_CHILD_TIMEOUT

MINUTES_2

The temporary, short timeout that is given to a joining or insecurely rejoining child. The child is expected to send a network encrypted packet to set its timeout to the default value.

EMBER_LINK_POWER_DELTA_INTERVAL#

#define EMBER_LINK_POWER_DELTA_INTERVAL

300

EMBER_APS_UNICAST_MESSAGE_COUNT#

#define EMBER_APS_UNICAST_MESSAGE_COUNT

10

The maximum number of APS retried messages that the stack can transmit at any time. Here, transmitting describes the time between the call to emberSendUnicast() and the subsequent callback to emberMessageSentHandler().

Note

• A message will typically use one packet buffer for the message header and one or more packet buffers for the payload. The default is 10 messages.

Each APS retried message consumes 6 bytes of RAM and two or more packet buffers.

SL_ZIGBEE_APS_DUPLICATE_REJECTION_MAX_ENTRIES#

#define SL_ZIGBEE_APS_DUPLICATE_REJECTION_MAX_ENTRIES

5

Size of 1 is basically the same thing as no duplicate rejection.

EMBER_BINDING_TABLE_SIZE#

#define EMBER_BINDING_TABLE_SIZE

0

The maximum number of bindings supported by the stack. The default is 0 bindings. Each binding consumes 2 bytes of RAM.

EMBER_ADDRESS_TABLE_SIZE#

#define EMBER_ADDRESS_TABLE_SIZE

8

The maximum number of EUI64<->network address associations that the stack can maintain. The default value is 8.

Address table entries are 10 bytes in size.

EMBER_ROUTE_TABLE_SIZE#

#define EMBER_ROUTE_TABLE_SIZE

16

The maximum number of destinations to which a node can route messages. This include both messages originating at this node and those relayed for others. The default value is 16.

Route table entries are 6 bytes in size.

EMBER_DISCOVERY_TABLE_SIZE#

#define EMBER_DISCOVERY_TABLE_SIZE

8

The number of simultaneous route discoveries that a node will support.

Discovery table entries are 9 bytes in size.

EMBER_MULTICAST_TABLE_SIZE#

#define EMBER_MULTICAST_TABLE_SIZE

8

The maximum number of multicast groups that the device may be a member of. The default value is 8.

Multicast table entries are 3 bytes in size.

EMBER_SOURCE_ROUTE_TABLE_SIZE#

#define EMBER_SOURCE_ROUTE_TABLE_SIZE

0

The number of source route table entries if the source route library is not included. The maximum source route table size is 255 entries, since a one-byte index is used, and the index 0xFF is reserved. The default value is 0.

Source route table entries are 4 bytes in size.

EMBER_MAX_SOURCE_ROUTE_RELAY_COUNT#

#define EMBER_MAX_SOURCE_ROUTE_RELAY_COUNT

11

EMBER_DEFAULT_BROADCAST_TABLE_SIZE#

#define EMBER_DEFAULT_BROADCAST_TABLE_SIZE

15

The maximum number of broadcasts during a single broadcast timeout period. The minimum and default value is 15 and can only be changed on compatible Ember stacks. Be very careful when changing the broadcast table size as it affects timing of the broadcasts and the number of possible broadcasts. Additionally, this value must be universal for all devices in the network. Otherwise, a single router can overwhelm all its neighbors with more broadcasts than they can support. In general, this value should be left alone.

Broadcast table entries are 6 bytes in size.

EMBER_BROADCAST_TABLE_SIZE#

#define EMBER_BROADCAST_TABLE_SIZE

EMBER_DEFAULT_BROADCAST_TABLE_SIZE

EMBER_RETRY_QUEUE_SIZE#

#define EMBER_RETRY_QUEUE_SIZE

16

EMBER_STORE_AND_FORWARD_QUEUE_SIZE#

#define EMBER_STORE_AND_FORWARD_QUEUE_SIZE

5

EMBER_ASSERT_SERIAL_PORT#

#define EMBER_ASSERT_SERIAL_PORT

1

Settings to control if and where assert information will be printed.

The output can be suppressed by defining EMBER_ASSERT_OUTPUT_DISABLED. The serial port to which the output is sent can be changed by defining EMBER_ASSERT_SERIAL_PORT as the desired port.

The default is to have the assert output on and sent to serial port 1.

EMBER_FRAGMENT_DELAY_MS#

#define EMBER_FRAGMENT_DELAY_MS

0

The time the stack will wait (in milliseconds) between sending blocks of a fragmented message. The default value is 0.

EMBER_FRAGMENT_MAX_WINDOW_SIZE#

#define EMBER_FRAGMENT_MAX_WINDOW_SIZE

8

The maximum number of blocks of a fragmented message that can be sent in a single window is defined to be 8.

EMBER_FRAGMENT_WINDOW_SIZE#

#define EMBER_FRAGMENT_WINDOW_SIZE

1

The number of blocks of a fragmented message that can be sent in a single window. The maximum is EMBER_FRAGMENT_MAX_WINDOW_SIZE. The default value is 1.

EMBER_REQUEST_KEY_TIMEOUT#

#define EMBER_REQUEST_KEY_TIMEOUT

0

The length of time that the device will wait for an answer to its Application Key Request. For the Trust Center, this is the time it will hold the first request and wait for a second matching request. If both arrive within this time period, the Trust Center will reply to both with the new key. If both requests are not received, the Trust Center will discard the request. The time is in minutes, with the maximum time being 10 minutes. A value of 0 minutes indicates that the Trust Center will not buffer the request but instead respond immediately. Only 1 outstanding request is supported at a time.

The Zigbee Pro Compliant value is 0.

EMBER_TRANSIENT_KEY_TIMEOUT_S#

#define EMBER_TRANSIENT_KEY_TIMEOUT_S

(300)

The length of time, in seconds, that a trust center will store a transient link key that a device can use to join its network. A transient key is added with a call to sl_zb_sec_man_import_transient_key. After the transient key is added, it will be removed once this amount of time has passed. A joining device will not be able to use that key to join until it is added again on the trust center. The default value is 300 seconds, i.e., 5 minutes.

EMBER_TRANSIENT_KEY_SESSION_TIMEOUT_VAL#

#define EMBER_TRANSIENT_KEY_SESSION_TIMEOUT_VAL

0xFFFF

A reserved emberTransientKeyTimeoutS value that, when stored with a "transient" key, prevents its removal from the transient key table when the session is active. Note that some standard security procedures (e.g. Zigbee Direct) require session keys to remain active indefinitely for the duration of the of the exchange.

EMBER_PAN_ID_CONFLICT_REPORT_THRESHOLD#

#define EMBER_PAN_ID_CONFLICT_REPORT_THRESHOLD

2

The number of PAN ID conflict reports that must be received by the network manager within one minute to trigger a PAN ID change. Very rarely, a corrupt beacon can pass the CRC check and trigger a false PAN id conflict. This is more likely to happen in very large dense networks. Setting this value to 2 or 3 dramatically reduces the chances of a spurious PAN ID change. The maximum value is 63. The default value is 2.

EMBER_MAX_NETWORK_RETRIES#

#define EMBER_MAX_NETWORK_RETRIES

15

The number of network level retries before network layer gives up sending a message, and return with an error. This could be seen as an extension to mac retries, and can take a range between 0..15. Setting the value to 0 disables network retries.

EMBER_ZIGBEE_NUM_NETWORK_RETRIES_DEFAULT#

#define EMBER_ZIGBEE_NUM_NETWORK_RETRIES_DEFAULT

15

EMBER_TASK_COUNT#

#define EMBER_TASK_COUNT

(5)

The number of event tasks that can be tracked for the purpose of processor idling. The Ember Zigbee Pro Stack requires two tasks, an application and associated libraries may use additional tasks, though typically no more than 5 are needed for most applications.

EMBER_MAX_SUPPORTED_NETWORKS#

#define EMBER_MAX_SUPPORTED_NETWORKS

2

The number of networks supported by the stack.

EMBER_SUPPORTED_NETWORKS#

#define EMBER_SUPPORTED_NETWORKS

1

EMBER_ZLL_GROUP_ADDRESSES#

#define EMBER_ZLL_GROUP_ADDRESSES

1

The number of unique group identifiers that this device requires.

EMBER_ZLL_RSSI_THRESHOLD#

#define EMBER_ZLL_RSSI_THRESHOLD

-128

The RSSI threshold applied to incoming scan requests.

EMBER_GP_PROXY_TABLE_SIZE#

#define EMBER_GP_PROXY_TABLE_SIZE

5

The number of proxy table entries supported.

EMBER_GP_SINK_TABLE_SIZE#

#define EMBER_GP_SINK_TABLE_SIZE

0

The number of sink table entries supported.

EMBER_GP_INCOMING_FC_TOKEN_TIMEOUT#

#define EMBER_GP_INCOMING_FC_TOKEN_TIMEOUT

7

The timeout (seconds) to restore the GPD incoming security frame counter in the Flash (0 being never).

EMBER_GP_INCOMING_FC_TOKEN_TABLE_SIZE#

#define EMBER_GP_INCOMING_FC_TOKEN_TABLE_SIZE

0

The maximum table size to restore the GPD incoming security frame counter in the Flash (being either 0 or EMBER_GP_PROXY_TABLE_SIZE).

EMBER_GP_INCOMING_FC_IN_SINK_TOKEN_TIMEOUT#

#define EMBER_GP_INCOMING_FC_IN_SINK_TOKEN_TIMEOUT

7

The timeout (seconds) to restore the GPD incoming security frame counter in the Flash (0 being never).

EMBER_GP_INCOMING_FC_IN_SINK_TOKEN_TABLE_SIZE#

#define EMBER_GP_INCOMING_FC_IN_SINK_TOKEN_TABLE_SIZE

0

The maximum table size to restore the GPD incoming security frame counter in the Flash (being either 0 or EMBER_GP_SINK_TABLE_SIZE).

EMBER_MULTI_NETWORK_MAX_ZC_AND_ZR_DEVICES_SUPPORTED#

#define EMBER_MULTI_NETWORK_MAX_ZC_AND_ZR_DEVICES_SUPPORTED

2

The maximum number of ZC and ZR devices can be supported in a multi network mode. All the ZC and ZR devices are expected to be on the same channel with different PAN IDs. Multi network with multiple ZC and ZR devices are supported only on EFR platform.

EMBER_MULTI_NETWORK_MAX_ZC_AND_ZR_DEVICES_SUPPORTED#

#define EMBER_MULTI_NETWORK_MAX_ZC_AND_ZR_DEVICES_SUPPORTED

EMBER_SUPPORTED_NETWORKS

The maximum number of ZC and ZR devices can be supported in a multi network mode. All the ZC and ZR devices are expected to be on the same channel with different PAN IDs. Multi network with multiple ZC and ZR devices are supported only on EFR platform.

NETWORK_0_ZC_AND_ZR_COUNT#

#define NETWORK_0_ZC_AND_ZR_COUNT

(1)

The number of ZC and ZR device types are present in the application. This configuration is used to expand the various stack tables and events required to support the multi PAN application. Note that for SoC, this define is generated by app builder based on the device type(s) present in the application.

NETWORK_1_ZC_AND_ZR_COUNT#

#define NETWORK_1_ZC_AND_ZR_COUNT

(0)

EMBER_ZC_AND_ZR_DEVICE_COUNT#

#define EMBER_ZC_AND_ZR_DEVICE_COUNT

(NETWORK_0_ZC_AND_ZR_COUNT + NETWORK_1_ZC_AND_ZR_COUNT)

SL_ZIGBEE_TRANSIENT_DEVICE_MGMT_MAX_CAPACITY#

#define SL_ZIGBEE_TRANSIENT_DEVICE_MGMT_MAX_CAPACITY

64

SL_ZIGBEE_TRANSIENT_DEVICE_DEFAULT_TIMEOUT_MS#

#define SL_ZIGBEE_TRANSIENT_DEVICE_DEFAULT_TIMEOUT_MS

(10000u)

SL_ZIGBEE_ENABLE_APS_ACKS_FOR_COMMANDS#

#define SL_ZIGBEE_ENABLE_APS_ACKS_FOR_COMMANDS

(false)

EMBER_CUSTOM_MAC_FILTER_TABLE_SIZE#

#define EMBER_CUSTOM_MAC_FILTER_TABLE_SIZE

2

SL_ZIGBEE_ZDO_BEACON_SURVEY_MAX_UNIQUE_NETWORKS#

#define SL_ZIGBEE_ZDO_BEACON_SURVEY_MAX_UNIQUE_NETWORKS

8

The 802.15.4 CCA mode that should be used at startup. The default value is RAIL_IEEE802154_CCA_MODE_RSSI. This value is configured in the radio during initialization. The user may override this value at runtime using emberSetRadioIeee802154CcaMode.

Note

• The value of this macro is used at startup for SoC and NCP applications only. A host application does not use this value, nor does it set the CCA mode at startup by default.

the number of beacons to store when performing a beacon survey scan