ZPS_eAplZdpMgmtNwkDiscRequest

ZPS_teStatus ZPS_eAplZdpMgmtNwkDiscRequest(
            PDUM_thAPduInstance hAPduInst,
            ZPS_tuAddress uDstAddr,
            bool bExtAddr,
            uint8 *pu8SeqNumber,
            ZPS_tsAplZdpMgmtNwkDiscReq
                        *psZdpMgmtNwkDiscReq);

Description

This function requests a remote node to perform a channel scan in order to discover any other wireless networks that are operating in the neighborhood.

Note: This function is provided in the ZDP API for the reason of interoperability with nodes running non-NXP ZigBee PRO stacks that support the generated request. On receiving a request from this function, the NXP ZigBee PRO stack will return the status ZPS_ZDP_NOT_SUPPORTED.

This request must specify the requirements for the scan: channels to scan, duration of scan, starting channel. The request is represented by the structure below (further detailed in Section 8.2.2.33).

typedef struct {

uint32 u32ScanChannels;

uint8 u8ScanDuration;

uint8 u8StartIndex;

} ZPS_tsAplZdpMgmtNwkDiscReq;

The remote node replies with a Mgmt_NWK_Disc_rsp response containing the scan results, which should be collected using the function ZQ_bZQueueReceive() and stored in a structure of type ZPS_tsAplZdpMgmtNwkDiscRsp(detailed in Section 8.2.3.33).

Parent topic:ZPS_eAplZdpMgmtNwkDiscRequest

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

• * psZdpMgmtNwkDiscReq Pointer to request (see above)

Parent topic:ZPS_eAplZdpMgmtNwkDiscRequest

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_eAplZdpMgmtNwkDiscRequest

Parent topic:Network Management Services functions