ZigBee Device Object
EmberZNet Stack API Reference

Functions

EmberStatus emberNetworkAddressRequest ( EmberEUI64 target, bool reportKids, uint8_t childStartIndex)
Requests the 16 bit network address of a node whose EUI64 is known.
EmberStatus emberIeeeAddressRequest ( EmberNodeId target, bool reportKids, uint8_t childStartIndex, EmberApsOption options)
Requests the EUI64 of a node whose 16 bit network address is known.
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)
Requests 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.
EmberStatus emberSetNetworkManagerRequest ( EmberNodeId networkManager, uint32_t activeChannels)
Broadcasts 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.
EmberStatus emberChannelChangeRequest (uint8_t channel)
Broadcasts 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.
EmberStatus emberSendDeviceAnnouncement (void)
Sends 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.
EmberStatus emberSendParentAnnouncement (void)
Sends 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.
uint8_t emberGetLastStackZigDevRequestSequence (void)
Provides access to the stack ZDO transaction sequence number for the last request.

Detailed Description

See zigbee-device-stack.h for source code.

Function Documentation

◆ emberChannelChangeRequest()

EmberStatus emberChannelChangeRequest ( uint8_t channel )

Broadcasts 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.

Parameters
channel The channel to change to.
Returns
An EmberStatus value.

◆ emberEnergyScanRequest()

EmberStatus emberEnergyScanRequest ( EmberNodeId target,
uint32_t scanChannels,
uint8_t scanDuration,
uint16_t scanCount
)

Requests 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.

Parameters
target The network address of the node to perform the scan.
scanChannels A mask of the channels to be scanned.
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).
scanCount The number of scans to be performed on each channel (1 .. 8).
Returns
An EmberStatus value.

◆ emberGetLastStackZigDevRequestSequence()

uint8_t emberGetLastStackZigDevRequestSequence ( void )

Provides access to the stack ZDO transaction sequence number for the last request.

Returns
The last stack ZDO transaction sequence number used.

◆ emberIeeeAddressRequest()

EmberStatus emberIeeeAddressRequest ( EmberNodeId target,
bool reportKids,
uint8_t childStartIndex,
EmberApsOption options
)

Requests the EUI64 of a node whose 16 bit network address is known.

Parameters
target The network address of the node.
reportKids True to request that the target list their children in the response.
childStartIndex The index of the first child to list in the response. Ignored if reportKids is false.
options The options to use when sending the request. See emberSendUnicast() for a description.
Returns
An EmberStatus value.

◆ emberIeeeAddressRequestToTarget()

EmberStatus emberIeeeAddressRequestToTarget ( EmberNodeId discoveryNodeId,
bool reportKids,
uint8_t childStartIndex,
EmberApsOption options,
EmberNodeId targetNodeIdOfRequest
)

◆ emberNetworkAddressRequest()

EmberStatus emberNetworkAddressRequest ( EmberEUI64 target,
bool reportKids,
uint8_t childStartIndex
)

Requests the 16 bit network address of a node whose EUI64 is known.

Parameters
target The EUI64 of the node.
reportKids True to request that the target list their children in the response.
childStartIndex The index of the first child to list in the response. Ignored if reportKids is false.
Returns
An EmberStatus value.

◆ emberSendDeviceAnnouncement()

EmberStatus emberSendDeviceAnnouncement ( void )

Sends 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.

May be used to re-send the device announcement.

Returns
An EmberStatus value.

◆ emberSendParentAnnouncement()

EmberStatus emberSendParentAnnouncement ( void )

Sends 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.

May be used to re-send the parent announcement.

Returns
An EmberStatus value.

◆ emberSetNetworkManagerRequest()

EmberStatus emberSetNetworkManagerRequest ( EmberNodeId networkManager,
uint32_t activeChannels
)

Broadcasts 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.

Parameters
networkManager The network address of the network manager.
activeChannels The new active channel mask.
Returns
An EmberStatus value.