ZPS_eAplZdpUserDescRequest

ZPS_teStatus ZPS_eAplZdpUserDescRequest(
    PDUM_thAPduInstance hAPduInst,
    ZPS_tuAddress uDstAddr,
    bool bExtAddr,
    uint8 *pu8SeqNumber,
ZPS_tsAplZdpUserDescReq *psZdpUserDescReq);

Description

This function requests the User descriptor of the node with a particular network address. The function sends a User_Desc_req request either to the relevant node or to another node that may hold the required information in its primary discovery cache.

Note: This function can only be used to access the User descriptor of a non-NXP device (which supports this descriptor), since the storage of a User descriptor on an NXP remove device is not supported.

The network address of the node of interest must be specified in the request, which is represented by the structure below (further detailed in Section 9.2.2.9).

typedef struct {

uint16 u16NwkAddrOfInterest;

} ZPS_tsAplZdpUserDescReq;

The required User descriptor will be received in a User_Desc_rsp response, which should be collected using the function ZQ_bZQueueReceive() and stored in a structure of type ZPS_tsAplZdpUserDescRsp(detailed in Section 9.2.3.8).

Parent topic:ZPS_eAplZdpUserDescRequest

Parameters

• hAPduInst: Handle of APDU instance in which request is sent

• uDstAddr: Address of destination node of request (can be 16-bit or 64-bit, as specified by bExtAddr)

• bExtAddr: Type of destination address:

  • TRUE: 64-bit IEEE (MAC) address

  • FALSE: 16-bit network address

• *pu8SeqNumber: Pointer to sequence number of request

• *psZdpUserDescReq: Pointer to request (see above).

Parent topic:ZPS_eAplZdpUserDescRequest

Returns

• ZPS_E_SUCCESS (request successfully sent)

• APS return codes, listed and described in Section 11.2.2

• NWK return codes, listed and described in Section 11.2.3

• MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplZdpUserDescRequest

Parent topic:Service Discovery functions