ZigBee Device Object (ZDO) Information#

For getting information about nodes of a ZigBee network via a ZigBee Device Object (ZDO). See zigbee-device-library.h and zigbee-device-common.h for source code.

The ZDO library provides functions that construct and send several common ZDO requests. It also provides a function for extracting the two addresses from a ZDO address response. The format of all the ZDO requests and responses that the stack supports is described in stack/include/zigbee-device-stack.h. Since the library doesn't handle all of these requests and responses, the application must construct any other requests it wishes to send and decode any other responses it wishes to receive.

The request sending functions do the following:

  1. Construct a correctly formatted payload buffer.

  2. Fill in the APS frame with the correct values.

  3. Send the message by calling either emberSendBroadcast() or emberSendUnicast().

The result of the send is reported to the application as normal via emberMessageSentHandler().

The following code shows an example of an application's use of emberSimpleDescriptorRequest(). The command interpreter would call this function and supply the arguments. 

void sendSimpleDescriptorRequest(EmberCommandState *state)
{
  EmberNodeId target = emberUnsignedCommandArgument(state, 0);
  uint8_t targetEndpoint = emberUnsignedCommandArgument(state, 1);
  if (emberSimpleDescriptorRequest(target,
                                   targetEndpoint,
                                   EMBER_APS_OPTION_NONE) != EMBER_SUCCESS) {
    emberSerialPrintf(SERIAL_PORT, "emberSimpleDescriptorRequest failed\r\n");
  }
}

The following code shows an example of an application's use of emberDecodeAddressResponse(). 

void emberIncomingMessageHandler(EmberIncomingMessageType type,
                                 EmberApsFrame *apsFrame,
                                 EmberMessageBuffer message)
{
  if (apsFrame->profileId == EMBER_ZDO_PROFILE_ID) {
    switch (apsFrame->clusterId) {
    case NETWORK_ADDRESS_RESPONSE:
    case IEEE_ADDRESS_RESPONSE:
      {
        EmberEUI64 eui64;
        EmberNodeId nodeId = emberDecodeAddressResponse(message, eui64);
        // Use nodeId and eui64 here.
        break;
      }
    default:
      // Handle other incoming ZDO responses here.
    }
  } else {
    // Handle incoming application messages here.
  }
}

For getting information about nodes of a ZigBee network via a ZigBee Device Object (ZDO). See zigbee-device-host.h and zigbee-device-common.h for source code.

The ZDO library provides functions that construct and send several common ZDO requests. It also provides a function for extracting the two addresses from a ZDO address response. The format of all the ZDO requests and responses that the stack supports is described in stack/include/zigbee-device-stack.h. Since the library doesn't handle all of these requests and responses, the application must construct any other requests it wishes to send and decode any other responses it wishes to receive.

The request sending functions do the following:

  1. Construct a correctly formatted payload buffer.

  2. Fill in the APS frame with the correct values.

  3. Send the message by calling either ::ezspSendBroadcast() or ::ezspSendUnicast().

The result of the send is reported to the application as normal via ::ezspMessageSentHandler().

The following code shows an example of an application's use of emberSimpleDescriptorRequest(). The command interpreter would call this function and supply the arguments. 

void sendSimpleDescriptorRequest(EmberCommandState *state)
{
  EmberNodeId target = emberUnsignedCommandArgument(state, 0);
  uint8_t targetEndpoint = emberUnsignedCommandArgument(state, 1);
  if (emberSimpleDescriptorRequest(target,
                                   targetEndpoint,
                                   EMBER_APS_OPTION_NONE) != EMBER_SUCCESS) {
    emberSerialPrintf(SERIAL_PORT, "emberSimpleDescriptorRequest failed\r\n");
  }
}

The following code shows an example of an application's use of ezspDecodeAddressResponse(). 

void ezspIncomingMessageHandler(EmberIncomingMessageType type,
                                EmberApsFrame *apsFrame,
                                uint8_t lastHopLqi,
                                int8_t lastHopRssi,
                                EmberNodeId sender,
                                uint8_t bindingIndex,
                                uint8_t addressIndex,
                                uint8_t messageLength,
                                uint8_t *messageContents)
{
  if (apsFrame->profileId == EMBER_ZDO_PROFILE_ID) {
    switch (apsFrame->clusterId) {
    case NETWORK_ADDRESS_RESPONSE:
    case IEEE_ADDRESS_RESPONSE:
      {
        EmberEUI64 eui64;
        EmberNodeId nodeId = ezspDecodeAddressResponse(messageContents,
                                                       eui64);
        // Use nodeId and eui64 here.
        break;
      }
    default:
      // Handle other incoming ZDO responses here.
    }
  } else {
    // Handle incoming application messages here.
  }
}

Service Discovery Functions#

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

Binding Manager Functions#

