tr_zcl_common.h

Go to the documentation of this file.

#ifndef TR_ZCL_COMMON_H
#define TR_ZCL_COMMON_H
 
#define TR_ZCL_INVALID_ENDPOINT_NUMBER 0xFF
#define TR_ZCL_INVALID_INSTANCE_NUMBER 0xFF
 
// ZCL frame direction
#define TR_ZCL_FRAME_DIRECTION_TO_SERVER 0x00U
#define TR_ZCL_FRAME_DIRECTION_TO_CLIENT 0x01U
 
// ZCL frame control type field
#define TR_ZCL_FRAME_TYPE_MASK     0x03
#define TR_ZCL_FRAME_TYPE_GLOBAL   0x00
#define TR_ZCL_FRAME_TYPE_SPECIFIC 0x01
 
// *****************************************************************************
// this macro sets a ZCL frame control byte in the buffer passed in and then
// increments the buffer.
// This one is for server-to-client commands from the ZCL plugins.
// the ZCL frame control byte is set to:
// 1. cluster specific command,
// 2. not mfg specific,
// 3. use the Trident global policy for default responses to this command
// *****************************************************************************
#define TR_ZCL_CONSTRUCT_FRAME_CONTROL_TO_CLIENT(buf_ptr)                       \
        (ZB_ZCL_CONSTRUCT_SET_FRAME_CONTROL(*(buf_ptr),                         \
                                            ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC, \
                                            ZB_ZCL_NOT_MANUFACTURER_SPECIFIC,   \
                                            TR_ZCL_FRAME_DIRECTION_TO_CLIENT,   \
                                            TR_GLOBAL_RESPONSE_POLICY),         \
         (buf_ptr)++)
 
// *****************************************************************************
// this macro sets a ZCL frame control byte in the buffer passed in and then
// increments the buffer.
// This one is for client-to-server commands from the ZCL plugins.
// the ZCL frame control byte is set to:
// 1. cluster specific command,
// 2. not mfg specific,
// 3. use the Trident global policy for default responses to this command
// *****************************************************************************
#define TR_ZCL_CONSTRUCT_FRAME_CONTROL_TO_SERVER(buf_ptr)                       \
        (ZB_ZCL_CONSTRUCT_SET_FRAME_CONTROL(*(buf_ptr),                         \
                                            ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC, \
                                            ZB_ZCL_NOT_MANUFACTURER_SPECIFIC,   \
                                            TR_ZCL_FRAME_DIRECTION_TO_SERVER,   \
                                            TR_GLOBAL_RESPONSE_POLICY),         \
         (buf_ptr)++)
 
// *****************************************************************************
// enum used in tr_zcl_cmd_handler_status_t struct
// USER_PROCESSED = user handled, no default resp, no buffer free
// SENT_RESPONSE = cmd had a resp, no default resp, no buffer free
// ATTEMPT_DEF_RESP = send a def resp unless disabled && status == SUCCESS
// *****************************************************************************
typedef enum
{
    TR_ZCL_CMD_HDLR_USER_PROCESSED       = 0,
    TR_ZCL_CMD_HDLR_PLUGIN_SENT_RESPONSE = 1,
    TR_ZCL_CMD_HDLR_ATTEMPT_DEF_RESP     = 2
 
} tr_zcl_cmd_handler_enum_t;
 
// *****************************************************************************
// struct for specifying if a default resp should be tried or not
// *****************************************************************************
typedef struct
{
    tr_zcl_cmd_handler_enum_t status;
    zb_uint8_t                zcl_status;
}tr_zcl_cmd_handler_status_t;


zb_uint8_t tr_zcl_command_cb(zb_uint8_t param);


zb_uint8_t tr_zcl_specific_cluster_cmd_handler(zb_uint8_t param);

zb_uint8_t tr_zcl_get_endpoint_by_cluster(zb_uint8_t  ep_instance,
                                          zb_uint16_t cluster_id,
                                          zb_uint16_t cluster_role);

zb_uint8_t tr_zcl_get_instance_by_cluster(zb_uint8_t  endpoint_looking_for,
                                          zb_uint16_t cluster_id,
                                          zb_uint16_t cluster_role);

void tr_zcl_send_default_resp(zb_uint8_t                  param,
                              zb_zcl_parsed_hdr_t         *cmd_info,
                              tr_zcl_cmd_handler_status_t handler_status,
                              zb_uint16_t                 cluster_id);

void tr_zcl_send_cluster_command_resp(zb_bufid_t          buffer,
                                      zb_zcl_parsed_hdr_t *cmd_info,
                                      zb_uint16_t         cluster_id,
                                      zb_uint8_t          direction,
                                      zb_uint8_t          zcl_cmd,
                                      zb_uint8_t          payload_len,
                                      zb_uint8_t          *payload,
                                      zb_callback_t       sent_callback);

void tr_zcl_plugin_attributes_ready(void);

char *tr_zcl_find_cluster_name(zb_uint16_t cluster_id);
 
#endif /* TR_ZCL_COMMON_H */