Developing with ZBOSS for Zigbee
ZCL initialization data and API

Data Structures

struct  zb_zcl_device_callback_param_s
 Data for Device user application callback. This structure has receive to User application callback (see zb_callback_t). More...
 
struct  zcl_cluster_handlers_s
 
struct  zb_discover_cmd_list
 

Macros

#define ZB_ZCL_VERSION   8U
 ZCL version. According ZCL 8 spec: 3.2.2.2.1 ZCLVersion Attribute The ZCLVersion attribute represents a published set of foundation items (in Chapter 2), such as global commands and functional descriptions. For this version of the ZCL (this document), this attribute SHALL be set to 8. In the future, this value SHALL align with the release revision of the ZCL(CCB 2722).
 
#define ZB_ZCL_SET_MODIFY_ATTR_VALUE_CB(func_ptr)
 Set modify attribute value callback. The macro sets a callback being called on external attribute change. The callback will be provided with all data necessary for correct value change handling. More...
 
#define ZB_ZCL_SET_REPORT_ATTR_CB(func_ptr)
 Set report attribute callback. The macro sets a callback being called on receive attribute report. The callback will be provided with all data necessary for correct attribute handling. More...
 
#define ZB_ZCL_SET_NO_REPORTING_CB(func_ptr)
 Set no reporting callback. The macro sets a callback being called on remote attribute reporting timeout. The callback will be provided with all data necessary for correct attribute report timeout handling. More...
 
#define ZB_ZCL_SET_DEFAULT_VALUE_CB(func_ptr)
 Set "Set default value all attribute" callback. The macro sets a callback being called for need to set attribute to default value. More...
 
#define ZB_ZCL_DEVICE_CMD_PARAM_IN_GET(_param, _ptype)   ((const _ptype *) ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.in))
 
#define ZB_ZCL_DEVICE_CMD_PARAM_OUT_GET(_param, _ptype)   ((_ptype *) ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.out))
 
#define ZB_ZCL_DEVICE_CMD_PARAM_CMD_INFO(_param)   ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.in_cmd_info)
 
#define ZB_ZCL_DEVICE_CMD_PARAM_CB_ID(_param)   ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->device_cb_id)
 
#define ZB_ZCL_DEVICE_CMD_PARAM_STATUS(_param)   ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->status)
 
#define ZB_ZCL_GENERAL_GET_CMD_LISTS_PARAM   0xFFU
 
#define ZB_ZCL_CLUSTER_HANDLERS_TABLE_SIZE   20
 
#define ZB_ZCL_NON_VALUE_INT32   ((zb_int32_t)0x80000000)
 
#define ZB_ZCL_NON_VALUE_INT16   ((zb_int16_t)0x8000)
 
#define ZB_ZCL_NON_VALUE_INT8   ((zb_int8_t)0x80)
 
#define ZCL_CTX()   (*zb_zcl_get_ctx())
 
#define ZCL8_CTX()   (*zb_zcl8_get_ctx())
 

Typedefs

typedef enum zb_zcl_device_callback_id_e zb_zcl_device_callback_id_t
 
typedef struct zb_zcl_device_callback_param_s zb_zcl_device_callback_param_t
 Data for Device user application callback. This structure has receive to User application callback (see zb_callback_t).
 
typedef struct zcl_cluster_handlers_s zcl_cluster_handlers_t
 
typedef struct zb_discover_cmd_list zb_discover_cmd_list_t
 
typedef zb_bool_t(* zb_zcl_is_high_freq_msg_func_t) (zb_bufid_t)
 
typedef zb_bool_t(* zb_zcl_block_zcl_cmd_t) (zb_zcl_parsed_hdr_t *)
 
typedef zb_bool_t(* zb_zcl_read_attr_resp_handler_t) (zb_bufid_t)
 

Enumerations

