zigbee-device-host_8h | EmberZNET API Reference Guide | | v6.9

ZigBee Device Object (ZDO) functions not provided by the stack. See ZigBee Device Object (ZDO) Information for documentation.

License#

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.

/***************************************************************************/
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 ezspMatchDescriptorsRequest(EmberNodeId target,
                                        uint16_t profile,
                                        uint8_t inCount,
                                        uint8_t outCount,
                                        uint16_t *inClusters,
                                        uint16_t *outClusters,
                                        EmberApsOption options);
EmberStatus ezspEndDeviceBindRequest(EmberNodeId localNodeId,
                                     EmberEUI64 localEui64,
                                     uint8_t endpoint,
                                     uint16_t profile,
                                     uint8_t inCount,
                                     uint8_t outCount,
                                     uint16_t *inClusters,
                                     uint16_t *outClusters,
                                     EmberApsOption options);
EmberNodeId ezspDecodeAddressResponse(uint8_t *response,
                                      EmberEUI64 eui64Return);

Device Discovery Functions#

EmberStatus

emberNetworkAddressRequest(EmberEUI64 target, bool reportKids, uint8_t childStartIndex)

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

EmberStatus

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

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

Service Discovery Functions#

EmberStatus

ezspMatchDescriptorsRequest(EmberNodeId target, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t *inClusters, uint16_t *outClusters, EmberApsOption options)

Binding Manager Functions#

EmberStatus

ezspEndDeviceBindRequest(EmberNodeId localNodeId, EmberEUI64 localEui64, uint8_t endpoint, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t *inClusters, uint16_t *outClusters, EmberApsOption options)

An end device bind request to the coordinator. If the coordinator receives a second end device bind request then a binding is created for every matching cluster.

Function to Decode Address Response Messages#

EmberNodeId

ezspDecodeAddressResponse(uint8_t *response, EmberEUI64 eui64Return)

Extracts the EUI64 and the node ID from an address response message.

Functions#

EmberStatus

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

Device Discovery Functions Documentation#

emberNetworkAddressRequest#

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

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

Parameters

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 `reportKids` is false.

Returns

An EmberStatus value.
- EMBER_SUCCESS - The request was transmitted successfully.
- EMBER_NO_BUFFERS - Insuffient 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.

Definition at line 114 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h

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.

Parameters

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

An EmberStatus value.

Definition at line 135 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h

Service Discovery Functions Documentation#

ezspMatchDescriptorsRequest#

EmberStatus ezspMatchDescriptorsRequest (EmberNodeId target, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t * inClusters, uint16_t * outClusters, EmberApsOption options)

Parameters

N/A	target	The node whose matching endpoints are desired. The request can be sent unicast or broadcast ONLY to the "RX-on-when-idle-address" (0xFFFD) If sent as a broadcast, any node that has matching endpoints will send a response.
N/A	profile	The application profile to match.
N/A	inCount	The number of input clusters. To not match any input clusters, set this value to 0.
N/A	outCount	The number of output clusters. To not match any output clusters, set this value to 0.
N/A	inClusters	The list of input clusters.
N/A	outClusters	The list of output clusters.
N/A	options	The options to use when sending the unicast request. See emberSendUnicast() for a description. This parameter is ignored if the target is a broadcast address.

Request the specified node to send a list of its endpoints that match the specified application profile and, optionally, lists of input and/or output clusters.

Returns

An EmberStatus value. EMBER_SUCCESS, EMBER_NO_BUFFERS, EMBER_NETWORK_DOWN or EMBER_NETWORK_BUSY.

Definition at line 173 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h

Binding Manager Functions Documentation#

ezspEndDeviceBindRequest#

EmberStatus ezspEndDeviceBindRequest (EmberNodeId localNodeId, EmberEUI64 localEui64, uint8_t endpoint, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t * inClusters, uint16_t * outClusters, EmberApsOption options)

An end device bind request to the coordinator. If the coordinator receives a second end device bind request then a binding is created for every matching cluster.

Parameters

N/A	localNodeId	The node ID of the local device.
N/A	localEui64	The EUI64 of the local device.
N/A	endpoint	The endpoint to be bound.
N/A	profile	The application profile of the endpoint.
N/A	inCount	The number of input clusters.
N/A	outCount	The number of output clusters.
N/A	inClusters	The list of input clusters.
N/A	outClusters	The list of output clusters.
N/A	options	The options to use when sending the request. See emberSendUnicast() for a description.

Returns

An EmberStatus value. EMBER_SUCCESS, EMBER_NO_BUFFERS, EMBER_NETWORK_DOWN or EMBER_NETWORK_BUSY.

Definition at line 205 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h

Function to Decode Address Response Messages Documentation#

ezspDecodeAddressResponse#

EmberNodeId ezspDecodeAddressResponse (uint8_t * response, EmberEUI64 eui64Return)

Extracts the EUI64 and the node ID from an address response message.

Parameters

N/A	response	The received ZDO message with cluster ID NETWORK_ADDRESS_RESPONSE or IEEE_ADDRESS_RESPONSE.
N/A	eui64Return	The EUI64 from the response is copied here.

Returns

Returns the node ID from the response if the response status was EMBER_ZDP_SUCCESS. Otherwise, returns EMBER_NULL_NODE_ID.

Definition at line 231 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h

Function Documentation#

emberIeeeAddressRequestToTarget#

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

Parameters

N/A	discoveryNodeId
N/A	reportKids
N/A	childStartIndex
N/A	options
N/A	targetNodeIdOfRequest

Definition at line 141 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/util/zigbee-framework/zigbee-device-host.h