ZigBee Device Object (ZDO) functions not provided by the stack. See ZigBee Device Object (ZDO) Information 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.

/***************************************************************************/
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#

emberNetworkAddressRequest(EmberEUI64 target, bool reportKids, uint8_t childStartIndex)

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

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#

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

Binding Manager Functions#

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#

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/Atarget

The EUI64 of the node.

N/AreportKids

true to request that the target list their children in the response.

N/AchildStartIndex

The index of the first child to list in the response. Ignored if reportKids is false.

Returns


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/Atarget

The network address of the node.

N/AreportKids

true to request that the target list their children in the response.

N/AchildStartIndex

The index of the first child to list in the response. Ignored if reportKids is false.

N/Aoptions

The options to use when sending the request. See emberSendUnicast() for a description.

Returns


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/Atarget

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/Aprofile

The application profile to match.

N/AinCount

The number of input clusters. To not match any input clusters, set this value to 0.

N/AoutCount

The number of output clusters. To not match any output clusters, set this value to 0.

N/AinClusters

The list of input clusters.

N/AoutClusters

The list of output clusters.

N/Aoptions

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/AlocalNodeId

The node ID of the local device.

N/AlocalEui64

The EUI64 of the local device.

N/Aendpoint

The endpoint to be bound.

N/Aprofile

The application profile of the endpoint.

N/AinCount

The number of input clusters.

N/AoutCount

The number of output clusters.

N/AinClusters

The list of input clusters.

N/AoutClusters

The list of output clusters.

N/Aoptions

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/Aresponse

The received ZDO message with cluster ID NETWORK_ADDRESS_RESPONSE or IEEE_ADDRESS_RESPONSE.

N/Aeui64Return

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/AdiscoveryNodeId
N/AreportKids
N/AchildStartIndex
N/Aoptions
N/AtargetNodeIdOfRequest

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