ZigBee Device Object (ZDO) functions included in the stack.
See ZigBee Device Object for documentation.
License#
Copyright 2018 Silicon Laboratories Inc. www.silabs.com
The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.
/***************************************************************************/
#ifndef SILABS_ZIGBEE_DEVICE_STACK_H
#define SILABS_ZIGBEE_DEVICE_STACK_H
EmberStatus emberNetworkAddressRequest(EmberEUI64 target,
bool reportKids,
uint8_t childStartIndex);
EmberStatus emberIeeeAddressRequest(EmberNodeId target,
bool reportKids,
uint8_t childStartIndex,
EmberApsOption options);
EmberStatus emberIeeeAddressRequestToTarget(EmberNodeId discoveryNodeId,
bool reportKids,
uint8_t childStartIndex,
EmberApsOption options,
EmberNodeId targetNodeIdOfRequest);
EmberStatus emberEnergyScanRequest(EmberNodeId target,
uint32_t scanChannels,
uint8_t scanDuration,
uint16_t scanCount);
#ifdef DOXYGEN_SHOULD_SKIP_THIS
EmberStatus emberSetNetworkManagerRequest(EmberNodeId networkManager,
uint32_t activeChannels);
#else
#define emberSetNetworkManagerRequest(manager, channels) \
(emberEnergyScanRequest(EMBER_SLEEPY_BROADCAST_ADDRESS, \
(channels), \
0xFF, \
(manager)))
#endif
#ifdef DOXYGEN_SHOULD_SKIP_THIS
EmberStatus emberChannelChangeRequest(uint8_t channel);
#else
#define emberChannelChangeRequest(channel) \
(emberEnergyScanRequest(EMBER_SLEEPY_BROADCAST_ADDRESS, \
BIT32(channel), \
0xFE, \
0))
#endif
EmberStatus emberSendDeviceAnnouncement(void);
EmberStatus emberSendParentAnnouncement(void);
uint8_t emberGetLastStackZigDevRequestSequence(void);
void emberSetZDOConfigurationMode(bool enabled);
void emberSetPendingNetworkUpdateChannel(uint8_t channel);
#endif // SILABS_ZIGBEE_DEVICE_STACK_H
Functions#
Request the 16 bit network address of a node whose EUI64 is known.
Request the EUI64 of a node whose 16 bit network address is known.
Request that an energy scan be performed and its results returned. This request may only be sent by the current network manager and must be unicast, not broadcast.
Broadcast a request to set the identity of the network manager and the active channel mask. The mask is used when scanning for the network after missing a channel update.
Broadcast a request to change the channel. This request may only be sent by the current network manager. A several second delay occurs from receipt of the broadcast to changing the channel to allow time for the broadcast to propagate.
Send a broadcast for a ZDO Device announcement. Normally, it is NOT required to call this as the stack automatically sends a device announcement during joining or rejoining, as per the spec.
Send a broadcast for a ZDO Parent Announcement. Normally, it is NOT required to call this as the stack automatically sends a Parent Announce when a Zigbee Router/Coordinator reboots, is in a joined or authenticated state, and has at least one device.
Provide access to the stack ZDO transaction sequence number for the last request.
Set the ZDO (WWAH) configuration mode in the stack. ZDO configuration mode is used to enable/disable ZDO command processing and to protect the device from unauthorized configuration changes during normal operation.
Set the channel number the device will accept in ZDO Mgmt Network Update command to change channel.
Function Documentation#
emberNetworkAddressRequest#
EmberStatus emberNetworkAddressRequest (EmberEUI64 target, bool reportKids, uint8_t childStartIndex)
Request the 16 bit network address of a node whose EUI64 is known.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberEUI64 | N/A | target | The EUI64 of the node. |
| bool | N/A | reportKids | True to request that the target list their children in the response. |
| uint8_t | N/A | childStartIndex | The index of the first child to list in the response. Ignored if |
Returns
An EmberStatus value.
EMBER_SUCCESS - The request was transmitted successfully.
EMBER_NO_BUFFERS - Insufficient message buffers were available to construct the request.
EMBER_NETWORK_DOWN - The node is not part of a network.
EMBER_NETWORK_BUSY - Transmission of the request failed.
emberIeeeAddressRequest#
EmberStatus emberIeeeAddressRequest (EmberNodeId target, bool reportKids, uint8_t childStartIndex, EmberApsOption options)
Request the EUI64 of a node whose 16 bit network address is known.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | target | The network address of the node. |
| bool | N/A | reportKids | True to request that the target list their children in the response. |
| uint8_t | N/A | childStartIndex | The index of the first child to list in the response. Ignored if reportKids is false. |
| EmberApsOption | N/A | options | The options to use when sending the request. See emberSendUnicast() for a description. |
Returns
emberIeeeAddressRequestToTarget#
EmberStatus emberIeeeAddressRequestToTarget (EmberNodeId discoveryNodeId, bool reportKids, uint8_t childStartIndex, EmberApsOption options, EmberNodeId targetNodeIdOfRequest)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | discoveryNodeId | |
| bool | N/A | reportKids | |
| uint8_t | N/A | childStartIndex | |
| EmberApsOption | N/A | options | |
| EmberNodeId | N/A | targetNodeIdOfRequest |
emberEnergyScanRequest#
EmberStatus emberEnergyScanRequest (EmberNodeId target, uint32_t scanChannels, uint8_t scanDuration, uint16_t scanCount)
Request that an energy scan be performed and its results returned. This request may only be sent by the current network manager and must be unicast, not broadcast.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | target | The network address of the node to perform the scan. |
| uint32_t | N/A | scanChannels | A mask of the channels to be scanned. |
| uint8_t | N/A | scanDuration | How long to scan on each channel. Allowed values are 0..5, with the scan times as specified by 802.15.4 (0 = 31 ms, 1 = 46 ms, 2 = 77 ms, 3 = 138 ms, 4 = 261 ms, 5 = 507 ms). |
| uint16_t | N/A | scanCount | The number of scans to be performed on each channel (1 .. 8). |
Returns
emberSetNetworkManagerRequest#
EmberStatus emberSetNetworkManagerRequest (EmberNodeId networkManager, uint32_t activeChannels)
Broadcast a request to set the identity of the network manager and the active channel mask. The mask is used when scanning for the network after missing a channel update.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | networkManager | The network address of the network manager. |
| uint32_t | N/A | activeChannels | The new active channel mask. |
Returns
emberChannelChangeRequest#
EmberStatus emberChannelChangeRequest (uint8_t channel)
Broadcast a request to change the channel. This request may only be sent by the current network manager. A several second delay occurs from receipt of the broadcast to changing the channel to allow time for the broadcast to propagate.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | channel | The channel to change to. |
Returns
emberSendDeviceAnnouncement#
EmberStatus emberSendDeviceAnnouncement (void )
Send a broadcast for a ZDO Device announcement. Normally, it is NOT required to call this as the stack automatically sends a device announcement during joining or rejoining, as per the spec.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
May be used to re-send the device announcement.
Returns
emberSendParentAnnouncement#
EmberStatus emberSendParentAnnouncement (void )
Send a broadcast for a ZDO Parent Announcement. Normally, it is NOT required to call this as the stack automatically sends a Parent Announce when a Zigbee Router/Coordinator reboots, is in a joined or authenticated state, and has at least one device.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
May be used to re-send the parent announcement.
Returns
emberGetLastStackZigDevRequestSequence#
uint8_t emberGetLastStackZigDevRequestSequence (void )
Provide access to the stack ZDO transaction sequence number for the last request.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
The last stack ZDO transaction sequence number used.
emberSetZDOConfigurationMode#
void emberSetZDOConfigurationMode (bool enabled)
Set the ZDO (WWAH) configuration mode in the stack. ZDO configuration mode is used to enable/disable ZDO command processing and to protect the device from unauthorized configuration changes during normal operation.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | enabled |
emberSetPendingNetworkUpdateChannel#
void emberSetPendingNetworkUpdateChannel (uint8_t channel)
Set the channel number the device will accept in ZDO Mgmt Network Update command to change channel.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | channel | A pending network update channel number. |
If a ZDO Mgmt Network Update command is received by the device specifying a channel that does not match with the given channel, the ZDO Mgmt Network Update command will be ignored by the device. A value of 0xFF indicates that any channel received in a ZDO Mgmt Network Update command will be accepted which is also the default value set by the stack.