Data Structures | |
struct | zb_zcl_poll_control_check_in_cli_param_s |
Parameters to pass to device callback for incoming check in. More... | |
struct | zb_zcl_poll_control_check_in_res_s |
Structure representsation of Check-in response command payload. More... | |
struct | zb_zcl_poll_control_set_long_poll_interval_req_s |
Structure representsation of Set Long Poll Interval command payload. More... | |
struct | zb_zcl_poll_control_set_short_poll_interval_req_s |
Structure representsation of Set Short Poll Interval command payload. More... | |
Functions | |
zb_void_t | zb_zcl_poll_control_write_attr_hook (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value) |
Hook on Write attribute. More... | |
zb_void_t | zb_zcl_poll_control_start (zb_uint8_t param, zb_uint8_t endpoint) |
Schedule poll control process on given endpoint First check-in will occur after one check-in interval. More... | |
zb_uint8_t | zb_zcl_poll_control_stop (void) |
Stop Poll control processing. More... | |
zb_void_t | zb_zcl_poll_control_start_check_in (zb_uint8_t param) |
Start Poll Control process on Server side. More... | |
zb_void_t | zb_zcl_poll_controll_register_cb (zb_callback_t cb) |
Register callback for Poll control cluster. More... | |
Poll Control cluster commands | |
enum | zb_zcl_poll_control_cmd_e { ZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_ID = 0x00 } |
Poll Control cluster command identifiers. More... | |
enum | zb_zcl_poll_control_resp_cmd_e { ZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_RESPONSE_ID = 0x00, ZB_ZCL_CMD_POLL_CONTROL_FAST_POLL_STOP_ID = 0x01, ZB_ZCL_CMD_POLL_CONTROL_SET_LONG_POLL_INTERVAL_ID = 0x02, ZB_ZCL_CMD_POLL_CONTROL_SET_SHORT_POLL_INTERVAL_ID = 0x03 } |
Poll Control cluster response command identifiers. More... | |
typedef struct zb_zcl_poll_control_check_in_cli_param_s | zb_zcl_poll_control_check_in_cli_param_t |
Parameters to pass to device callback for incoming check in. | |
typedef struct zb_zcl_poll_control_check_in_res_s | zb_zcl_poll_control_check_in_res_t |
Structure representsation of Check-in response command payload. | |
typedef struct zb_zcl_poll_control_set_long_poll_interval_req_s | zb_zcl_poll_control_set_long_poll_interval_t |
Structure representsation of Set Long Poll Interval command payload. | |
typedef struct zb_zcl_poll_control_set_short_poll_interval_req_s | zb_zcl_poll_control_set_short_poll_interval_t |
Structure representsation of Set Short Poll Interval command payload. | |
zb_void_t | zb_zcl_poll_control_set_client_addr (zb_uint8_t local_ep, zb_uint16_t addr, zb_uint8_t ep) |
Set client address information. This address is used to send Check-in command. If address information is NOT sent, check-in command will be sent assuming binding with client is created. More... | |
zb_void_t | zb_zcl_poll_control_stop_fast_poll (zb_uint8_t endpoint) |
Force to go long polling. More... | |
zb_void_t | zb_zcl_set_fast_poll_timeout (zb_uint8_t ep, zb_uint16_t fast_poll_timeout) |
Function is used by Poll control client to set Fast poll timeout value. This value is included into Check-in response command. More... | |
zb_void_t | zb_zcl_poll_control_save_nvram (zb_uint8_t param) |
Save to NVRAM Poll Control dataset. More... | |
#define | ZB_ZCL_CLUSTER_ID_POLL_CONTROL_SERVER_ROLE_GENERATED_CMD_LIST ZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_ID |
#define | ZB_ZCL_CLUSTER_ID_POLL_CONTROL_CLIENT_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_POLL_CONTROL_SERVER_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_POLL_CONTROL_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_POLL_CONTROL_SERVER_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_POLL_CONTROL_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_POLL_CONTROL_SEND_CHECK_IN_REQ(_buffer, _dst_addr, _dst_addr_mode, _dst_ep, _local_ep, _prfl_id, _cb) |
Send Check-in command, see HA spec 9.5.4.4. More... | |
#define | ZB_ZCL_POLL_CONTROL_CLI_CALL_USER_APP(_buffer, _short_addr, _ep, _fast_poll_timeout, _result) |
#define | ZB_ZCL_POLL_CONTROL_SEND_CHECK_IN_RES(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb,is_start, timeout) |
Send "Check-in response" command, see HA spec 9.5.5.3. More... | |
#define | ZB_ZCL_POLL_CONTROL_GET_CHECK_IN_RES(data_ptr, buffer, status) |
Macro for getting Check-in response command. More... | |
#define | ZB_ZCL_POLL_CONTROL_SEND_FAST_POLL_STOP_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb) |
Send "Fast Poll Stop" command, see HA spec 9.5.5.4. More... | |
#define | ZB_ZCL_POLL_CONTROL_SEND_SET_LONG_POLL_INTERVAL_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, interval) |
Send "Set Long Poll Interval" command, see HA spec 9.5.5.5. More... | |
#define | ZB_ZCL_POLL_CONTROL_GET_SET_LONG_POLL_INTERVAL_REQ(data_ptr, buffer, status) |
Macro for getting "Set Long Poll Interval" command. More... | |
#define | ZB_ZCL_POLL_CONTROL_SEND_SET_SHORT_POLL_INTERVAL_REQ(buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, interval) |
Send "Set Short Poll Interval" command, see HA spec 9.5.5.6. More... | |
#define | ZB_ZCL_POLL_CONTROL_GET_SET_SHORT_POLL_INTERVAL_REQ(data_ptr, buffer, status) |
Macro for getting "Set Short Poll Interval" command. More... | |
All commands in the cluster have only request form, and carry no payload.
For more information see 5.51.2_poll_control_commands sample
#define ZB_ZCL_CLUSTER_ID_POLL_CONTROL_CLIENT_ROLE_GENERATED_CMD_LIST |
#define ZB_ZCL_POLL_CONTROL_CLI_CALL_USER_APP | ( | _buffer, | |
_short_addr, | |||
_ep, | |||
_fast_poll_timeout, | |||
_result | |||
) |
#define ZB_ZCL_POLL_CONTROL_GET_CHECK_IN_RES | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting Check-in response command.
data_ptr | - pointer to a variable of type zb_zcl_poll_control_check_in_res_s. |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_POLL_CONTROL_GET_SET_LONG_POLL_INTERVAL_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Set Long Poll Interval" command.
data_ptr | - pointer to a variable of type zb_zcl_poll_control_set_long_poll_interval_t. |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_POLL_CONTROL_GET_SET_SHORT_POLL_INTERVAL_REQ | ( | data_ptr, | |
buffer, | |||
status | |||
) |
Macro for getting "Set Short Poll Interval" command.
data_ptr | - pointer to a variable of type zb_zcl_poll_control_set_short_poll_interval_t. |
buffer | containing the packet (by pointer). |
status | - variable to put parse status to (see zb_zcl_parse_status_t). |
#define ZB_ZCL_POLL_CONTROL_SEND_CHECK_IN_REQ | ( | _buffer, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_local_ep, | |||
_prfl_id, | |||
_cb | |||
) |
Send Check-in command, see HA spec 9.5.4.4.
_buffer | - to put packet to |
_dst_addr | - destinition address |
_dst_addr_mode | - addressing mode |
_dst_ep | - destination endpoint |
_local_ep | - source endpoint |
_prfl_id | - profile identifier |
_cb | - callback for getting command send status |
#define ZB_ZCL_POLL_CONTROL_SEND_CHECK_IN_RES | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
is_start, | |||
timeout | |||
) |
Send "Check-in response" command, see HA spec 9.5.5.3.
buffer | to put packet to |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prfl_id | - profile identifier |
def_resp | - enable/disable default response |
cb | - callback |
is_start | - Start Fast Polling |
timeout | - Fast Poll Timeout |
#define ZB_ZCL_POLL_CONTROL_SEND_FAST_POLL_STOP_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb | |||
) |
Send "Fast Poll Stop" command, see HA spec 9.5.5.4.
buffer | to put packet to |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prfl_id | - profile identifier |
def_resp | - enable/disable default response |
cb | - callback |
#define ZB_ZCL_POLL_CONTROL_SEND_SET_LONG_POLL_INTERVAL_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
interval | |||
) |
Send "Set Long Poll Interval" command, see HA spec 9.5.5.5.
buffer | to put packet to |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prfl_id | - profile identifier |
def_resp | - enable/disable default response |
cb | - callback |
interval | - New Long Poll Interval |
#define ZB_ZCL_POLL_CONTROL_SEND_SET_SHORT_POLL_INTERVAL_REQ | ( | buffer, | |
addr, | |||
dst_addr_mode, | |||
dst_ep, | |||
ep, | |||
prfl_id, | |||
def_resp, | |||
cb, | |||
interval | |||
) |
Send "Set Short Poll Interval" command, see HA spec 9.5.5.6.
buffer | to put packet to |
addr | - address to send packet to |
dst_addr_mode | - addressing mode |
dst_ep | - destination endpoint |
ep | - sending endpoint |
prfl_id | - profile identifier |
def_resp | - enable/disable default response |
cb | - callback |
interval | - New Short Poll Interval |
Poll Control cluster attribute identifiers.
Poll Control cluster response command identifiers.
zb_void_t zb_zcl_poll_control_save_nvram | ( | zb_uint8_t | param | ) |
Save to NVRAM Poll Control dataset.
ignore,set | it to 0 |
zb_void_t zb_zcl_poll_control_set_client_addr | ( | zb_uint8_t | local_ep, |
zb_uint16_t | addr, | ||
zb_uint8_t | ep | ||
) |
Set client address information. This address is used to send Check-in command. If address information is NOT sent, check-in command will be sent assuming binding with client is created.
local_ep | - local endpoint number, is used to find particular attribute |
addr | - poll control client short address |
ep | - poll control client end point |
zb_void_t zb_zcl_poll_control_start | ( | zb_uint8_t | param, |
zb_uint8_t | endpoint | ||
) |
Schedule poll control process on given endpoint First check-in will occur after one check-in interval.
param | - buffer for check-in command |
endpoint | - endpoint to start poll control process on |
zb_void_t zb_zcl_poll_control_start_check_in | ( | zb_uint8_t | param | ) |
Start Poll Control process on Server side.
param | - buffer for Poll Process |
zb_uint8_t zb_zcl_poll_control_stop | ( | void | ) |
Stop Poll control processing.
Checking already scheduled will be canceled
zb_void_t zb_zcl_poll_control_stop_fast_poll | ( | zb_uint8_t | endpoint | ) |
Force to go long polling.
endpoint | - Endpoint, implementing Poll control cluster |
zb_void_t zb_zcl_poll_control_write_attr_hook | ( | zb_uint8_t | endpoint, |
zb_uint16_t | attr_id, | ||
zb_uint8_t * | new_value | ||
) |
Hook on Write attribute.
send Check-in if change Check-in interval & Check-in remain time > new check-in interval
endpoint | - endpoint number |
attr_id | - ID of attribute being written |
new_value | - pointer to new value of attribute |
zb_void_t zb_zcl_poll_controll_register_cb | ( | zb_callback_t | cb | ) |
Register callback for Poll control cluster.
This callback will be called when check-in command is sent.
cb | - pointer to callback |
zb_void_t zb_zcl_set_fast_poll_timeout | ( | zb_uint8_t | ep, |
zb_uint16_t | fast_poll_timeout | ||
) |
Function is used by Poll control client to set Fast poll timeout value. This value is included into Check-in response command.
ep | - local endpoint number, running Poll control client |
fast_poll_timeout | - Fast poll timeout value (in quarterseconds) |