ZigBee Device Object#
See zigbee-device-stack.h for source code.
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.
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.
| N/A | target | The EUI64 of the node. |
| N/A | reportKids | True to request that the target list their children in the response. |
| 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.
45 of file stack/include/zigbee-device-stack.hemberIeeeAddressRequest#
EmberStatus emberIeeeAddressRequest (EmberNodeId target, bool reportKids, uint8_t childStartIndex, EmberApsOption options)
Request the EUI64 of a node whose 16 bit network address is known.
| N/A | target | The network address of the node. |
| N/A | reportKids | True to request that the target list their children in the response. |
| N/A | childStartIndex | The index of the first child to list in the response. Ignored if reportKids is false. |
| N/A | options | The options to use when sending the request. See emberSendUnicast() for a description. |
Returns
65 of file stack/include/zigbee-device-stack.hemberIeeeAddressRequestToTarget#
EmberStatus emberIeeeAddressRequestToTarget (EmberNodeId discoveryNodeId, bool reportKids, uint8_t childStartIndex, EmberApsOption options, EmberNodeId targetNodeIdOfRequest)
| N/A | discoveryNodeId | |
| N/A | reportKids | |
| N/A | childStartIndex | |
| N/A | options | |
| N/A | targetNodeIdOfRequest |
70 of file stack/include/zigbee-device-stack.hemberEnergyScanRequest#
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.
| N/A | target | The network address of the node to perform the scan. |
| N/A | scanChannels | A mask of the channels to be scanned. |
| 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). |
| N/A | scanCount | The number of scans to be performed on each channel (1 .. 8). |
Returns
95 of file stack/include/zigbee-device-stack.hemberSetNetworkManagerRequest#
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.
| N/A | networkManager | The network address of the network manager. |
| N/A | activeChannels | The new active channel mask. |
Returns
114 of file stack/include/zigbee-device-stack.hemberChannelChangeRequest#
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.
| N/A | channel | The channel to change to. |
Returns
138 of file stack/include/zigbee-device-stack.hemberSendDeviceAnnouncement#
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.
| N/A |
May be used to re-send the device announcement.
Returns
157 of file stack/include/zigbee-device-stack.hemberSendParentAnnouncement#
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.
| N/A |
May be used to re-send the parent announcement.
Returns
170 of file stack/include/zigbee-device-stack.hemberGetLastStackZigDevRequestSequence#
uint8_t emberGetLastStackZigDevRequestSequence (void)
Provide access to the stack ZDO transaction sequence number for the last request.
| N/A |
Returns
The last stack ZDO transaction sequence number used.
178 of file stack/include/zigbee-device-stack.h