MCUXpresso SDK Documentation

ZPS_bAplAfSetEndDeviceTimeout

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