Advanced device parameters
These are advanced parameters for Coordinator, Router, and End Device.
Advanced device parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
AF Parameters |
|||
- |
|||
AIB Parameters |
|||
APS Designated Coordinator(read only) |
Indicates that on start-up the node should assume the Coordinator role within the network. |
• true for Coordinator |
true / false |
APS Use Extended PAN ID |
Indicates the Extended PAN ID (EPID) that the device will use. This is the globallyunique 64-bit identifier for the network. This identifier is used to avoid PAN ID conflicts between distinct net- works and must be unique among the networks overlappingin a given area. If the value is zero on the Coordinator, the device will use its own IEEE/MAC address as the EPID. A zero value on a Router/End Device means that the device will not look for a particular EPID when joining a network. |
Default Extended PAN ID |
64 bits |
APS Inter-frame Delay |
Number of milliseconds between APS data frames. Following transmission of each data block, the APS starts a timer. If there are more unacknowledged blocks to send in the current transmission window, then, after a delay of apsInterframeDelaymilliseconds, the next block is passed to the NWK data service. Otherwise, the timer is set to apscAckWaitDuration seconds. |
10 |
10-255 |
APS Max Window Size |
APS fragmented data window size. Fragmentation is a way of sending messages (APDUs) longer than the payload of a single NPDU. The ASDU is segmented and split across a number of NPDUs, then reassembled at thedestination. APS Max Window Size defines how many fragments are sent before an acknowledgment is expected. For example, if APS Max Window Size is set to 4 anda message is split into 16 fragments, then an acknowledgment is expected after sending fragments 1-4. Sending offragments 5-8 does not commence until this acknowledgment is received. |
8 |
1-8 |
APS Non-member Radius |
Multicast non-member radius size. Defines the number of hops away from the core multi-cast members that a multi-cast transmission can be received. |
2 |
0-7 |
APS Security Timeout Period |
Authentication timeout period in milliseconds for nodes joining the network. If either the initiator or responder waits for an expected incoming message for a time greater than APS Security Timeout Period, then a TIMEOUT error is generated. |
1000(6000 is advised) |
|
APS Use Insecure Join |
Controls action when a secured network rejoin fails. If true, a join using the MAC layer association procedure is performedwhen a secure rejoin fails. |
true |
true / false |
APS Layer Configuration Parameters |
|||
APS Duplicate Table Size |
The size of the APS layer duplicate rejection table. This removes duplicated APS packets. |
8 |
1 or higher |
APS Persistence Time |
Time, in milliseconds, for which the resources associated with an incoming fragmented message will be retained after the complete message has been received. |
100 |
1-255 |
Maximum Number of Simultaneous Data Requests |
The maximum number of simultaneous APSDE data requests without APS acknowledgments. Should be set to the maximum number of target nodes in one bound transmission. |
5 |
1 or higher |
Maximum Number of Simultaneous Data Requests with Acks |
The maximum number of simultaneous APSDE data requests with APS acknowledgments. Should be set to the maximum number of target nodes in one bound transmission. |
3 |
1 or higher |
Inter PAN |
True if inter PAN functionality is enabled, see Section 6.5.1.5 |
false |
true or false |
APS Poll Period |
The polling period, in milliseconds, of a sleeping End Device collecting data of any kind (received messages, received fragmented messages and all transmit acknowledgments). |
100 |
25 or higher |
Maximum Number of Received Simultaneous Fragmented Messages |
Maximum number of simultaneous fragmented APSDE incoming data requests. Set to a non-zero value to enable reception of fragmented messages (note that doing this increases the stack size). |
0 |
1 or higher |
Maximum Number of Transmitted Simultaneous Fragmented Messages |
Maximum number of simultaneous fragmented APSDE outgoing data requests. Set to a non-zero value to enabletransmission of fragmented messages (note that doing this increases the stack size). |
0 |
1 or higher |
Network Layer Configuration Parameters for Coordinator and Routers |
|||
Active Neighbor Table Size |
Size of the active Neighbor table. Each routing node (Coordinator or Router) has a Neighbor table which must be large enough to accommodate entries for the node’s immediate children, for its own parent and, in a Mesh network, for all peer Routers with which the node has direct radio communication. |
26 |
1 or higher |
Child Table Size |
Size of the persisted sub-table of the active Neighbor table. This sub-table contains entries for the node’s parent and immediate children. This value therefore determines the number of children that the node is allowed to have. It is one greater than thepermitted number of children, for example, with the default value of 5, up to 4 children are allowed.This value must not be greater than two- thirds of the Active Neighbor Table Size value. |
5 |
1 or higher |
Address Map Table Size |
Size of the address map, which maps 64- bit IEEE addresses to 16-bit network (short) addresses. Should be set to the number of nodes in the network. |
10 |
1 or higher |
Broadcast Transaction Table Size |
Size of broadcast transaction table. The broadcast transaction table stores the broadcast transaction records, which are records of the broadcast messages received by the node. |
9 |
1 or higher |
Discovery Neighbor Table Size |
Size of the Discovery Neighbor table. This table keeps a list of the neighboring devices associated with the node. |
8 |
8-16 |
Route Discovery Table Size |
Size of the Route Discovery table.This table is used by the node to store temporary information used during route discovery. Route Discovery table entries last only as long as the duration of a single route discovery operation. |
2 |
1 or higher |
Route Record Table Size |
Size of the Route Record table. Each route record contains the destination network address, a count of the number of relay nodes to reach the destination, and a list of the network addresses of the relay nodes. |
1 |
1 or higher |
Routing Table Size |
Size of the Routing table. This table stores the information required for the nodeto participate in the routing of message packets. Each table entry contains the destination address, the status of the route, various flags and the network address of the next hop on the way to the destination. A Routing table entry is made when a new route is initiated by the node or routed via the node. The entry is stored in the Routing table and is read whenever that route is used; the entry is only deleted if the route is no longer valid. A node is said to have routing capacity if there are free entries in the routing table. |
70 |
1 or higher |
Security Material Sets |
Number of supported network keys. |
2 |
1 or higher |
Network Layer Configuration Parameters for End Devices |
|||
Active Neighbor Table Size |
Size of the active Neighbor table. Set to one (for the parent). |
2 |
1 |
Address Map Table Size |
Size of the address map, which maps 64- bit IEEE addresses to 16-bit network (short) addresses. Should be set to the number of nodes that the End Device applicationneeds to communicate with plus one (for the parent). |
10 |
1 or higher |
Broadcast Transaction Table Size |
Size of broadcast transaction table. The broadcast transaction table stores the broadcast transaction records, which are records of the broadcast messages received by the node. |
9 |
1 or higher |
Discovery Neighbor Table Size |
Size of the Discovery Neighbor table. This table keeps a list of the neighboring devices associated with the node. |
8 |
8-16 |
Route Discovery Table Size |
Not applicable - set to one. |
2 |
1 |
Route Record Table Size |
Not applicable - set to one. |
1 |
1 |
Routing Table Size |
Not applicable - set to one. |
70 |
1 |
Security Material Sets |
Number of supported network keys. |
2 |
1 or higher |
Stack Profile |
The ZigBee Stack Profile which defines the stack features supported. Set to one for ZigBee, two for ZigBee PRO or any other value for a private stack profile. |
2 |
0 to 15 |
Endpoint parameters
Endpoint parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Application Device Id |
Device ID for the endpoint. |
||
Application Device Version |
Version number for the device. |
||
Enabled |
Whether the endpoint is enabled or disabled. |
true |
true / false |
End Point Id |
The endpoint number (must be unique within the network). |
1-240 |
|
Name |
Textual name for the endpoint. Used as a prefix when generating macro definitions. |
Valid C identifier |
|
Profile |
The application profile for the endpoint. This as a link to a profile definition. |
Input Cluster
Specifies that the endpoint will receive for the specified cluster.
Input cluster parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Cluster |
A link to an input cluster that will receive on the endpoint. |
||
Receive APDU |
A link to an APDU that will buffer any incoming messages. |
||
Discoverable |
Defines whether the input cluster will be present in the endpoints simple descriptor which is used for service discovery. |
true |
true / false |
Output cluster
Specifies that the endpoint will transmit for the specified cluster.
Output cluster parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Cluster |
A link to an output cluster that will transmit on the endpoint. |
- |
- |
Transmit APDUs |
List of APDUs that will be used to transmit the cluster. |
- |
- |
Discoverable |
Defines whether the input cluster will be present in the endpoints Simple descriptor which is used for service dis- covery. |
true |
true / false |
Parent topic:Advanced device parameters
Bound addressing table
Specifies that the device should include a Binding table. Binding is optional. If Binding tables are used, they are located on any node which is a source for a binding, but the ZigBee Coordinator handles end device bind requests on behalf of all devices in the network. Nodes that use Binding tables should be allocated enough Binding table entries to handle their own communication needs.
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Size |
The size of the Binding table. Each binding table entry contains: |
Parent topic:Advanced device parameters
PDU Manager
The Protocol Data Unit Manager (PDUM) configuration is mandatory and must always be present.
PDU Manager parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Number of NPDUs |
The number of NPDUs available to the ZigBee stack. These are internal to the stack. |
16 |
8 or higher |
APDU
Specifies a buffer to contain instances of a cluster.
APDU parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Instances |
The maximum number of instances of this APDU. Note that this value must be greater than the value of the parameter Maximum Number of Simultaneous Data Requests with Acks - see Advanced device parameters. |
||
Name |
The name of the APDU. This is the identifier that should be used in the application C code to refer to the APDU. |
Valid C identifier |
|
Size |
The maximum size of the APDU. |
Parent topic:Advanced device parameters
Group Addressing table
Specifies that the device contains a Group table.
Group Addressing table parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Size |
The size of the Group table. Group membership for endpoints on the current device is controlled by adding and removing entries in the Group table. |
- |
- |
Parent topic:Advanced device parameters
RF channels
Specifies the default RF channels that the device will operate on. If not present, the default will be all channels.
RF channel parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Channel x |
Control for channel x – setting to true includes the channel in energy scan. By default, only channel 15 is included. |
true for x=15, false for all other values |
true / false |
Parent topic:Advanced device parameters
MAC interface table
Specifies the number of interfaces which are present on this device. One interface must be setup.
MAC interface table parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Channel List size (Needs to be set to 1 if only 2.4g) |
Number of channel masks |
1 |
No value ranges |
Enabled |
Is interface enabled/disabled |
Enabled |
TRUE/FALSE |
Index |
Index of the entry |
0 |
0 to channel list size |
Radio Type |
2.4G or SubGig |
RT2400MHz |
RT2400MHz/ RT868MHz/ RT915MHz |
Routers Allowed |
Are routers allowed on this interface |
FALSE |
TRUE/FALSE |
Parent topic:Advanced device parameters
Node descriptor
This is mandatory and defines the type and capabilities of the node.
Node descriptor parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Descriptor Availability Parameters |
|||
Complex Descriptor Available |
Complex descriptors are not supported. Not editable. |
false |
false |
User Descriptor Available |
Indicates whether a user descriptor is present. Not editable. |
false |
true / false |
Descriptor Capabilities Parameters |
|||
Extended Active Endpoint List Available |
Indicates whether an extended active endpoint list is available. Not editable. |
false |
false |
Extended Simple Descriptor List Available |
Indicates whether an extended simple descriptor list is available. Not editable. |
false |
false |
MAC Capability Flags |
|||
Allocate Address |
Indicates whether the device allocates short (network) addresses or not. Not editable. |
true / false |
|
Alternate PAN Coordinator |
Indicates whether the device acts as an alternative PAN Coordinator. Not editable. |
true / false |
|
Device type |
Indicates whether the device is a Full Functionality Device (FFD) or Reduced Functionality Device (RFD). Not editable. |
true / false |
|
Power source |
Indicates whether the device is mains powered or not. Not editable. |
true / false |
|
Rx On When Idle |
Indicates whether the device has its receiver enabled while the device is idle. Not editable. |
true / false |
|
Security |
Indicates whether the device uses high or standard security. Only standard security is supported. Not editable. |
false |
true / false |
Miscellaneous parameters |
|||
APS flags |
Not editable. |
0 |
0 |
Frequency Band |
Frequency band of radio. The the JN518x and K32W041/K32W061/K32W1/MCXW71/ MCXW72/RW612 devices only support the 2.4 GHz band. Not editable. |
2.4 GHz |
2.4 GHz |
Logical Type |
The device type: Coordinator, Router, or End Device. Not editable. |
ZC/ZR/ZED |
|
Manufacturer Code |
The manufacturer ID code. The ZigBee Alliance allocates this code. |
0 - 65535 |
|
Maximum buffer size |
The maximum buffer size. Not editable. |
127 |
|
Maximum incoming transfer size |
The maximum incoming transfer size supported by the device. This is calculated from the APDU sizes for input clusters. Not editable. |
||
Maximum outgoing transfer size |
The maximum incoming transfer size supported by the device. This is calculated from the APDU sizes for output clusters. Not editable |
||
System Server Capabilities parameters |
|||
Backup binding table cache |
Indicates if the node can act as a back-up binding table cache. Not supported and not editable. |
false |
true / false |
Backup discovery cache |
Indicates if the node can act as a back-up discovery cache. Not supported and not editable. |
false |
true / false |
Backup trust center |
Indicates if the node can act as a back- up trust centre. Not supported and not editable. |
false |
true / false |
Network manager |
Indicates if the node can act as a net- work manager. Not editable. |
false |
true / false |
Primary binding table cache |
Indicates if the node can act as a primary binding table cache. Not supported and not editable. |
false |
true / false |
Primary discovery cache |
Indicates if the node can act as a primary discovery cache. Not supported and not editable. |
false |
true / false |
Primary trust center |
Indicates if the node can act as a trust center. Not editable. |
false |
true / false |
Parent topic:Advanced device parameters
Node Power Descriptor
The Node Power descriptor for the device is mandatory.
Node Power Descriptor Parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Available Power Sources parameters |
|||
Constant power |
Indicates whether a constant power source is available. |
false |
true / false |
Disposable Battery |
Indicates whether a disposable battery power source is available. |
false |
true / false |
Rechargeable Battery |
Indicates whether a rechargeable battery power source is available. |
false |
true / false |
Miscellaneous parameters |
|||
Default power mode |
The default power mode of the device. |
Synchronized with RxOn- WhenIdle |
Synchronized with RxOnWhenIdle / Periodic / Constant Power |
Default power source |
The default power source of the device. |
Constant / rechargeable / disposable |
Constant |
Parent topic:Advanced device parameters
Key Descriptor table
Specifies that the device should contain a Key Descriptor Table (for APS security).
Key Descriptor table parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Size |
The size of the key descriptor table. |
1 or higher |
Preconfigured Key
Specifies a pre-configured link key for the Key Descriptor Table.
Preconfigured Key parameters
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
IEEE address |
The IEEE address to use with the key. |
- |
64 bit |
Key |
The pre-configured key value. |
- |
128 bit |
Parent topic:Advanced device parameters
Trust Centre
Specifies that the device will have the capability to act as a Trust Centre.
Parameter Name |
Description |
Default Value |
Range |
|---|---|---|---|
Device Table Size |
The size of the Trust Centre’s device table. |
Maximum Number of Nodes setting from the ZigBee PRO Wireless Network |
1 or higher |
A Trust Centre link key must be pre-set in the Key Descriptor Table (see Section12.7.9) on each node.
Parent topic:Advanced device parameters
Parent topic:ZigBee network parameters