enum  zb_zcl_device_callback_id_e {
  ZB_ZCL_SET_ATTR_VALUE_CB_ID = 0, ZB_ZCL_ON_OFF_WITH_EFFECT_VALUE_CB_ID, ZB_ZCL_SHADE_SET_VALUE_CB_ID, ZB_ZCL_SHADE_GET_VALUE_CB_ID,
  ZB_ZCL_IDENTIFY_EFFECT_CB_ID, ZB_ZCL_LEVEL_CONTROL_SET_VALUE_CB_ID, ZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_VALUE_CB_ID, ZB_ZCL_IAS_WD_START_WARNING_VALUE_CB_ID,
  ZB_ZCL_IAS_WD_SQUAWK_VALUE_CB_ID, ZB_ZCL_IAS_ACE_ARM_CB_ID, ZB_ZCL_IAS_ACE_BYPASS_CB_ID, ZB_ZCL_IAS_ACE_EMERGENCY_CB_ID,
  ZB_ZCL_IAS_ACE_FIRE_CB_ID, ZB_ZCL_IAS_ACE_PANIC_CB_ID, ZB_ZCL_IAS_ACE_GET_PANEL_STATUS_CB_ID, ZB_ZCL_IAS_ACE_GET_BYPASSED_ZONE_LIST_CB_ID,
  ZB_ZCL_IAS_ACE_GET_ZONE_STATUS_CB_ID, ZB_ZCL_IAS_ACE_ARM_RESP_CB_ID, ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_RESP_CB_ID, ZB_ZCL_IAS_ACE_GET_ZONE_INFO_RESP_CB_ID,
  ZB_ZCL_IAS_ACE_ZONE_STATUS_CHANGED_CB_ID, ZB_ZCL_IAS_ACE_PANEL_STATUS_CHANGED_CB_ID, ZB_ZCL_IAS_ACE_GET_PANEL_STATUS_RESP_CB_ID, ZB_ZCL_IAS_ACE_SET_BYPASSED_ZONE_LIST_CB_ID,
  ZB_ZCL_IAS_ACE_BYPASS_RESP_CB_ID, ZB_ZCL_IAS_ACE_GET_ZONE_STATUS_RESP_CB_ID, ZB_ZCL_OTA_UPGRADE_VALUE_CB_ID, ZB_ZCL_BASIC_RESET_CB_ID,
  ZB_ZCL_THERMOSTAT_VALUE_CB_ID, ZB_ZCL_POLL_CONTROL_CHECK_IN_CLI_CB_ID, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_CB_ID, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_RESP_CB_ID,
  ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_NOTIFICATION_CB_ID, ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_NOTIFICATION_CB_ID, ZB_ZCL_OTA_UPGRADE_SRV_QUERY_IMAGE_CB_ID, ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_STARTED_CB_ID,
  ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_ABORTED_CB_ID, ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_END_CB_ID, ZB_ZCL_PRICE_GET_CURRENT_PRICE_CB_ID, ZB_ZCL_PRICE_GET_SCHEDULED_PRICES_CB_ID,
  ZB_ZCL_PRICE_GET_TIER_LABELS_CB_ID, ZB_ZCL_PRICE_PUBLISH_PRICE_CB_ID, ZB_ZCL_PRICE_PUBLISH_TIER_LABELS_CB_ID, ZB_ZCL_PRICE_PRICE_ACK_CB_ID,
  ZB_ZCL_DRLC_REPORT_EVENT_STATUS_CB_ID, ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID, ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID, ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_CB_ID,
  ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_CB_ID, ZB_ZCL_MESSAGING_MSG_CONFIRMATION_CB_ID, ZB_ZCL_MESSAGING_GET_LAST_MSG_CB_ID, ZB_ZCL_MESSAGING_CANCEL_MSG_CB_ID,
  ZB_ZCL_MESSAGING_DISPLAY_MSG_CB_ID, ZB_ZCL_TUNNELING_REQUEST_TUNNEL_CB_ID, ZB_ZCL_TUNNELING_REQUEST_TUNNEL_RESPONSE_CB_ID, ZB_ZCL_TUNNELING_TRANSFER_DATA_CLI_CB_ID,
  ZB_ZCL_TUNNELING_TRANSFER_DATA_SRV_CB_ID, ZB_ZCL_TUNNELING_TRANSFER_DATA_ERROR_CLI_CB_ID, ZB_ZCL_TUNNELING_TRANSFER_DATA_ERROR_SRV_CB_ID, ZB_ZCL_TUNNELING_CLOSE_TUNNEL_CB_ID,
  ZB_ZCL_METERING_GET_PROFILE_CB_ID, ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_CB_ID, ZB_ZCL_METERING_GET_SNAPSHOT_CB_ID, ZB_ZCL_METERING_GET_SAMPLED_DATA_CB_ID,
  ZB_ZCL_METERING_GET_PROFILE_RESPONSE_CB_ID, ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_RESPONSE_CB_ID, ZB_ZCL_METERING_PUBLISH_SNAPSHOT_CB_ID, ZB_ZCL_METERING_GET_SAMPLED_DATA_RESPONSE_CB_ID,
  ZB_ZCL_WINDOW_COVERING_UP_OPEN_CB_ID, ZB_ZCL_WINDOW_COVERING_DOWN_CLOSE_CB_ID, ZB_ZCL_WINDOW_COVERING_STOP_CB_ID, ZB_ZCL_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE_CB_ID,
  ZB_ZCL_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE_CB_ID, ZB_ZCL_SCENES_ADD_SCENE_CB_ID, ZB_ZCL_SCENES_STORE_SCENE_CB_ID, ZB_ZCL_SCENES_VIEW_SCENE_CB_ID,
  ZB_ZCL_SCENES_REMOVE_SCENE_CB_ID, ZB_ZCL_SCENES_REMOVE_ALL_SCENES_CB_ID, ZB_ZCL_SCENES_RECALL_SCENE_CB_ID, ZB_ZCL_SCENES_GET_SCENE_MEMBERSHIP_CB_ID,
  ZB_ZCL_SCENES_ENHANCED_ADD_SCENE_CB_ID, ZB_ZCL_SCENES_ENHANCED_VIEW_SCENE_CB_ID, ZB_ZCL_SCENES_COPY_SCENE_CB_ID, ZB_ZCL_SCENES_INTERNAL_REMOVE_ALL_SCENES_ALL_ENDPOINTS_CB_ID,
  ZB_ZCL_SCENES_INTERNAL_REMOVE_ALL_SCENES_ALL_ENDPOINTS_ALL_GROUPS_CB_ID, ZB_ZCL_DOOR_LOCK_LOCK_DOOR_CB_ID, ZB_ZCL_DOOR_LOCK_UNLOCK_DOOR_CB_ID, ZB_ZCL_DOOR_LOCK_LOCK_DOOR_RESP_CB_ID,
  ZB_ZCL_DOOR_LOCK_UNLOCK_DOOR_RESP_CB_ID, ZB_ZCL_ALARMS_RESET_ALARM_CB_ID, ZB_ZCL_ALARMS_RESET_ALL_ALARMS_CB_ID, ZB_ZCL_ALARMS_ALARM_CB_ID,
  ZB_ZCL_WWAH_ENABLE_APP_EVENT_RETRY_ALGORITHM_CB_ID, ZB_ZCL_WWAH_DISABLE_APP_EVENT_RETRY_ALGORITHM_CB_ID, ZB_ZCL_CONTROL4_NETWORK_ZAP_INFO_CB_ID, ZB_ZCL_WWAH_DEBUG_REPORT_QUERY_CB_ID,
  ZB_ZCL_WWAH_SET_IAS_ZONE_ENROLLMENT_METHOD_CB_ID
}
 

