zigbee-device-library_8h | Ember ZNet API Reference Guide | Zigbee | v7.4.4

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.

/***************************************************************************/
#ifndef SILABS_ZIGBEE_DEVICE_LIBRARY_H
#define SILABS_ZIGBEE_DEVICE_LIBRARY_H


EmberStatus emberMatchDescriptorsRequest(EmberNodeId target,
                                         uint16_t profile,
                                         EmberMessageBuffer inClusters,
                                         EmberMessageBuffer outClusters,
                                         EmberApsOption options);
EmberNodeId emberDecodeAddressResponse(EmberMessageBuffer response,
                                       EmberEUI64 eui64Return);

#endif // SILABS_ZIGBEE_DEVICE_LIBRARY_H

Service Discovery Functions#

EmberStatus

emberMatchDescriptorsRequest(EmberNodeId target, uint16_t profile, EmberMessageBuffer inClusters, EmberMessageBuffer outClusters, EmberApsOption options)

Decode Address Response Messages#

EmberNodeId

emberDecodeAddressResponse(EmberMessageBuffer response, EmberEUI64 eui64Return)

Service Discovery Functions Documentation#

emberMatchDescriptorsRequest#

EmberStatus emberMatchDescriptorsRequest (EmberNodeId target, uint16_t profile, EmberMessageBuffer inClusters, EmberMessageBuffer 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	inClusters	The list of input clusters. To not match any input clusters, use ::EMBER_NULL_MESSAGE_BUFFER.
N/A	outClusters	The list of output clusters. To not match any output clusters, use ::EMBER_NULL_MESSAGE_BUFFER.
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 113 of file app/util/zigbee-framework/zigbee-device-library.h

Decode Address Response Messages Documentation#

emberDecodeAddressResponse#

EmberNodeId emberDecodeAddressResponse (EmberMessageBuffer response, EmberEUI64 eui64Return)

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.

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

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 134 of file app/util/zigbee-framework/zigbee-device-library.h