EmberStatus
emberEndDeviceBindRequest(uint8_t endpoint, EmberApsOption options)

Function to Decode Address Response Messages#

EmberNodeId
emberDecodeAddressResponse(EmberMessageBuffer response, EmberEUI64 eui64Return)

Service Discovery Functions#

EmberStatus
emberNodeDescriptorRequest(EmberNodeId target, EmberApsOption options)

Request the specified node to send its node descriptor. The node descriptor contains information about the capabilities of the ZigBee node. It describes logical type, APS flags, frequency band, MAC capabilities flags, manufacturer code and maximum buffer size. It is defined in the ZigBee Application Framework Specification.

EmberStatus
emberPowerDescriptorRequest(EmberNodeId target, EmberApsOption options)

Request the specified node to send its power descriptor. The power descriptor gives a dynamic indication of the power status of the node. It describes current power mode, available power sources, current power source and current power source level. It is defined in the ZigBee Application Framework Specification.

EmberStatus
emberSimpleDescriptorRequest(EmberNodeId target, uint8_t targetEndpoint, EmberApsOption options)

Request the specified node to send the simple descriptor for the specified endpoint. The simple descriptor contains information specific to a single endpoint. It describes the application profile identifier, application device identifier, application device version, application flags, application input clusters and application output clusters. It is defined in the ZigBee Application Framework Specification.

EmberStatus
emberActiveEndpointsRequest(EmberNodeId target, EmberApsOption options)

Request the specified node to send a list of its active endpoints. An active endpoint is one for which a simple descriptor is available.

Binding Manager Functions#

EmberStatus
emberBindRequest(EmberNodeId target, EmberEUI64 source, uint8_t sourceEndpoint, uint16_t clusterId, uint8_t type, EmberEUI64 destination, EmberMulticastId groupAddress, uint8_t destinationEndpoint, EmberApsOption options)

Send a request to create a binding entry with the specified contents on the specified node.

EmberStatus
emberUnbindRequest(EmberNodeId target, EmberEUI64 source, uint8_t sourceEndpoint, uint16_t clusterId, uint8_t type, EmberEUI64 destination, EmberMulticastId groupAddress, uint8_t destinationEndpoint, EmberApsOption options)

Send a request to remove a binding entry with the specified contents from the specified node.

Node Manager Functions#