Functions

zb_zcl8_globals_t * zb_zcl8_get_ctx (void)
 

Detailed Description

Most of initialization is being handled automatically during device start. However, application may set additional callbacks for event handling. Particularly:

Sample use ZB_ZCL_SET_REPORT_ATTR_CB

void report_attribute_cb(zb_zcl_addr_t *addr, zb_uint8_t ep, zb_uint16_t cluster_id,
zb_uint16_t attr_id, zb_uint8_t attr_type, zb_uint8_t *value)
{
ZVUNUSED(ep);
ZVUNUSED(attr_type);
ZVUNUSED(value);
TRACE_MSG(TRACE_APP1, ">> report_attribute_cb addr %d ep %hd, cluster 0x%x, attr %d",
(FMT__D_H_D_D, addr->u.short_addr, ep, cluster_id, attr_id));
TRACE_MSG(TRACE_APP1, "<< report_attribute_cb", (FMT__0));
}
/* Sets a callback being called on receive attribute report */
ZB_ZCL_SET_REPORT_ATTR_CB(report_attribute_cb);

Sample use ZB_ZCL_SET_NO_REPORTING_CB

zb_void_t no_reporting_cb(zb_uint8_t ep, zb_uint16_t cluster_id, zb_uint16_t attr_id)
{
zb_buf_t *buf = zb_get_out_buf();
test_timeout_info_t *timeout_info = ZB_GET_BUF_PARAM(buf, test_timeout_info_t);
TRACE_MSG(TRACE_ZCL1, ">> no_reporting_cb ep %hd, cluster_id %d, attr_id %d",
(FMT__H_D_D, ep, cluster_id, attr_id));
timeout_info->ep = ep;
timeout_info->cluster = cluster_id;
timeout_info->attr = attr_id;
timeout_info->timeout = g_reporting_interval;
g_reporting_interval = 0;
next_step(buf);
TRACE_MSG(TRACE_ZCL1, "<< no_reporting_cb", (FMT__0));
}
ZB_ZCL_SET_NO_REPORTING_CB(no_reporting_cb);

Macro Definition Documentation

◆ ZB_ZCL_DEVICE_CMD_PARAM_CB_ID

#define ZB_ZCL_DEVICE_CMD_PARAM_CB_ID (   _param)    ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->device_cb_id)

Get access to zb_zcl_device_callback_param_t::device_cb_id of device callback parameters.

Parameters
_param- Reference to buffer.

◆ ZB_ZCL_DEVICE_CMD_PARAM_CMD_INFO

#define ZB_ZCL_DEVICE_CMD_PARAM_CMD_INFO (   _param)    ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.in_cmd_info)

Get access to zb_zcl_parsed_hdr_t data from device callback parameter.

Parameters
_param- Reference to buffer.
Returns
- Pointer to zb_zcl_parsed_hdr_t structure.

◆ ZB_ZCL_DEVICE_CMD_PARAM_IN_GET

#define ZB_ZCL_DEVICE_CMD_PARAM_IN_GET (   _param,
  _ptype 
)    ((const _ptype *) ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.in))

Get INPUT device callback parameter from buffer reference.

Parameters
_param- Reference to buffer.
_ptype- Target data type.
Returns
- Pointer to _ptype data.
See also
zb_zcl_device_callback_param_t.

◆ ZB_ZCL_DEVICE_CMD_PARAM_OUT_GET

#define ZB_ZCL_DEVICE_CMD_PARAM_OUT_GET (   _param,
  _ptype 
)    ((_ptype *) ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->cb_param.gnr.out))

Get OUTPUT device callback parameter from buffer reference.

Parameters
_param- Reference to buffer.
_ptype- Target data type
Returns
- Pointer to _ptype data.

◆ ZB_ZCL_DEVICE_CMD_PARAM_STATUS

