ZPS_tsAplZdpMgmtNwkDiscRsp

This structure is used to store Mgmt_NWK_Disc_rsp message data - a response to a call to the function ZPS_eAplZdpMgmtNwkDiscRequest(). This response reports the networks discovered in a network discovery (all the networks or a subset).

The ZPS_tsAplZdpMgmtNwkDiscRspstructure is detailed below.

typedef struct {
  uint8 u8Status;
  uint8 u8NetworkCount;
  uint8 u8StartIndex;
  uint8 u8NetworkListCount;
  /* Rest of the message is variable length */
  ZPS_tsAplZdpNetworkDescr* psNetworkDescrList;
} ZPS_tsAplZdpMgmtNwkDiscRsp;

where:

  • u8Statusis the return status for ZPS_eAplZdpMgmtNwkDiscRequest()

  • u8NetworkCountis the total number of networks discovered

  • u8StartIndexis the index, in the complete list of discovered networks, of the first network reported in this response (through psNetworkDescrList)

  • u8NetworkListCountis the number of discovered networks reported in this response (through psNetworkDescrList)

  • psNetworkDescrListis a pointer to the first entry in a list of network descriptors for the discovered networks. Each entry is of the type ZPS_tsAplZdpNetworkDescrdetailed below.

    ZPS_tsAplZdpNetworkDescr

    
    typedef struct
    {
        uint64 u64ExtPanId;
        uint8 u8LogicalChan;
        uint8 u8StackProfile;
        uint8 u8ZigBeeVersion;
        uint8 u8PermitJoining;
        uint8 u8RouterCapacity;
        uint8 u8EndDeviceCapacity;
    } ZPS_tsAplZdpNetworkDescr;
    

    where:

    • u64ExtPanIdis the 64-bit extended PAN ID of the discovered network.

    • u8LogicalChanis the radio channel in which the discovered network operates (value in range 0 to 26, but only channels 11 to 26 relevant to 2400-MHz band).

    • u8StackProfileis the 4-bit identifier of the ZigBee stack profile used by the discovered network (0 - manufacturer-specific, 1 - ZigBee, 2 - ZigBee PRO, other values reserved) and is fixed at 2 for the NXP stack.

    • u8ZigBeeVersionis the 4-bit version of the ZigBee protocol used by the discovered network.

    • u8PermitJoiningindicates whether the discovered network is currently allowing joinings - that is, at least one node (a Router or the Coordinator) of the network is allowing other nodes to join it:

      • 0x01: Joinings allowed.

      • 0x00: Joinings not allowed.

      • All other values reserved.

    • u8RouterCapacityindicates whether the device is capable of accepting join requests from Routers - set to TRUE if capable, FALSE otherwise.

    • u8EndDeviceCapacityindicates whether the device is capable of accepting join requests from End Devices - set to TRUE capable, FALSE otherwise.

Parent topic:ZDP response structures