attribute_management_int.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 ATTRIBUTE_MANAGEMENT_INT_H
#define ATTRIBUTE_MANAGEMENT_INT_H
 
#include "sl_status.h"
#include "sys/ctimer.h"
 
#include "zigpc_common_zigbee.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
static const unsigned int ZIGPC_ATTR_MGMT_DELAY_READ_ATTRIBUTES
  = CLOCK_SECOND * 5;
  
static const unsigned int ZIGPC_ATTRMGMT_READ_RECORDS_LIMIT_PER_MESSAGE = 25;
 
static const unsigned int ZIGPC_ATTRMGMT_REPORT_RECORDS_LIMIT_PER_MESSAGE = 5;
 
static const uint16_t ZIGPC_ATTRMGMT_REPORT_INTERVAL_MIN_DEFAULT = 1000;
 
static const uint16_t ZIGPC_ATTRMGMT_REPORT_INTERVAL_MAX_DEFAULT = 10000;
 
static const uint32_t ZIGPC_ATTRMGMT_REPORT_CHANGE_DEFAULT = 0x0001;
 
static const uint32_t ZIGPC_ATTRMGMT_DEFAULT_POLL_SIZE = 256;
 
enum attr_mgmt_evt {
  ZIGPC_ATTR_MGMT_EVT_INIT_NODE = 0,
  ZIGPC_ATTR_MGMT_EVT_INIT_ENDPOINT,
 
  ZIGPC_ATTR_MGMT_EVT_ATTR_UPDATE,
  ZIGPC_ATTR_MGMT_EVT_CONFIGURE_RESPONSE,
  ZIGPC_ATTR_MGMT_EVT_READ_ATTRIBUTES_COMMAND,
};
 
typedef struct {
  zigbee_node_t node;
} node_config_report_data_t;
 
typedef struct {
  zigbee_eui64_t eui64;
  zigbee_endpoint_t endpoint;
} endpoint_config_report_data_t;
 
typedef struct {
  zigbee_eui64_t eui64;
  zigbee_endpoint_id_t endpoint_id;
  zcl_cluster_id_t cluster_id;
  struct ctimer timer;
} zigpc_attr_mgmt_read_data_t;
 
typedef struct {
  zigbee_eui64_t eui64;
  zigbee_endpoint_id_t endpoint_id;
  char *cluster_string;
  unsigned int cluster_string_size;
  char *attributes_string;
  unsigned int attr_string_size;
} zigpc_attr_mgmt_write_data_t;
 
typedef struct {
  zigbee_eui64_t eui64;
  zigbee_endpoint_id_t endpoint_id;
  zcl_cluster_id_t cluster_id;
  zcl_attribute_id_t attribute_id;
  enum e_zcl_attribute_type type;
  uint8_t *data;
} attribute_report_t;
 
typedef struct {
  zigbee_eui64_t eui64;             
  zigbee_endpoint_id_t endpoint_id; 
  zcl_cluster_id_t cluster_id;      
  bool is_read_response;            
  zcl_frame_t frame;                
} zigpc_attrmgmt_on_frame_receive_t;
 
sl_status_t zigpc_attrmgmt_process_send_event(const enum attr_mgmt_evt event,
                                              const void *data,
                                              size_t data_size);
 
size_t zigpc_attrmgmt_get_records_to_send_in_message(size_t start_index,
                                                     size_t count,
                                                     size_t limit);
 
sl_status_t zigpc_attrmgmt_configure_reports_for_endpoint(
  const zigbee_eui64_t eui64, const zigbee_endpoint_t endpoint);
 
sl_status_t node_send_report_config_cmd(const zigbee_node_t node);
 
sl_status_t zigpc_attribute_management_read_cluster_attributes(
  const zigbee_eui64_t eui64,
  zigbee_endpoint_id_t endpoint_id,
  zcl_cluster_id_t cluster_id);
 
void zigpc_attrmgmt_send_delayed_read_command_callback(void *read_data);
 
 
sl_status_t
  zigpc_attrmgmt_send_read_attributes_command(const zigbee_eui64_t eui64,
                                              zigbee_endpoint_id_t endpoint_id,
                                              zcl_cluster_id_t cluster_id);
 
sl_status_t
  zigpc_attrmgmt_receive_attribute_frame(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         zcl_cluster_id_t cluster_id,
                                         bool is_read_response,
                                         const zcl_frame_t *frame);
 
sl_status_t zigpc_attrmgmt_receive_configure_response_frame(
  const zigbee_eui64_t eui64,
  zigbee_endpoint_id_t endpoint_id,
  zcl_cluster_id_t cluster_id,
  const zcl_frame_t *frame);
 
#ifdef COMPILE_UNUSED_CODE
 
sl_status_t update_attribute_from_report(const attribute_report_t report);
 
#endif  // COMPILE_UNUSED_CODE
 
sl_status_t attr_mgmt_gateway_init_observer(void);
 
sl_status_t
  zigpc_attrmgmt_publish_reported(const zigbee_eui64_uint_t eui64,
                                  const zigbee_endpoint_id_t endpoint_id,
                                  const zcl_cluster_id_t cluster_id,
                                  const zcl_attribute_id_t attr_id,
                                  const uint8_t *attr_value);
 
size_t zigpc_attrmgmt_get_poll_list_current_size();
 
size_t zigpc_attrmgmt_get_poll_list_max_size();
 
sl_status_t zigpc_attrmgmt_send_poll_attributes();
 
sl_status_t zigpc_attrmgmt_add_poll_entry(const zigbee_eui64_t eui64,
                                          zigbee_endpoint_id_t endpoint_id,
                                          zcl_cluster_id_t cluster_id);
 
sl_status_t zigpc_attrmgmt_remove_poll_entry(const zigbee_eui64_t eui64,
                                             zigbee_endpoint_id_t endpoint_id,
                                             zcl_cluster_id_t cluster_id);
 
void zigpc_attrmgmt_empty_poll_list();
 
#ifdef __cplusplus
}
#endif
 
#endif  //ATTRIBUTE_MANAGEMENT_INT_H