#define ZB_ZCL_DEVICE_CMD_PARAM_STATUS (   _param)    ((ZB_ZCL_DEVICE_CMD_PARAM(_param))->status)

Get access to zb_zcl_device_callback_param_t::status of device callback parameters.

Parameters
_param- Reference to buffer.
Returns
- zb_ret_t value of current status.

◆ ZB_ZCL_NON_VALUE_INT16

#define ZB_ZCL_NON_VALUE_INT16   ((zb_int16_t)0x8000)

ZCL8 non-value for int16 type, see subclause 2.6.2.8

◆ ZB_ZCL_NON_VALUE_INT32

#define ZB_ZCL_NON_VALUE_INT32   ((zb_int32_t)0x80000000)

ZCL8 non-value for int32 type, see subclause 2.6.2.8

◆ ZB_ZCL_NON_VALUE_INT8

#define ZB_ZCL_NON_VALUE_INT8   ((zb_int8_t)0x80)

ZCL8 non-value for int8 type, see subclause 2.6.2.8

◆ ZB_ZCL_SET_DEFAULT_VALUE_CB

#define ZB_ZCL_SET_DEFAULT_VALUE_CB (   func_ptr)

Set "Set default value all attribute" callback. The macro sets a callback being called for need to set attribute to default value.

Parameters
func_ptr- callback to set (of type zb_zcl_set_default_value_attr_cb_t).

◆ ZB_ZCL_SET_MODIFY_ATTR_VALUE_CB

#define ZB_ZCL_SET_MODIFY_ATTR_VALUE_CB (   func_ptr)

Set modify attribute value callback. The macro sets a callback being called on external attribute change. The callback will be provided with all data necessary for correct value change handling.

Parameters
func_ptr- a callback to set (of type zb_zcl_modify_attr_value_cb_t).

◆ ZB_ZCL_SET_NO_REPORTING_CB

#define ZB_ZCL_SET_NO_REPORTING_CB (   func_ptr)

Set no reporting callback. The macro sets a callback being called on remote attribute reporting timeout. The callback will be provided with all data necessary for correct attribute report timeout handling.

Parameters
func_ptr- callback to set (of type zb_zcl_no_reporting_cb_t).

◆ ZB_ZCL_SET_REPORT_ATTR_CB

#define ZB_ZCL_SET_REPORT_ATTR_CB (   func_ptr)

Set report attribute callback. The macro sets a callback being called on receive attribute report. The callback will be provided with all data necessary for correct attribute handling.

Parameters
func_ptr- callback to set (of type zb_zcl_report_attr_cb_t).

◆ ZCL8_CTX

#define ZCL8_CTX ( )    (*zb_zcl8_get_ctx())

Returns pointer to ZCL8 context

◆ ZCL_CTX

#define ZCL_CTX ( )    (*zb_zcl_get_ctx())

Returns pointer to ZCL context

Typedef Documentation

◆ zb_zcl_device_callback_id_t

Types of device user application callbacks

See also
zb_zcl_device_callback_param_t

Enumeration Type Documentation

◆ zb_zcl_device_callback_id_e

Types of device user application callbacks

See also
zb_zcl_device_callback_param_t
Enumerator
ZB_ZCL_SET_ATTR_VALUE_CB_ID 

Inform user about attribute value modification

ZB_ZCL_ON_OFF_WITH_EFFECT_VALUE_CB_ID 

Inform user about change On/Off effect

See also
ZCL spec 6.6.1.4.4.2
ZB_ZCL_SHADE_SET_VALUE_CB_ID 

Inform user about ZCL Shade cluster shade position value modification

ZB_ZCL_SHADE_GET_VALUE_CB_ID 

Inform user that shade_get_value_param of ZCL Shade custer could be changed

ZB_ZCL_IDENTIFY_EFFECT_CB_ID 

Inform user about call identify effect command

See also
ZCL spec 6.3.1.2.1
ZB_ZCL_LEVEL_CONTROL_SET_VALUE_CB_ID 

Inform user about ZCL Level Control cluster attributes value modification

ZB_ZCL_IAS_ZONE_ENROLL_RESPONSE_VALUE_CB_ID 

Inform user about enroll result command

See also
ZCL spec 8.2.2.3.1
ZB_ZCL_IAS_WD_START_WARNING_VALUE_CB_ID 

Inform user about call Start warning command

See also
ZCL spec 8.4.2.3.1
ZB_ZCL_IAS_WD_SQUAWK_VALUE_CB_ID 

Inform user about call Squawk command

See also
ZCL spec 8.4.2.3.2
ZB_ZCL_IAS_ACE_ARM_CB_ID 

Server. Inform user about IAS ACE Arm command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_arm_t
[out]param_outzb_zcl_ias_ace_arm_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Arm Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_BYPASS_CB_ID 

Server. Inform user about IAS ACE Bypass command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_bypass_t
[out]param_outzb_zcl_ias_ace_bypass_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Bypass Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_EMERGENCY_CB_ID 

Server. Inform user about IAS ACE Emergency command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_FIRE_CB_ID 

Server. Inform user about IAS ACE Fire command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_PANIC_CB_ID 

Server. Inform user about IAS ACE Panic command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_PANEL_STATUS_CB_ID 

