Developing with ZBOSS
ZDO poll control

Functions

void zb_zdo_pim_permit_turbo_poll (zb_uint8_t permit)
 Toggle Turbo Poll feature. More...
 
void zb_zdo_pim_start_turbo_poll_packets (zb_uint8_t n_packets)
 Start Turbo Poll adaptive algorithm for the number of packets. Turbo Poll will be disabled after receiving the specified number of packets or after the poll timeout will rise up to the Long Poll interval. More...
 
void zb_zdo_pim_start_turbo_poll_continuous (zb_time_t turbo_poll_timeout_ms)
 Start the Turbo Poll adaptive algorithm for the specified timeout. More...
 
void zb_zdo_pim_turbo_poll_continuous_leave (zb_uint8_t param)
 Stop the Turbo Poll adaptive algorithm initiated by zb_zdo_pim_start_turbo_poll_continuous before the timeout expires. Restores the Long Poll interval. More...
 
void zb_zdo_pim_set_long_poll_interval (zb_time_t ms)
 Change the Long Poll interval. More...
 
zb_time_t zb_zdo_pim_get_long_poll_interval_ms (void)
 Get the Long Poll Interval. More...
 

Detailed Description

Function Documentation

◆ zb_zdo_pim_get_long_poll_interval_ms()

zb_time_t zb_zdo_pim_get_long_poll_interval_ms ( void  )

Get the Long Poll Interval.

Returns
Long Poll interval in milliseconds.

◆ zb_zdo_pim_permit_turbo_poll()

void zb_zdo_pim_permit_turbo_poll ( zb_uint8_t  permit)

Toggle Turbo Poll feature.

Parameters
permitZB_TRUE to enable, ZB_FALSE to disable Turbo Poll.

◆ zb_zdo_pim_set_long_poll_interval()

void zb_zdo_pim_set_long_poll_interval ( zb_time_t  ms)

Change the Long Poll interval.

Note
  • A preferable way to change the Long Poll interval if the Poll Control cluster is not defined. Else the Poll Control cluster API should be used to set the Long Poll Interval attribute.
  • Long Poll interval configuration should be done after the join procedure because during join the Long Poll interval will be set to the default value ZB_PIM_DEFAULT_LONG_POLL_INTERVAL.
Parameters
msNew Long Poll interval in milliseconds.

◆ zb_zdo_pim_start_turbo_poll_continuous()

void zb_zdo_pim_start_turbo_poll_continuous ( zb_time_t  turbo_poll_timeout_ms)

Start the Turbo Poll adaptive algorithm for the specified timeout.

Parameters
turbo_poll_timeout_msTimeout in milliseconds.

◆ zb_zdo_pim_start_turbo_poll_packets()

void zb_zdo_pim_start_turbo_poll_packets ( zb_uint8_t  n_packets)

Start Turbo Poll adaptive algorithm for the number of packets. Turbo Poll will be disabled after receiving the specified number of packets or after the poll timeout will rise up to the Long Poll interval.

Parameters
n_packetsNumber of packets.

◆ zb_zdo_pim_turbo_poll_continuous_leave()

void zb_zdo_pim_turbo_poll_continuous_leave ( zb_uint8_t  param)

Stop the Turbo Poll adaptive algorithm initiated by zb_zdo_pim_start_turbo_poll_continuous before the timeout expires. Restores the Long Poll interval.

Parameters
paramNot used, added for the correct scheduling of this function. Usually specified as zero.