zcl_util.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZIGPC_ZCL_UTIL_H
#define ZIGPC_ZCL_UTIL_H
 
#include "zigpc_common_zigbee.h"
 
#include "zcl_definitions.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
 
  ZIGPC_ZCL_FRAME_TYPE_CMD_TO_SERVER
  = (ZCL_FRAME_CONTROL_FRAME_TYPE_CLUSTER
     | ZCL_FRAME_CONTROL_DIRECTION_CLIENT_TO_SERVER),
  ZIGPC_ZCL_FRAME_TYPE_GLOBAL_CMD_TO_SERVER
  = (ZCL_FRAME_CONTROL_FRAME_TYPE_GLOBAL_COMMAND
     | ZCL_FRAME_CONTROL_DIRECTION_CLIENT_TO_SERVER),
 
} zigpc_zcl_frame_type_t;
 
typedef struct {
  zigpc_zcl_data_type_t type;
  const void *data;
} zigpc_zcl_frame_data_t;
 
size_t zigpc_zcl_get_data_type_size(zigpc_zcl_data_type_t type);
 
sl_status_t zigpc_zcl_frame_init_command(zcl_frame_t *const frame,
                                         zcl_command_id_t command_id,
                                         uint8_t frame_control);
 
sl_status_t zigpc_zcl_frame_fill_data(zcl_frame_t *const frame,
                                      zigpc_zcl_data_type_t type,
                                      const void *data);
 
sl_status_t zigpc_zcl_frame_fill_data_array(zcl_frame_t *const frame,
                                            zigpc_zcl_data_type_t type,
                                            size_t type_count,
                                            const void *data);
 
sl_status_t zigpc_zcl_build_command_frame(
  zcl_frame_t *const frame,
  const zigpc_zcl_frame_type_t frame_type,
  const zcl_cluster_id_t cluster_id,
  const zcl_command_id_t command_id,
  const size_t command_arg_count,
  const zigpc_zcl_frame_data_t *const command_arg_list);
 
size_t zigpc_zcl_get_type_size(zigpc_zcl_data_type_t type);
 
size_t zigpc_zcl_get_number_supported_clusters();
 
const uint16_t* zigpc_zcl_get_supported_cluster_list();
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZIGPC_ZCL_UTIL_H */