Server. Inform user about IAS ACE Get Panel Status command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[out]param_outzb_zcl_ias_ace_get_panel_status_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Get Panel Status Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_BYPASSED_ZONE_LIST_CB_ID 

Server. Inform user about IAS ACE Get Bypassed Zone List command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[out]param_outzb_zcl_ias_ace_set_bypassed_zone_list_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Set Bypassed Zone List command.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_ZONE_STATUS_CB_ID 

Server. Inform user about IAS ACE Get Zone Status command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_get_zone_status_t
[out]param_outzb_zcl_ias_ace_get_zone_status_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Get Zone Status Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_ARM_RESP_CB_ID 

Client. Inform user about IAS ACE Arm Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_arm_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_ZONE_ID_MAP_RESP_CB_ID 

Client. Inform user about IAS ACE Get Zone ID Map Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_get_zone_id_map_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_ZONE_INFO_RESP_CB_ID 

Client. Inform user about IAS ACE Get Zone Info Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_get_zone_info_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_ZONE_STATUS_CHANGED_CB_ID 

Client. Inform user about IAS ACE Zone Status Changed command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_zone_status_changed_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_PANEL_STATUS_CHANGED_CB_ID 

Client. Inform user about IAS ACE Panel Status Changed command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_panel_status_changed_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_PANEL_STATUS_RESP_CB_ID 

Client. Inform user about IAS ACE Get Panel Status Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_get_panel_status_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_SET_BYPASSED_ZONE_LIST_CB_ID 

Client. Inform user about IAS ACE Set Bypassed Zone List command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_set_bypassed_zone_list_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_BYPASS_RESP_CB_ID 

Client. Inform user about IAS ACE Bypass Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_bypass_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_IAS_ACE_GET_ZONE_STATUS_RESP_CB_ID 

Client. Inform user about IAS ACE Get Zone Status Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_ias_ace_get_zone_status_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_OTA_UPGRADE_VALUE_CB_ID 

Inform user about OTA Upgrade commands

ZB_ZCL_BASIC_RESET_CB_ID 

Inform user about Basic Reset to Factory Defaults commands

ZB_ZCL_THERMOSTAT_VALUE_CB_ID 

Inform user about call Thermostat command

See also
HA spec 10.1.3.3
ZB_ZCL_POLL_CONTROL_CHECK_IN_CLI_CB_ID 

Inform user about Check-In command from polled device

ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_CB_ID 

Server. Inform user about EN50523 Appliance Events and Alerts Get Alerts command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[out]param_outzb_zcl_en50523_appl_ev_and_alerts_get_alerts_resp_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_GET_ALERTS_RESP_CB_ID 

Client. Inform user about EN50523 Appliance Events and Alerts Get Alerts Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_en50523_appl_ev_and_alerts_get_alerts_resp_t One of the following statuses must be returned:
Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_ALERTS_NOTIFICATION_CB_ID 

Client. Inform user about EN50523 Appliance Events and Alerts Alerts Notification command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_en50523_appl_ev_and_alerts_alerts_notif_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_EN50523_APPL_EV_AND_ALERTS_EVENT_NOTIFICATION_CB_ID 

Client. Inform user about EN50523 Appliance Events and Alerts Event Notification command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_en50523_appl_ev_and_alerts_event_notif_t One of the following statuses must be returned:
Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_OTA_UPGRADE_SRV_QUERY_IMAGE_CB_ID 

Server. Inform user about Query next image request

ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_STARTED_CB_ID 

Server. Inform user about the first Image block request

ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_ABORTED_CB_ID 

Server. Inform user about the aborted Image block request

ZB_ZCL_OTA_UPGRADE_SRV_UPGRADE_END_CB_ID 

Server. Inform user about finished OTA upgrade

ZB_ZCL_PRICE_GET_CURRENT_PRICE_CB_ID 

Server. Ask user about payload for PublishPrice request.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_inzb_zcl_price_get_current_price_payload_t
[out]param_outzb_zcl_price_publish_price_payload_t

One of the following statuses must be returned:

Returns
RET_OK - price data is available. Send PublishPrice command.
RET_NOT_FOUND - price data isn't available. Default Response will be send if requested.
ZB_ZCL_PRICE_GET_SCHEDULED_PRICES_CB_ID 

Server. Notify user about GetScheduledPrices request.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[out]param_outparam_in zb_zcl_price_get_scheduled_prices_payload_t

One of the following statuses must be returned:

Returns
RET_OK - price data is available.
RET_NOT_FOUND - price data isn't available. Default Response will be send if requested.
ZB_ZCL_PRICE_GET_TIER_LABELS_CB_ID 

Server. Notify user about GetTierLabels request.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_outparam_in zb_zcl_price_get_tier_labels_payload_t

One of the following statuses must be returned:

Returns
RET_OK - price data is available. In this case application must send reply using new buffer. Stack free buffer in this case.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
RET_NOT_FOUND - price data isn't available. Default Response will be send if requested.
ZB_ZCL_PRICE_PUBLISH_PRICE_CB_ID 

