Configuration
Macros | |
#define | EMBER_TASK_COUNT |
The number of event tasks that can be tracked for the purpose of processor idling. More... | |
#define | EMBER_HEAP_SIZE |
The size in bytes of the Ember heap. More... | |
#define | EMBER_CHILD_TABLE_SIZE |
The maximum number of children that a node may have set by default to 0. If the application includes the optional parent support stack feature, this should be adjusted accordingly. More... | |
#define | EMBER_CHILD_TABLE_TOKEN_SIZE |
#define | EMBER_CHILD_TIMEOUT_SEC |
Every child should exchange regularly some sort of traffic with the parent. Eventually, if traffic is not exchanged for a prolonged period of time, the parent will remove the child from the child table. Range extenders periodically exchange network-level commands with the coordinator. End devices and sleepy end devices can use emberPollForData() as keep alive mechanism. More... | |
#define | EMBER_INDIRECT_QUEUE_SIZE |
The maximum number of pending indirect packets set by default to 0. If the application includes the optional parent support stack feature, this should be adjusted accordingly. More... | |
#define | EMBER_MAC_OUTGOING_QUEUE_SIZE |
The maximum number of packets in the outgoing MAC queue set by default to 0. If the application includes the optional MAC queue stack feature, this should be adjusted accordingly. More... | |
#define | EMBER_INDIRECT_TRANSMISSION_TIMEOUT_MS |
The maximum amount of time (in milliseconds) that the MAC will hold a message for indirect transmission to a child. More... | |
#define | EMBER_MAX_INDIRECT_TRANSMISSION_TIMEOUT_MS |
#define | EMBER_NWK_RANGE_EXTENDER_UPDATE_PERIOD_SEC |
The period in seconds a range extender sends an update command to the coordinator containing the list of its children. More... | |
#define | EMBER_MAC_ACK_TIMEOUT_MS |
The ACK timeout in milliseconds. This parameter should be fine-tuned to reduce energy consumption for sleepy devices and depends on the data rate of the PHY configuration used. More... | |
#define | EMBER_RADIO_CCA_THRESHOLD |
The CCA threshold used at the MAC layer. More... | |
#define | EMBER_FREQUENCY_HOPPING_SEED |
The frequency hopping channel sequence generation seed. More... | |
#define | EMBER_FREQUENCY_HOPPING_START_CHANNEL |
The lowest channel on the frequency hopping list. More... | |
#define | EMBER_FREQUENCY_HOPPING_END_CHANNEL |
The highest channel on the frequency hopping list. More... | |
#define | EMBER_FREQUENCY_HOPPING_CHANNEL_DURATION_MS |
The time in milliseconds to stay on each channel for frequency hopping. More... | |
#define | EMBER_FREQUENCY_HOPPING_CHANNEL_GUARD_DURATION_MS |
The time in milliseconds to guard each channel while frequency hopping. No MAC activity is allowed when entering or exiting the slot. More... | |
#define | EMBER_FREQUENCY_HOPPING_SERVER_FREQ_INFO_BROADCAST_PERIOD_S |
The duration in seconds after which the server should broadcast its frequency hopping information to allow clients to realign. More... | |
#define | EMBER_FREQUENCY_HOPPING_CLIENT_RESYNC_PERIOD_S |
The duration in seconds after which the client should resync with the server if the last resync happened more than this duration ago. More... | |
Detailed Description
All configurations have defaults. Therefore, many applications may not need to do anything special. However, you can override these defaults by creating a CONFIGURATION_HEADER and, within this header, defining the appropriate macro to a different size.
See ember-configuration-defaults.h
for source code.
Macro Definition Documentation
#define EMBER_CHILD_TABLE_SIZE |
The maximum number of children that a node may have set by default to 0. If the application includes the optional parent support stack feature, this should be adjusted accordingly.
Definition at line 51
of file ember-configuration-defaults.h
.
#define EMBER_CHILD_TABLE_TOKEN_SIZE |
Definition at line 54
of file ember-configuration-defaults.h
.
#define EMBER_CHILD_TIMEOUT_SEC |
Every child should exchange regularly some sort of traffic with the parent. Eventually, if traffic is not exchanged for a prolonged period of time, the parent will remove the child from the child table. Range extenders periodically exchange network-level commands with the coordinator. End devices and sleepy end devices can use emberPollForData() as keep alive mechanism.
Definition at line 64
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_CHANNEL_DURATION_MS |
The time in milliseconds to stay on each channel for frequency hopping.
Definition at line 142
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_CHANNEL_GUARD_DURATION_MS |
The time in milliseconds to guard each channel while frequency hopping. No MAC activity is allowed when entering or exiting the slot.
Definition at line 149
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_CLIENT_RESYNC_PERIOD_S |
The duration in seconds after which the client should resync with the server if the last resync happened more than this duration ago.
Definition at line 163
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_END_CHANNEL |
The highest channel on the frequency hopping list.
Definition at line 135
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_SEED |
The frequency hopping channel sequence generation seed.
Definition at line 123
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_SERVER_FREQ_INFO_BROADCAST_PERIOD_S |
The duration in seconds after which the server should broadcast its frequency hopping information to allow clients to realign.
Definition at line 156
of file ember-configuration-defaults.h
.
#define EMBER_FREQUENCY_HOPPING_START_CHANNEL |
The lowest channel on the frequency hopping list.
Definition at line 129
of file ember-configuration-defaults.h
.
#define EMBER_HEAP_SIZE |
The size in bytes of the Ember heap.
Definition at line 43
of file ember-configuration-defaults.h
.
#define EMBER_INDIRECT_QUEUE_SIZE |
The maximum number of pending indirect packets set by default to 0. If the application includes the optional parent support stack feature, this should be adjusted accordingly.
Definition at line 72
of file ember-configuration-defaults.h
.
#define EMBER_INDIRECT_TRANSMISSION_TIMEOUT_MS |
The maximum amount of time (in milliseconds) that the MAC will hold a message for indirect transmission to a child.
The default is 8000 milliseconds (8 sec). The maximum value is 30 seconds (30000 milliseconds). Larger values will cause rollover confusion.
Definition at line 91
of file ember-configuration-defaults.h
.
#define EMBER_MAC_ACK_TIMEOUT_MS |
The ACK timeout in milliseconds. This parameter should be fine-tuned to reduce energy consumption for sleepy devices and depends on the data rate of the PHY configuration used.
Definition at line 111
of file ember-configuration-defaults.h
.
#define EMBER_MAC_OUTGOING_QUEUE_SIZE |
The maximum number of packets in the outgoing MAC queue set by default to 0. If the application includes the optional MAC queue stack feature, this should be adjusted accordingly.
Definition at line 80
of file ember-configuration-defaults.h
.
#define EMBER_MAX_INDIRECT_TRANSMISSION_TIMEOUT_MS |
Definition at line 93
of file ember-configuration-defaults.h
.
#define EMBER_NWK_RANGE_EXTENDER_UPDATE_PERIOD_SEC |
The period in seconds a range extender sends an update command to the coordinator containing the list of its children.
Definition at line 103
of file ember-configuration-defaults.h
.
#define EMBER_RADIO_CCA_THRESHOLD |
The CCA threshold used at the MAC layer.
Definition at line 117
of file ember-configuration-defaults.h
.
#define EMBER_TASK_COUNT |
The number of event tasks that can be tracked for the purpose of processor idling.
Definition at line 37
of file ember-configuration-defaults.h
.