Object Handle functions#
The ZDO Object Handle functions can be used to obtain the handles of various objects. The functions are listed below:
Function page#
Parent topic:Object Handle functions
ZPS_pvAplZdoGetAplHandle#
void *ZPS_pvAplZdoGetAplHandle(void);
Description
This function obtains a handle for the Application layer instance.
Parameters#
None
Parent topic:ZPS_pvAplZdoGetAplHandle
Returns#
Pointer to Application layer instance
Parent topic:ZPS_pvAplZdoGetAplHandle
Parent topic:Object Handle functions
ZPS_pvAplZdoGetMacHandle#
void *ZPS_pvAplZdoGetMacHandle(void);
Description#
This function obtains a handle for the IEEE 802.15.4 MAC layer instance.
Parent topic:ZPS_pvAplZdoGetMacHandle
Parameters#
None
Parent topic:ZPS_pvAplZdoGetMacHandle
Returns#
Pointer to MAC layer instance
Parent topic:ZPS_pvAplZdoGetMacHandle
Parent topic:Object Handle functions
ZPS_pvAplZdoGetNwkHandle#
void *ZPS_pvAplZdoGetNwkHandle(void);
Description#
This function obtains a handle for the ZigBee NWK layer instance.
Parent topic:ZPS_pvAplZdoGetNwkHandle
Parameters#
None
Parent topic:ZPS_pvAplZdoGetNwkHandle
Returns#
Pointer to NWK layer instance
Parent topic:ZPS_pvAplZdoGetNwkHandle
Parent topic:Object Handle functions
ZPS_psNwkNibGetHandle#
ZPS_tsNwkNib *ZPS_psNwkNibGetHandle(void *pvNwk);
Description#
This function obtains a handle for the NIB (Network Information Base) corresponding to the specified NWK layer instance.
The function should be called after ZPS_pvAplZdoGetNwkHandle(), which is used to obtain a pointer to the NWK layer instance.
The NIB is detailed in the ZigBee Specification (05347) from the ZigBee Alliance. This function is not strictly a ZDO function.
Parent topic:ZPS_psNwkNibGetHandle
Parameters#
pvNwk Pointer to NWK layer instance
Parent topic:ZPS_psNwkNibGetHandle
Returns#
Pointer to NIB structure
Parent topic:ZPS_psNwkNibGetHandle
Example#
void *pvNwk; = ZPS_pvAplZdoGetNwkHandle();
ZPS_tsNwkNib *pNib = ZPS_psNwkNibGetHandle(pvNwk);
Parent topic:ZPS_psNwkNibGetHandle
Parent topic:Object Handle functions
ZPS_psAplAibGetAib#
ZPS_tsAplAib *ZPS_psAplAibGetAib(void);
Description#
This function obtains a pointer to the AIB (Application Information Base) structure for the application.
Parent topic:ZPS_psAplAibGetAib
Parameters#
None
Parent topic:ZPS_psAplAibGetAib
Returns#
Pointer to AIB structure
Parent topic:ZPS_psAplAibGetAib
Parent topic:Object Handle functions
ZPS_psAplZdoGetNib#
ZPS_tsNwkNib *ZPS_psAplZdoGetNib(void);
Description#
This function obtains a pointer to the NIB (Network Information Base) structure. The NIB is detailed in the ZigBee Specification (05347) from the ZigBee Alliance.
Parent topic:ZPS_psAplZdoGetNib
Parameters#
None
Parent topic:ZPS_psAplZdoGetNib
Returns#
Pointer to NIB structure
Parent topic:ZPS_psAplZdoGetNib
Parent topic:Object Handle functions
ZPS_u64NwkNibGetEpid#
uint64 ZPS_u64NwkNibGetEpid(void *pvNwk);
Description#
This function can be used to obtain the Extended PAN ID (EPID) from a local NIB (Network Information Base).
The handle of the NWK layer instance that contains the relevant NIB must be specified. This handle can be obtained using ZPS_pvAplZdoGetNwkHandle().
Parent topic:ZPS_u64NwkNibGetEpid
Parameters#
pNibHandle Pointer to NWK layer instance that contains the NIB
Parent topic:ZPS_u64NwkNibGetEpid
Returns#
64-bit Extended PAN ID from NIB
Parent topic:ZPS_u64NwkNibGetEpid
Parent topic:Object Handle functions
Parent topic:ZDO API functions