Client. Inform user about PublishPrice request.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_price_publish_price_payload_t
[out]param_outzb_zcl_price_ack_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send PriceAcknowledgement command.
RET_ERROR - command is handled with errors
ZB_ZCL_PRICE_PUBLISH_TIER_LABELS_CB_ID 

Client. Inform user about PublishTierLabels request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_price_publish_tier_labels_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors
ZB_ZCL_PRICE_PRICE_ACK_CB_ID 

Server. Inform user about PriceAck command.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_price_ack_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_DRLC_REPORT_EVENT_STATUS_CB_ID 

Server. Inform user about change of state for an active Load Control event

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_drlc_report_event_status_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID 

Server. Ask user about currently active or scheduled Load Control Events

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_drlc_get_scheduled_events_payload_t
[out]param_outzb_zcl_drlc_lce_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send LoadControlEvent command
RET_ERROR - command is handled with errors.
ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID 

Client. Inform user about received Load Control Event

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_drlc_lce_payload_t
[out]param_outzb_zcl_drlc_report_event_status_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send ReportEventStatus in response.
RET_IGNORE - application doesn't received and resolved time. Drop event. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_CB_ID 

Client. Inform user about Load Control Event cancellation

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_price_publish_price_payload_t
[out]param_outzb_zcl_price_ack_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send ReportEventStatus in response.
RET_IGNORE - application doesn't received and resolved time. Drop event. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_CB_ID 

Client. Inform user about all Load Control Events cancellation

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_drlc_cancel_lce_payload_t
[out]param_outzb_zcl_drlc_report_event_status_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_IGNORE - application doesn't received and resolved time. Drop events. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_MESSAGING_MSG_CONFIRMATION_CB_ID 

Server. Inform user about received Message Confirmation request

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_messaging_message_confirm_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_MESSAGING_GET_LAST_MSG_CB_ID 

Server. Ask user about payload for Display Message request

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[out]param_outzb_zcl_messaging_get_last_message_response_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send DisplayMessage command
RET_NOT_FOUND - no messages is available. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_MESSAGING_CANCEL_MSG_CB_ID 

Client. Inform user about received Cancel Message request

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_messaging_cancel_message_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_MESSAGING_DISPLAY_MSG_CB_ID 

Client. Inform user about received Display Message request

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_messaging_display_message_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_TUNNELING_REQUEST_TUNNEL_CB_ID 

Server. Inform user about request to setup a tunnel association with the server

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_request_tunnel_t
[out]param_outtunnel_status

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_TUNNELING_REQUEST_TUNNEL_RESPONSE_CB_ID 

Client. Inform user about response to a RequestTunnel command

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_request_tunnel_response_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_TUNNELING_TRANSFER_DATA_CLI_CB_ID 

Server. Inform user about received TransferData request

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_transfer_data_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors. Send TransferDataError command
ZB_ZCL_TUNNELING_TRANSFER_DATA_SRV_CB_ID 

Client. Inform user about received TransferData request

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_transfer_data_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors. Send TransferDataError command
ZB_ZCL_TUNNELING_TRANSFER_DATA_ERROR_CLI_CB_ID 

Server. Inform user about received TransferDataError request

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_transfer_data_error_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_TUNNELING_TRANSFER_DATA_ERROR_SRV_CB_ID 

Client. Inform user about received TransferDataError request

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_transfer_data_error_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_TUNNELING_CLOSE_TUNNEL_CB_ID 

Server. Inform user about closing the tunnel with the server.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_tunneling_close_tunnel_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_NOT_FOUND - TunnelID value doesn't match an active tunnel on the server. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_GET_PROFILE_CB_ID 

Server. Inform user about GetProfile request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_get_profile_payload_t
[out]param_outzb_zcl_metering_get_profile_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send GetProfileResponse command.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_CB_ID 

Server. Inform user about RequestFastPollMode request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_request_fast_poll_mode_payload_t
[out]param_outzb_zcl_metering_request_fast_poll_mode_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send RequestFastPollModeResponse command.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_GET_SNAPSHOT_CB_ID 

Server. Inform user about GetSnapshot request.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_get_snapshot_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. In this case application must send reply using new buffer. Stack free buffer in this case.
RET_NOT_FOUND - price data isn't available. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_GET_SAMPLED_DATA_CB_ID 

Server. Inform user about GetSampledData request.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_get_sampled_data_payload_t
[out]param_outzb_zcl_metering_get_sampled_data_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send GetSampledData command.
RET_NOT_FOUND - price data isn't available. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_GET_PROFILE_RESPONSE_CB_ID 

Client. Inform user about response to GetProfileResponse command.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_get_profile_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_RESPONSE_CB_ID 

Client. Inform user about response to RequestFastPollMode command.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_request_fast_poll_mode_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_PUBLISH_SNAPSHOT_CB_ID 

Client. Inform user about response to GetSnapshot command.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_publish_snapshot_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_METERING_GET_SAMPLED_DATA_RESPONSE_CB_ID 

Client. Inform user about response to GetSampledData command.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_metering_get_sampled_data_response_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_WINDOW_COVERING_UP_OPEN_CB_ID 

Server. Inform user about Window Covering Up/Open command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_WINDOW_COVERING_DOWN_CLOSE_CB_ID 

