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.

/***************************************************************************/
sl_status_t sl_zigbee_network_address_request(sl_802154_long_addr_t target,
                                              bool reportKids,
                                              uint8_t childStartIndex);

sl_status_t sl_zigbee_ieee_address_request(sl_802154_short_addr_t target,
                                           bool reportKids,
                                           uint8_t childStartIndex,
                                           sl_zigbee_aps_option_t options);
sl_status_t sl_zigbee_ieee_address_request_to_target(sl_802154_short_addr_t discoveryNodeId,
                                                     bool reportKids,
                                                     uint8_t childStartIndex,
                                                     sl_zigbee_aps_option_t options,
                                                     sl_802154_short_addr_t targetNodeIdOfRequest);

sl_status_t sl_zigbee_ezsp_match_descriptors_request(sl_802154_short_addr_t target,
                                                     uint16_t profile,
                                                     uint8_t inCount,
                                                     uint8_t outCount,
                                                     uint16_t *inClusters,
                                                     uint16_t *outClusters,
                                                     sl_zigbee_aps_option_t options);

Device Discovery Functions#

sl_status_t
sl_zigbee_network_address_request(sl_802154_long_addr_t target, bool reportKids, uint8_t childStartIndex)

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

sl_status_t
sl_zigbee_ieee_address_request(sl_802154_short_addr_t target, bool reportKids, uint8_t childStartIndex, sl_zigbee_aps_option_t options)

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

Service Discovery Functions#

sl_status_t
sl_zigbee_ezsp_match_descriptors_request(sl_802154_short_addr_t target, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t *inClusters, uint16_t *outClusters, sl_zigbee_aps_option_t options)

Functions#

sl_status_t
sl_zigbee_ieee_address_request_to_target(sl_802154_short_addr_t discoveryNodeId, bool reportKids, uint8_t childStartIndex, sl_zigbee_aps_option_t options, sl_802154_short_addr_t targetNodeIdOfRequest)

Device Discovery Functions Documentation#

sl_zigbee_network_address_request#

sl_status_t sl_zigbee_network_address_request (sl_802154_long_addr_t 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

  • An ::sl_status_t value.

    • ::SL_STATUS_OK - The request was transmitted successfully.

    • ::SL_STATUS_ALLOCATION_FAILED - Insufficient message buffers were available to construct the request.

    • ::SL_STATUS_NETWORK_DOWN - The node is not part of a network.

    • ::SL_STATUS_BUSY - Transmission of the request failed.


Definition at line 109 of file app/util/zigbee-framework/zigbee-device-host.h

sl_zigbee_ieee_address_request#

sl_status_t sl_zigbee_ieee_address_request (sl_802154_short_addr_t target, bool reportKids, uint8_t childStartIndex, sl_zigbee_aps_option_t 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 sl_zigbee_send_unicast() for a description.

Returns

  • An ::sl_status_t value.

    • ::SL_STATUS_OK

    • ::SL_STATUS_ALLOCATION_FAILED

    • ::SL_STATUS_NETWORK_DOWN

    • ::SL_STATUS_BUSY


Definition at line 130 of file app/util/zigbee-framework/zigbee-device-host.h

Service Discovery Functions Documentation#

sl_zigbee_ezsp_match_descriptors_request#

sl_status_t sl_zigbee_ezsp_match_descriptors_request (sl_802154_short_addr_t target, uint16_t profile, uint8_t inCount, uint8_t outCount, uint16_t * inClusters, uint16_t * outClusters, sl_zigbee_aps_option_t 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 sl_zigbee_send_unicast() 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 sl_status_t value. SL_STATUS_OK, SL_STATUS_ALLOCATION_FAILED, SL_STATUS_NETWORK_DOWN or SL_STATUS_BUSY.


Definition at line 168 of file app/util/zigbee-framework/zigbee-device-host.h

Function Documentation#

sl_zigbee_ieee_address_request_to_target#

sl_status_t sl_zigbee_ieee_address_request_to_target (sl_802154_short_addr_t discoveryNodeId, bool reportKids, uint8_t childStartIndex, sl_zigbee_aps_option_t options, sl_802154_short_addr_t targetNodeIdOfRequest)
Parameters
N/AdiscoveryNodeId
N/AreportKids
N/AchildStartIndex
N/Aoptions
N/AtargetNodeIdOfRequest

Definition at line 136 of file app/util/zigbee-framework/zigbee-device-host.h