EmberStatus
emberLqiTableRequest(EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its LQI (neighbor) table. The response gives PAN ID, EUI64, node ID and cost for each neighbor. The EUI64 is only available if security is enabled. The other fields in the response are set to zero. The response format is defined in the ZigBee Device Profile Specification.

EmberStatus
emberRoutingTableRequest(EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its routing table. The response gives destination node ID, status and many-to-one flags, and the next hop node ID. The response format is defined in the ZigBee Device Profile Specification.

EmberStatus
emberBindingTableRequest(EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its nonvolatile bindings. The response gives source address, source endpoint, cluster ID, destination address and destination endpoint for each binding entry. The response format is defined in the ZigBee Device Profile Specification. Note that bindings that have the Ember-specific UNICAST_MANY_TO_ONE_BINDING type are reported as having the standard UNICAST_BINDING type.

EmberStatus
emberLeaveRequest(EmberNodeId target, EmberEUI64 deviceAddress, uint8_t leaveRequestFlags, EmberApsOption options)

Request the specified node to remove the specified device from the network. The device to be removed must be the node to which the request is sent or one of its children.

EmberStatus
emberPermitJoiningRequest(EmberNodeId target, uint8_t duration, uint8_t authentication, EmberApsOption options)

Request the specified node to allow or disallow association.

void
emberSetZigDevRequestRadius(uint8_t radius)

Change the default radius for broadcast ZDO requests.

uint8_t
emberGetZigDevRequestRadius(void)

Retrieve the default radius for broadcast ZDO requests.

uint8_t
emberGetLastZigDevRequestSequence(void)

Provide access to the application ZDO transaction sequence number for last request. This function has been deprecated and replaced by emberGetLastAppZigDevRequestSequence().

uint8_t
emberGetLastAppZigDevRequestSequence(void)

Provide access to the application ZDO transaction sequence number for last request.

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)

Macros#

#define
ZDO_MESSAGE_OVERHEAD 1

ZDO messages start with a sequence number.

Service Discovery Functions Documentation#

emberMatchDescriptorsRequest#

EmberStatus emberMatchDescriptorsRequest (EmberNodeId target, uint16_t profile, EmberMessageBuffer inClusters, EmberMessageBuffer 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/AinClusters

The list of input clusters. To not match any input clusters, use ::EMBER_NULL_MESSAGE_BUFFER.

N/AoutClusters

The list of output clusters. To not match any output clusters, use ::EMBER_NULL_MESSAGE_BUFFER.

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


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

Binding Manager Functions Documentation#

emberEndDeviceBindRequest#

EmberStatus emberEndDeviceBindRequest (uint8_t endpoint, EmberApsOption options)
Parameters
N/Aendpoint

The endpoint on the local device whose simple descriptor will be used to create the request.

N/Aoptions

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

An end device bind request to the coordinator. The simple descriptor of the specified endpoint is used to construct the request. If the coordinator receives a second end device bind request then a binding is created for every matching cluster.

Returns


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

Function to Decode Address Response Messages Documentation#

emberDecodeAddressResponse#

EmberNodeId emberDecodeAddressResponse (EmberMessageBuffer response, EmberEUI64 eui64Return)
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.

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

Returns


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

Service Discovery Functions Documentation#

emberNodeDescriptorRequest#

EmberStatus emberNodeDescriptorRequest (EmberNodeId target, EmberApsOption options)

Request the specified node to send its node descriptor. The node descriptor contains information about the capabilities of the ZigBee node. It describes logical type, APS flags, frequency band, MAC capabilities flags, manufacturer code and maximum buffer size. It is defined in the ZigBee Application Framework Specification.

Parameters
N/Atarget

The node whose node descriptor is desired.

N/Aoptions

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

Returns


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

emberPowerDescriptorRequest#

EmberStatus emberPowerDescriptorRequest (EmberNodeId target, EmberApsOption options)

Request the specified node to send its power descriptor. The power descriptor gives a dynamic indication of the power status of the node. It describes current power mode, available power sources, current power source and current power source level. It is defined in the ZigBee Application Framework Specification.

Parameters
N/Atarget

The node whose power descriptor is desired.

N/Aoptions

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

Returns


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

emberSimpleDescriptorRequest#

EmberStatus emberSimpleDescriptorRequest (EmberNodeId target, uint8_t targetEndpoint, EmberApsOption options)

Request the specified node to send the simple descriptor for the specified endpoint. The simple descriptor contains information specific to a single endpoint. It describes the application profile identifier, application device identifier, application device version, application flags, application input clusters and application output clusters. It is defined in the ZigBee Application Framework Specification.

Parameters
N/Atarget

The node of interest.

N/AtargetEndpoint

The endpoint on the target node whose simple descriptor is desired.

N/Aoptions

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

Returns


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

emberActiveEndpointsRequest#

EmberStatus emberActiveEndpointsRequest (EmberNodeId target, EmberApsOption options)

Request the specified node to send a list of its active endpoints. An active endpoint is one for which a simple descriptor is available.

Parameters
N/Atarget

The node whose active endpoints are desired.

N/Aoptions

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

Returns


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

Binding Manager Functions Documentation#

emberBindRequest#

EmberStatus emberBindRequest (EmberNodeId target, EmberEUI64 source, uint8_t sourceEndpoint, uint16_t clusterId, uint8_t type, EmberEUI64 destination, EmberMulticastId groupAddress, uint8_t destinationEndpoint, EmberApsOption options)

Send a request to create a binding entry with the specified contents on the specified node.

Parameters
N/Atarget

The node on which the binding will be created.

N/Asource

The source EUI64 in the binding entry.

N/AsourceEndpoint

The source endpoint in the binding entry.

N/AclusterId

The cluster ID in the binding entry.

N/Atype

The type of binding, either UNICAST_BINDING, MULTICAST_BINDING, or UNICAST_MANY_TO_ONE_BINDING. UNICAST_MANY_TO_ONE_BINDING is an Ember-specific extension and should be used only when the target is an Ember device.

N/Adestination

The destination EUI64 in the binding entry for UNICAST_BINDING or UNICAST_MANY_TO_ONE_BINDING.

N/AgroupAddress

The group address for the MULTICAST_BINDING.

N/AdestinationEndpoint

The destination endpoint in the binding entry for the UNICAST_BINDING or UNICAST_MANY_TO_ONE_BINDING.

N/Aoptions

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

Returns


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

emberUnbindRequest#

EmberStatus emberUnbindRequest (EmberNodeId target, EmberEUI64 source, uint8_t sourceEndpoint, uint16_t clusterId, uint8_t type, EmberEUI64 destination, EmberMulticastId groupAddress, uint8_t destinationEndpoint, EmberApsOption options)

Send a request to remove a binding entry with the specified contents from the specified node.

Parameters
N/Atarget

The node on which the binding will be removed.

N/Asource

The source EUI64 in the binding entry.

N/AsourceEndpoint

The source endpoint in the binding entry.

N/AclusterId

The cluster ID in the binding entry.

N/Atype

The type of binding, either UNICAST_BINDING, MULTICAST_BINDING, or UNICAST_MANY_TO_ONE_BINDING. UNICAST_MANY_TO_ONE_BINDING is an Ember-specific extension and should be used only when the target is an Ember device.

N/Adestination

The destination EUI64 in the binding entry for the UNICAST_BINDING or UNICAST_MANY_TO_ONE_BINDING.

N/AgroupAddress

The group address for the MULTICAST_BINDING.

N/AdestinationEndpoint

The destination endpoint in the binding entry for the UNICAST_BINDING or UNICAST_MANY_TO_ONE_BINDING.

N/Aoptions

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

Returns


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

Node Manager Functions Documentation#

emberLqiTableRequest#

EmberStatus emberLqiTableRequest (EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its LQI (neighbor) table. The response gives PAN ID, EUI64, node ID and cost for each neighbor. The EUI64 is only available if security is enabled. The other fields in the response are set to zero. The response format is defined in the ZigBee Device Profile Specification.

Parameters
N/Atarget

The node whose LQI table is desired.

N/AstartIndex

The index of the first neighbor to include in the response.

N/Aoptions

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

Returns


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

emberRoutingTableRequest#

EmberStatus emberRoutingTableRequest (EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its routing table. The response gives destination node ID, status and many-to-one flags, and the next hop node ID. The response format is defined in the ZigBee Device Profile Specification.

Parameters
N/Atarget

The node whose routing table is desired.

N/AstartIndex

The index of the first route entry to include in the response.

N/Aoptions

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

Returns


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

emberBindingTableRequest#

EmberStatus emberBindingTableRequest (EmberNodeId target, uint8_t startIndex, EmberApsOption options)

Request the specified node to send its nonvolatile bindings. The response gives source address, source endpoint, cluster ID, destination address and destination endpoint for each binding entry. The response format is defined in the ZigBee Device Profile Specification. Note that bindings that have the Ember-specific UNICAST_MANY_TO_ONE_BINDING type are reported as having the standard UNICAST_BINDING type.

Parameters
N/Atarget

The node whose binding table is desired.

N/AstartIndex

The index of the first binding entry to include in the response.

N/Aoptions

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

Returns


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

emberLeaveRequest#

EmberStatus emberLeaveRequest (EmberNodeId target, EmberEUI64 deviceAddress, uint8_t leaveRequestFlags, EmberApsOption options)

Request the specified node to remove the specified device from the network. The device to be removed must be the node to which the request is sent or one of its children.

Parameters
N/Atarget

The node which will remove the device.

N/AdeviceAddress

All zeros if the target is to remove itself from the network or the EUI64 of a child of the target device to remove that child.

N/AleaveRequestFlags

A bitmask of leave options. Include LEAVE_REQUEST_REMOVE_CHILDREN_FLAG if the target is to remove their children and/or LEAVE_REQUEST_REJOIN_FLAG if the target is to rejoin the network immediately after leaving.

N/Aoptions

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

Returns


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

emberPermitJoiningRequest#

EmberStatus emberPermitJoiningRequest (EmberNodeId target, uint8_t duration, uint8_t authentication, EmberApsOption options)

Request the specified node to allow or disallow association.

Parameters
N/Atarget

The node which will allow or disallow association. The request can be broadcast by using a broadcast address (0xFFFC/0xFFFD/0xFFFF). No response is sent if the request is broadcast.

N/Aduration

A value of 0x00 disables joining. A value of 0xFF enables joining. Any other value enables joining for that number of seconds.

N/Aauthentication

Controls Trust Center authentication behavior.

N/Aoptions

The options to use when sending the request. See emberSendUnicast() for a description. This parameter is ignored if the target is a broadcast address.

Returns


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

emberSetZigDevRequestRadius#

void emberSetZigDevRequestRadius (uint8_t radius)

Change the default radius for broadcast ZDO requests.

Parameters
N/Aradius

The radius to be used for future ZDO request broadcasts.


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

emberGetZigDevRequestRadius#

uint8_t emberGetZigDevRequestRadius (void )

Retrieve the default radius for broadcast ZDO requests.

Parameters
N/A

Returns

  • The radius to be used for future ZDO request broadcasts.


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

emberGetLastZigDevRequestSequence#

uint8_t emberGetLastZigDevRequestSequence (void )

Provide access to the application ZDO transaction sequence number for last request. This function has been deprecated and replaced by emberGetLastAppZigDevRequestSequence().

Parameters
N/A

Returns

  • Last application ZDO transaction sequence number used


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

emberGetLastAppZigDevRequestSequence#

uint8_t emberGetLastAppZigDevRequestSequence (void )

Provide access to the application ZDO transaction sequence number for last request.

Parameters
N/A

Returns

  • Last application ZDO transaction sequence number used


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

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

Macro Definition Documentation#

ZDO_MESSAGE_OVERHEAD#

#define ZDO_MESSAGE_OVERHEAD
Value:
1

ZDO messages start with a sequence number.


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