Server. Inform user about Window Covering Down/Close command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_WINDOW_COVERING_STOP_CB_ID 

Server. Inform user about Window Covering Stop command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_WINDOW_COVERING_GO_TO_LIFT_PERCENTAGE_CB_ID 

Server. Inform user about Window Covering Go to Lift Percentage command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_go_to_lift_percentage_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_WINDOW_COVERING_GO_TO_TILT_PERCENTAGE_CB_ID 

Server. Inform user about Window Covering Go to Tilt Percentage command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_go_to_tilt_percentage_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_SCENES_ADD_SCENE_CB_ID 

Server. Inform application about incoming Add Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_add_scene_req_t Fixed part of Add Scene request. Scene Extension Set is placed after this structure (no little-endian conversion).
[out]param_outzb_uint8_t ZCL status - ZB_ZCL_STATUS_INVALID_FIELD, ZB_ZCL_STATUS_SUCCESS or ZB_ZCL_STATUS_INSUFF_SPACE

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command (except the case of updating existing entry). Send Add Scene Response command (with ZCL status from param_out).
RET_ALREADY_EXISTS - successfully handle command (update existing entry). Send Add Scene Response command (with ZCL status from param_out).
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_STORE_SCENE_CB_ID 

Server. Inform application about incoming Store Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_store_scene_req_t
[out]param_outzb_uint8_t ZCL status - ZB_ZCL_STATUS_INVALID_FIELD, ZB_ZCL_STATUS_SUCCESS or ZB_ZCL_STATUS_INSUFF_SPACE

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command (except the case of updating existing entry). Send Store Scene Response command (with ZCL status from param_out).
RET_ALREADY_EXISTS - successfully handle command (update existing entry). Send Store Scene Response command (with ZCL status from param_out).
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_VIEW_SCENE_CB_ID 

Server. Inform application about incoming View Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_view_scene_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. In this case application must send View Scene Response using new buffer. Stack free buffer in this case.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_REMOVE_SCENE_CB_ID 

Server. Inform application about incoming Remove Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_remove_scene_req_t
[out]param_outzb_uint8_t ZCL status - ZB_ZCL_STATUS_INVALID_FIELD, ZB_ZCL_STATUS_SUCCESS or ZB_ZCL_STATUS_NOT_FOUND

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Remove Scene Response command (with ZCL status from param_out).
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_REMOVE_ALL_SCENES_CB_ID 

Server. Inform application about incoming Remove All Scenes request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_remove_all_scenes_req_t
[out]param_outzb_uint8_t ZCL status - ZB_ZCL_STATUS_INVALID_FIELD or ZB_ZCL_STATUS_SUCCESS

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Remove All Scenes Response command (with ZCL status from param_out).
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_RECALL_SCENE_CB_ID 

Server. Inform application about incoming Recall Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_recall_scene_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_GET_SCENE_MEMBERSHIP_CB_ID 

Server. Inform application about incoming Get Scene Membership request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_get_scene_membership_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. In this case application must send Get Scene Membership Response using new buffer. Stack free buffer in this case.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_ENHANCED_ADD_SCENE_CB_ID 

Server. Inform application about incoming Enhanced Add Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_add_scene_req_t Fixed part of Enhanced Add Scene request - it is the same as for the Add Scene request, but the Transition Time field is measured in tenths of a second rather than in seconds. Scene Extension Set is placed after this structure (no little-endian conversion).
[out]param_outzb_uint8_t ZCL status - ZB_ZCL_STATUS_INVALID_FIELD, ZB_ZCL_STATUS_SUCCESS or ZB_ZCL_STATUS_INSUFF_SPACE

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command (except the case of updating existing entry). Send Add Scene Response command (with ZCL status from param_out).
RET_ALREADY_EXISTS - successfully handle command (update existing entry). Send Add Scene Response command (with ZCL status from param_out).
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_ENHANCED_VIEW_SCENE_CB_ID 

Server. Inform application about incoming Enhanced View Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_view_scene_req_t - it is the same as for View Scene request.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. In this case application must send View Scene Response using new buffer. Stack free buffer in this case.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_COPY_SCENE_CB_ID 

Server. Inform application about incoming Copy Scene request.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_copy_scene_req_t
[out]param_outzb_uint8_t *num_copied_scenes - a number of copied scenes. It is used to increase ZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID attribute value in case of successfully scenes copying.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. In this case application must send Copy Scene Response using new buffer. Stack free buffer in this case.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_SCENES_INTERNAL_REMOVE_ALL_SCENES_ALL_ENDPOINTS_CB_ID 

Server. Internal: indicate to application that it is needed to remove all scenes on all endpoints for given group_id.

User's application callback is initialized by RET_ERROR status of device callback parameters.

Parameters
[in]param_inzb_zcl_scenes_remove_all_scenes_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_SCENES_INTERNAL_REMOVE_ALL_SCENES_ALL_ENDPOINTS_ALL_GROUPS_CB_ID 

Server. Internal: indicate to application that it is needed to remove all scenes on all endpoints for all groups (full reset of scenes table).

