Configuration#
All configurations have defaults. Therefore, many applications may not need to do anything custom. However, these defaults can be overridden by creating a CONFIGURATION_HEADER or within this header, defining the appropriate macro to a different size. For example, to reduce the number of allocated packet buffers from 24 (the default) to 8:
#define EMBER_PACKET_BUFFER_COUNT 8
The convenience stubs provided in config/ember-configuration.c can be overridden by defining the appropriate macro and providing the corresponding callback function. For example, an application with custom debug channel input must implement emberDebugHandler() to process it. Along with the function definition, the application should provide the following line in its CONFIGURATION_HEADER:
#define EMBER_APPLICATION_HAS_DEBUG_HANDLER
See ember-configuration-defaults.h for source code.
Macros#
The major version number of the Ember stack release that the application is built against.
The minor version number of the Ember stack release that the application is built against.
Specify the stack profile. The default is Profile 0.
The maximum number of end device children that a router will support.
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).
The maximum number of children that a node may have.
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.
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.
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.
The maximum number of hops for a message.
The number of Packet Buffers available to the Stack. The default is 75.
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.
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.
The maximum number of router neighbors the stack can keep track of.
The maximum amount of time (in milliseconds) that the MAC will hold a message for indirect transmission to a child.
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.
The default index into the R21 Child Aging timeout The default value is a timeout of 256 minutes.
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.
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().
The maximum number of bindings supported by the stack. The default is 0 bindings. Each binding consumes 2 bytes of RAM.
The maximum number of EUI64<->network address associations that the stack can maintain. The default value is 8.
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.
The number of simultaneous route discoveries that a node will support.
The maximum number of multicast groups that the device may be a member of. The default value is 8.
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.
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.
Settings to control if and where assert information will be printed.
The time the stack will wait (in milliseconds) between sending blocks of a fragmented message. The default value is 0.
The maximum number of blocks of a fragmented message that can be sent in a single window is defined to be 8.
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.
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 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 emberAddTransientLinkKey. 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.
The time the coordinator will wait (in seconds) for a second end device bind request to arrive. The default value is 60.
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.
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.
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.
The number of networks supported by the stack.
The number of unique group identifiers that this device requires.
The RSSI threshold applied to incoming scan requests.
The number of proxy table entries supported.
The number of sink table entries supported.
The timeout (seconds) to restore the GPD incoming security frame counter in the Flash (0 being never).
The maximum table size to restore the GPD incoming security frame counter in the Flash (being either 0 or EMBER_GP_PROXY_TABLE_SIZE).
The timeout (seconds) to restore the GPD incoming security frame counter in the Flash (0 being never).
The maximum table size to restore the GPD incoming security frame counter in the Flash (being either 0 or EMBER_GP_SINK_TABLE_SIZE).
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.
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.
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.