ZCL Poll Control

Zigbee Cluster Library (ZCL) poll control cluster usage definition for ESP Zigbee SDK.

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_poll_control.h

Macros

ESP_ZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_DEFAULT_VALUE: Default values for Poll Control cluster attributes.

ESP_ZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_DEFAULT_VALUE: Default value for Long Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_DEFAULT_VALUE: Default value for Short Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_DEFAULT_VALUE: Default value for Fast Poll Timeout attribute.

ESP_ZB_ZCL_POLL_CONTROL_MIN_CHECK_IN_INTERVAL_DEFAULT_VALUE: Default value for Check-in Interval Min attribute.

ESP_ZB_ZCL_POLL_CONTROL_LONG_POLL_MIN_INTERVAL_DEFAULT_VALUE: Default value for Long Poll Interval Min attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_MAX_TIMEOUT_DEFAULT_VALUE: Default value for Fast Poll Timeout Max attribute.

ESP_ZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_MIN_VALUE: Minimum and maximum values for Poll Control cluster attributes.

ESP_ZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_MAX_VALUE: Maximum value for Check-in Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_MIN_VALUE: Minimum value for Long Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_MAX_VALUE: Maximum value for Long Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_MIN_VALUE: Minimum value for Short Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_MAX_VALUE: Maximum value for Short Poll Interval attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_MIN_VALUE: Minimum value for Fast Poll Timeout attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_MAX_VALUE: Maximum value for Fast Poll Timeout attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_MAX_TIMEOUT_MIN_VALUE: Minimum value for Fast Poll Timeout Max attribute.

ESP_ZB_ZCL_POLL_CONTROL_FAST_POLL_MAX_TIMEOUT_MAX_VALUE: Maximum value for Fast Poll Timeout Max attribute.

Enumerations

enum esp_zb_zcl_poll_control_attr_t

Poll Control cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_CHECK_IN_INTERVAL_ID: Represents the default amount of time between check-ins by the poll control server with the poll control client.

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_LONG_POLL_INTERVAL_ID: Defines the frequency of polling that an end device does when it is NOT in fast poll mode.

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_SHORT_POLL_INTERVAL_ID: Represents the number of quarter-seconds that an end device waits between MAC Data Requests to its parent when it is expecting data

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_FAST_POLL_TIMEOUT_ID: Represents the number of quarter-seconds that an end device will stay in fast poll mode by default.

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_MIN_CHECK_IN_INTERVAL_ID: The Poll Control Server MAY optionally provide its own minimum value for the Check-inInterval

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_LONG_POLL_MIN_INTERVAL_ID: The Poll Control Server MAY optionally provide its own minimum value for the LongPollInterval

enumerator ESP_ZB_ZCL_ATTR_POLL_CONTROL_FAST_POLL_MAX_TIMEOUT_ID: The Poll Control Server MAY optionally provide its own maximum value for the FastPollTimeout

enum esp_zb_zcl_poll_control_cli_cmd_id_t

Poll Control cluster client generated command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_RESPONSE_ID: Check-in Response command

enumerator ESP_ZB_ZCL_CMD_POLL_CONTROL_FAST_POLL_STOP_ID: Fast Poll Stop command

enumerator ESP_ZB_ZCL_CMD_POLL_CONTROL_SET_LONG_POLL_INTERVAL_ID: Set Long Poll Interval command

enumerator ESP_ZB_ZCL_CMD_POLL_CONTROL_SET_SHORT_POLL_INTERVAL_ID: Set Short Poll Interval command

enum esp_zb_zcl_poll_control_srv_cmd_id_t

Poll Control cluster server generated command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_ID: Check-in command