User's application callback is initialized by RET_ERROR status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors.
ZB_ZCL_DOOR_LOCK_LOCK_DOOR_CB_ID 

Server. Inform user about Door Lock Lock Door command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[out]param_outzb_zcl_door_lock_read_lock_door_res_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Lock Door Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_DOOR_LOCK_UNLOCK_DOOR_CB_ID 

Server. Inform user about Door Lock Unlock Door command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[out]param_outzb_zcl_door_lock_read_unlock_door_res_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Send Unlock Door Response command.
RET_ERROR - command is handled with errors.
ZB_ZCL_DOOR_LOCK_LOCK_DOOR_RESP_CB_ID 

Client. Inform user about Door Lock Lock Door Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_door_lock_read_lock_door_res_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_DOOR_LOCK_UNLOCK_DOOR_RESP_CB_ID 

Client. Inform user about Door Lock Unlock Door Response command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_door_lock_read_unlock_door_res_payload_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_ALARMS_RESET_ALARM_CB_ID 

Server. Inform user about Alarms Reset Alarm command.

User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_alarms_reset_alarm_req_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_ALARMS_RESET_ALL_ALARMS_CB_ID 

Server. Inform user about Alarms Reset All Alarms command.

User's application callback is initialized by RET_OK status of device callback parameters.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors.
ZB_ZCL_ALARMS_ALARM_CB_ID 

Client. Inform user about Alarms Alarm command. User's application callback is initialized by RET_OK status of device callback parameters.

Parameters
[in]param_inzb_zcl_alarms_alarm_res_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handled command. Response will be send if requested.
RET_ERROR - command is handled with errors
ZB_ZCL_WWAH_ENABLE_APP_EVENT_RETRY_ALGORITHM_CB_ID 

Server. Inform user about receiving "Enable WWAH App Event Retry Algorithm" command.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_inzb_zcl_wwah_enable_wwah_app_event_retry_algorithm_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_WWAH_DISABLE_APP_EVENT_RETRY_ALGORITHM_CB_ID 

Server. Inform user about receiving "Disable WWAH App Event Retry Algorithm" command.

User's application callback is initialized by RET_NOT_FOUND status of device callback parameters.

Parameters
[in]param_inzb_zcl_wwah_enable_wwah_app_event_retry_algorithm_t

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Default Response will be send if requested.
RET_ERROR - command is handled with errors. Default Response will be send if requested.
ZB_ZCL_CONTROL4_NETWORK_ZAP_INFO_CB_ID 

Server. Inform user application about Control4 Network ZAP information changes (event=ZB_ZCL_CONTROL4_NETWORK_ZAP_UPDATED) or failure to get changes (event=ZB_ZCL_CONTROL4_NETWORK_ZAP_DISCOVER_FAILED) after expiring the ZB_ZCL_CONTROL4_NETWORK_SEARCHING_ZAP_ATTEMPTS retries

Parameters
[in]param_inzb_zcl_control4_zap_info_notify_t
ZB_ZCL_WWAH_DEBUG_REPORT_QUERY_CB_ID 

Server. Inform user about receiving "Debug Report Query" command. If debug report exists, application must return pointer to this report User's application callback is initialized by RET_NOT_FOUND status of device callback parameter.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command. Debug Report Query Response will be send. param out must point to zb_zcl_wwah_debug_report_t For example: zb_zcl_wwah_debug_report_t debug_report_table[10] ZB_ZCL_DEVICE_CMD_PARAM_OUT_SET(param, &debug_report_table[4]);
RET_ERROR, RET_NOT_FOUND - command is handled with errors. Default Response will be send.
ZB_ZCL_WWAH_SET_IAS_ZONE_ENROLLMENT_METHOD_CB_ID 

Server. Inform user about receiving "Set IAS Zone Enrollment Method" command.

One of the following statuses must be returned:

Returns
RET_OK - successfully handle command.
RET_ERROR - command is handled with errors. Default Response will be send.

Function Documentation

◆ zb_zcl8_get_ctx()

zb_zcl8_globals_t* zb_zcl8_get_ctx ( void  )

Returns ZCL8 context.

Returns
pointer ZCL8 context
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:153
TRACE_MSG
#define TRACE_MSG(lm, fmts, args)
Put trace output.
Definition: zb_trace.h:359
ZB_ZCL_SET_REPORT_ATTR_CB
#define ZB_ZCL_SET_REPORT_ATTR_CB(func_ptr)
Set report attribute callback. The macro sets a callback being called on receive attribute report....
Definition: zboss_api_zcl.h:267
ZB_ZCL_SET_NO_REPORTING_CB
#define ZB_ZCL_SET_NO_REPORTING_CB(func_ptr)
Set no reporting callback. The macro sets a callback being called on remote attribute reporting timeo...
Definition: zboss_api_zcl.h:276
zb_zcl_addr_s
Type to represent source address of ZCL message.
Definition: zb_zcl_common.h:1117
zb_uint16_t
unsigned short zb_uint16_t
Project-local 2-byte unsigned int type.
Definition: zb_types.h:157
zb_zcl_addr_s::zb_zcl_addr_u::short_addr
zb_uint16_t short_addr
Definition: zb_zcl_common.h:1122