Functions | |
| void | zb_zdo_pim_permit_turbo_poll (zb_bool_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_set_long_poll_interval (zb_time_t ms) |
| Change 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_get_long_poll_interval_req (zb_uint8_t param, zb_callback_t cb) |
| Get the Long Poll Interval. More... | |
Detailed Description
Function Documentation
◆ zb_zdo_pim_get_long_poll_interval_req()
| void zb_zdo_pim_get_long_poll_interval_req | ( | zb_uint8_t | param, |
| zb_callback_t | cb | ||
| ) |
Get the Long Poll Interval.
- Parameters
-
param buffer that will be used to store response parameters. cb
- Returns
- Long Poll interval in milliseconds.
◆ zb_zdo_pim_permit_turbo_poll()
| void zb_zdo_pim_permit_turbo_poll | ( | zb_bool_t | permit | ) |
Toggle Turbo Poll feature.
- Parameters
-
permit ZB_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
-
ms New 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_ms Timeout 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_packets Number 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
-
param Not used, added for the correct scheduling of this function. Usually specified as zero.