Other functions

This section described other functions in the AF API. These functions are listed below:

ZPS_vSaveAllZpsRecords

void ZPS\_vSaveAllZpsRecords\(void\);

Description

This function saves to Non-Volatile Memory (NVM) all the NVM records related to the ZigBee PRO stack. This function must be used in conjunction with the Non-Volatile Memory Manager (NVM), which is described in the JN51xx Core Utilities User Guide (JNUG3133).

Parent topic:ZPS_vSaveAllZpsRecords

Parameters

None

Parent topic:ZPS_vSaveAllZpsRecords

Returns

None

Parent topic:ZPS_vSaveAllZpsRecords

Parent topic:Other functions

ZPS_bAplAfSetEndDeviceTimeout

bool ZPS\_bAplAfSetEndDeviceTimeout
                \(teZedTimeout eZedTimeout);

Description

This function can be used on an End Device to configure a timeout period for the End Device Aging mechanism, which is described in Section 6.10.1.

The End Device communicates this timeout period to its parent on joining the network. The parent applies this timeout to the ‘keep-alive’ packets sent from the End Device child using the function ZPS_eAplAfSendKeepAlive(). If the parent does not receive a keep-alive packet from the End Device before the timeout expires, then the parent assumes the End Device is no longer active and discards it.

Parent topic:ZPS_bAplAfSetEndDeviceTimeout

Parameters

eZedTimeout Enumeration indicating timeout period to be set - one of the below:

  • ZED_TIMEOUT_10_SEC (10 seconds)

  • ZED_TIMEOUT_2_MIN (2 minutes)

  • ZED_TIMEOUT_4_MIN (4 minutes)

  • ZED_TIMEOUT_8_MIN (8 minutes)

  • ZED_TIMEOUT_16_MIN (16 minutes)

  • ZED_TIMEOUT_32_MIN (32 minutes)

  • ZED_TIMEOUT_64_MIN (64 minutes)

  • ZED_TIMEOUT_128_MIN (128 minutes)

  • ZED_TIMEOUT_256_MIN (256 minutes)

  • ZED_TIMEOUT_512_MIN (512 minutes)

  • ZED_TIMEOUT_1024_MIN (1024 minutes)

  • ZED_TIMEOUT_2048_MIN (2048 minutes)

  • ZED_TIMEOUT_4096_MIN (4096 minutes)

  • ZED_TIMEOUT_8192_MIN (8192 minutes)

  • ZED_TIMEOUT_16384_MIN (16384 minutes)

Parent topic:ZPS_bAplAfSetEndDeviceTimeout

Returns

  • TRUE - timeout successfully set

  • FALSE - timeout not set

Parent topic:ZPS_bAplAfSetEndDeviceTimeout

Parent topic:Other functions

ZPS_eAplAfSendKeepAlive

ZPS\_teStatus ZPS\_eAplAfSendKeepAlive\(void\);

Description

This function can be used on an End Device to send a ‘keep-alive’ packet to its parent as part of the End Device Aging mechanism, which is described in Section 6.10.1. This packet informs the parent that the End Device is still active, so that the parent does not discard the child.

The parent must receive at least one keep-alive packet from the End Device within the timeout period defined using the function ZPS_bAplAfSetEndDeviceTimeout(). Otherwise, the parent assumes that the child is no longer active and discard the child. It is recommended that at least three keep-alive packets are sent within the timeout period to ensure that the End Device child is not accidentally discarded due to missed keep-alive packets.

A keep-alive packet can take the form of a MAC Data Poll or an End Device Timeout Request, as required by the parent - the keep-alive packet type is configured in the NIB on the parent but, by default, both packets types are configured to be acceptable in the NXP software. This function automatically sends the appropriate keep-alive packet type but when both packet types are acceptable, a Data Poll is sent. Both packet types have the effect of re-starting the timeout for the End Device on the parent. When a Data Poll packet is used, the parent may also return pending data to the End Device, indicated by a ZPS_EVENT_AF_DATA_INDICATION event on the End Device.

Parent topic:ZPS_eAplAfSendKeepAlive

Parameters

None

Parent topic:ZPS_eAplAfSendKeepAlive

Returns

Parent topic:ZPS_eAplAfSendKeepAlive

Parent topic:Other functions

Parent topic:AF API functions