Developing with ZBOSS for Zigbee
|
You can adjust the usage of the RAM memory at compile time by using one of the following methods:
Each of these methods gives a different granularity to the amount of the RAM memory used by the stack.
The ZBOSS stack comes with three predefined configuration files that can be included and used with any Zigbee application.
Configuration file | Usage | Maximum number of nodes |
---|---|---|
zb_mem_config_min.h | Simple applications and small networks. | 16 |
zb_mem_config_med.h | Applications without huge demands on Zigbee features, for example broadcast transmissions, binding and group membership entries. | 32 |
zb_mem_config_max.h | Complex applications and huge networks. | 128 |
To use any of the header files, include it in your main application file.
The following example shows how to configure medium-sized memory buffers.
You can use macro definitions to configure properties of the Zigbee solution. Each macro definition changes several parameters and is related to one property of the solution.
The following properties are available:
For information about how to set the selected macro definition, see Configuring properties.
For information about the default property values, see Parameter reference table.
The primary property is the device role. Use one of the following parameters to define it:
ZB_CONFIG_ROLE_ZED
ZB_CONFIG_ROLE_ZR
ZB_CONFIG_ROLE_ZC
The application complexity property affects:
You can use the following parameters to define the complexity of the application:
ZB_CONFIG_APPLICATION_SIMPLE
ZB_CONFIG_APPLICATION_MODERATE
ZB_CONFIG_APPLICATION_COMPLEX
The traffic load property affects:
You can use following parameters to define the estimated traffic load that goes through the device:
ZB_CONFIG_HIGH_TRAFFIC
ZB_CONFIG_MODERATE_TRAFFIC
ZB_CONFIG_LIGHT_TRAFFIC
You must define the maximum network size with the ZB_CONFIG_OVERALL_NETWORK_SIZE
parameter. The parameter value must be between 2 and 200.
Depending on the device type, set the maximum network size value:
To configure the properties, follow these steps.
zb_mem_config_common.h
– which translates defined symbols into values,zb_mem_config_context.h
– which overrides memory buffers used by the stack.You can use any of the predefined files mentioned in the Including a predefined header file method as reference.
The following example shows the memory configuration for a complex application with the end device role. The application communicates with around 50 nodes and does not expect a huge traffic load.
This is an advanced method. To use it, create your own header file with memory configuration (see Configuring properties).
If the selected method lacks in memory space for a particular property, redefine the value of the property parameter between the two includes in your header file.
An example of this override is commented out in each of the predefined configuration files (see Including a predefined header file).
The following table shows the parameters that you can adjust with this method.
Parameter name | Description |
---|---|
ZB_CONFIG_IEEE_ADDR_TABLE_SIZE | Address translation table size. |
ZB_CONFIG_IOBUF_POOL_SIZE | Number of packet buffers in the system. |
ZB_CONFIG_APS_BIND_TRANS_TABLE_SIZE | Table size for simultaneous transmissions to bound devices. |
ZB_CONFIG_APS_SRC_BINDING_TABLE_SIZE | Maximum number of entries in source_binding_table. See Organization of the binding table. |
ZB_CONFIG_APS_DST_BINDING_TABLE_SIZE | Maximum number of entries in destination_binding_table. See Organization of the binding table. |
ZB_CONFIG_APS_DUPS_TABLE_SIZE | Incoming APS duplicate detection table size. |
ZB_CONFIG_N_APS_KEY_PAIR_ARR_MAX_SIZE | Number of APS link-key pairs to store on the device. |
ZB_CONFIG_N_APS_RETRANS_ENTRIES | Number of parallel outgoing APS TX transactions (packets with ACK req 1). |
ZB_CONFIG_NEIGHBOR_TABLE_SIZE | Neighbor table size. |
ZB_CONFIG_NWK_ROUTING_TABLE_SIZE | Number of entries in the routing table. |
ZB_CONFIG_SCHEDULER_Q_SIZE | Callbacks queue, alarms queue size. |
ZB_CONFIG_MAC_PENDING_QUEUE_SIZE | Number of entries in the pending TX queue for ZR and ZC. |
ZB_CONFIG_NWK_MAX_SOURCE_ROUTES | Source route table capacity |
ZB_CONFIG_SCHEDULER_Q_SIZE_PROTECTED_STACK_POOL | Queue size reserved for the ZBOSS stack work |
ZB_CONFIG_SINGLE_TRANS_INDEX_SIZE | Count of buffers used for simultaneous transmissions to the bound devices |
ZB_CONFIG_BUF_POOL_BITMAP_SIZE | Size of bitmap storing state of each buffer |
The binding table stores binding entries, that is records composed of the following elements:
src_addr
src_endpoint
cluster_id
dst_address
dst_endpoint
In ZBOSS stack the binding table is split into the following minor tables:
src_addr
, src_endpoint
, and cluster_id
.ZB_CONFIG_APS_SRC_BINDING_TABLE_SIZE
dst_address
and dst_endpoint
.ZB_CONFIG_APS_DST_BINDING_TABLE_SIZE
Each entry in destination_binding_table is linked to its counterpart in source_binding_table by a 5-bit wide index. For this reason, ZB_CONFIG_APS_SRC_BINDING_TABLE_SIZE
is limited to 32, even though the total binding table size might be bigger in some configurations.
The following table shows the default values of parameters and how the parameters relate to each other.
(ZB_CONFIG_IOBUF_POOL_SIZE + 15)/16 * 4 | |||||||||||||
x | 32 | ||||||||||||
x | 24 | ||||||||||||
x | 16 | ||||||||||||
x | 32 | ||||||||||||
x | 24 | ||||||||||||
x | 16 | ||||||||||||
(ZB_CONFIG_APS_BIND_TRANS_TABLE_SIZE + 7) / 8 | |||||||||||||
x | 32 | ||||||||||||
x | 16 | ||||||||||||
x | 8 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE + (ZB_CONFIG_OVERALL_NETWORK_SIZE + 15)/16 * 4 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE + (ZB_CONFIG_OVERALL_NETWORK_SIZE + 15)/16 * 4 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
x | 48 | ||||||||||||
x | 32 | ||||||||||||
x | x | 32 | |||||||||||
x | x | 24 | |||||||||||
x | x | 20 | |||||||||||
x | x | x | ZB_CONFIG_IOBUF_POOL_SIZE / 4 | ||||||||||
x | x | x | ZB_CONFIG_IOBUF_POOL_SIZE / 4 | ||||||||||
x | x | x | ZB_CONFIG_IOBUF_POOL_SIZE / 4 | ||||||||||
x | 0 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
x | 4 | ||||||||||||
x | 4 | ||||||||||||
x | (ZB_CONFIG_IOBUF_POOL_SIZE + 8)/9 * 3 | ||||||||||||
x | (ZB_CONFIG_IOBUF_POOL_SIZE + 8)/9 * 3 | ||||||||||||
x | 6 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
x | x | 32 | |||||||||||
x | x | 16 | |||||||||||
x | x | 8 | |||||||||||
x | MAX(16, x) | ||||||||||||
x | x | x | ZB_CONFIG_NEIGHBOR_TABLE_SIZE | ||||||||||
x | x | x | ZB_CONFIG_NEIGHBOR_TABLE_SIZE | ||||||||||
x | x | x | 8 | ||||||||||
x | 0 | ||||||||||||
x | 48 | ||||||||||||
x | x | 48 | |||||||||||
x | x | x | 32 | ||||||||||
x | 22 | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
x | ZB_CONFIG_OVERALL_NETWORK_SIZE | ||||||||||||
12 | |||||||||||||
(ZB_CONFIG_IOBUF_POOL_SIZE + 7) / 8 |
AND
. The "x" sign in the same category represents the logical OR
. (Light traffic) AND (ZR OR ZED) | x | x | x |