zigpc_datastore.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_DATASTORE_H
#define ZIGPC_DATASTORE_H
 
// Shared Unify includes
#include <sl_status.h>
#include <sl_log.h>
 
// ZigPC includes
#include <zigpc_common_zigbee.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
  zigbee_eui64_t gateway_eui64;
  zigbee_panid_t panid;
  zigbee_ext_panid_t ext_panid;
  zigbee_radio_channel_t radio_channel;
} __attribute__((__packed__)) zigpc_network_data_t;
 
typedef struct {
  enum zigbee_node_network_status network_status;
  uint32_t max_cmd_delay;
  uint8_t endpoint_total_count;
  uint8_t endpoint_discovered_count;
} __attribute__((__packed__)) zigpc_device_data_t;
 
typedef struct {
  uint8_t zcl_version;
} __attribute__((__packed__)) zigpc_endpoint_data_t;
 
typedef struct {
  uint8_t dummy; 
} __attribute__((__packed__)) zigpc_cluster_data_t;
 
typedef struct {
  char group_name[ZCL_GROUP_NAME_LENGTH];
} __attribute__((__packed__)) zigpc_group_data_t;
 
/**********************************
 **********************************
 *
 * Network Entity APIs
 *
 **********************************
 **********************************/
 
sl_status_t zigpc_datastore_create_network(void);
 
sl_status_t zigpc_datastore_read_network(zigpc_network_data_t *const data);
 
sl_status_t zigpc_datastore_write_network(const zigpc_network_data_t *data);
 
sl_status_t zigpc_datastore_remove_network(void);
 
/**********************************
 **********************************
 *
 * Device Entity APIs
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_device_count(void);
 
sl_status_t zigpc_datastore_find_device_by_index(size_t index,
                                                 zigbee_eui64_t *const eui64);
 
sl_status_t zigpc_datastore_create_device(const zigbee_eui64_t eui64);
 
sl_status_t zigpc_datastore_read_device(const zigbee_eui64_t eui64,
                                        zigpc_device_data_t *const data);
bool zigpc_datastore_is_device_contained(zigbee_eui64_uint_t device_eui64);
 
sl_status_t zigpc_datastore_write_device(const zigbee_eui64_t eui64,
                                         const zigpc_device_data_t *data);
 
sl_status_t zigpc_datastore_remove_device(const zigbee_eui64_t eui64);
 
sl_status_t zigpc_datastore_remove_device_children(const zigbee_eui64_t eui64);
 
/**********************************
 **********************************
 *
 * Endpoint Entity APIs
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_endpoint_count(const zigbee_eui64_t eui64);
 
sl_status_t zigpc_datastore_find_endpoint_by_index(
  const zigbee_eui64_t eui64, size_t index, zigbee_endpoint_id_t *endpoint_id);
 
sl_status_t zigpc_datastore_create_endpoint(const zigbee_eui64_t eui64,
                                            zigbee_endpoint_id_t endpoint_id);
 
sl_status_t zigpc_datastore_read_endpoint(const zigbee_eui64_t eui64,
                                          zigbee_endpoint_id_t endpoint_id,
                                          zigpc_endpoint_data_t *const data);
 
sl_status_t zigpc_datastore_write_endpoint(const zigbee_eui64_t eui64,
                                           zigbee_endpoint_id_t endpoint_id,
                                           const zigpc_endpoint_data_t *data);
 
sl_status_t zigpc_datastore_remove_endpoint(const zigbee_eui64_t eui64,
                                            zigbee_endpoint_id_t endpoint_id);
 
/**********************************
 **********************************
 *
 * Group Entity APIs
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_group_count(const zigbee_eui64_t eui64,
                                       zigbee_endpoint_id_t endpoint_id,
                                       bool is_reported);
 
sl_status_t
  zigpc_datastore_find_group_by_index(const zigbee_eui64_t eui64,
                                      zigbee_endpoint_id_t endpoint_id,
                                      bool is_reported,
                                      size_t index,
                                      zigbee_group_id_t *group_id);
 
bool zigpc_datastore_contains_group(const zigbee_eui64_t eui64,
                                    zigbee_endpoint_id_t endpoint_id,
                                    bool is_reported,
                                    zigbee_group_id_t group_id);
 
sl_status_t zigpc_datastore_create_group(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         bool is_reported,
                                         zigbee_group_id_t group_id);
 
sl_status_t zigpc_datastore_read_group(const zigbee_eui64_t eui64,
                                       zigbee_endpoint_id_t endpoint_id,
                                       bool is_reported,
                                       zigbee_group_id_t group_id,
                                       zigpc_group_data_t *const data);
 
sl_status_t zigpc_datastore_write_group(const zigbee_eui64_t eui64,
                                        zigbee_endpoint_id_t endpoint_id,
                                        bool is_reported,
                                        zigbee_group_id_t group_id,
                                        const zigpc_group_data_t *data);
 
sl_status_t zigpc_datastore_remove_group(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         bool is_reported,
                                         zigbee_group_id_t group_id);
/**********************************
 **********************************
 *
 * Cluster Entity APIs
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_cluster_count(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         zcl_cluster_side_t cluster_side);
 
sl_status_t
  zigpc_datastore_find_cluster_by_index(const zigbee_eui64_t eui64,
                                        zigbee_endpoint_id_t endpoint_id,
                                        zcl_cluster_side_t cluster_side,
                                        size_t index,
                                        zcl_cluster_id_t *cluster_id);
 
bool zigpc_datastore_contains_cluster(const zigbee_eui64_t eui64,
                                      zigbee_endpoint_id_t endpoint_id,
                                      zcl_cluster_side_t cluster_side,
                                      zcl_cluster_id_t cluster_id);
 
sl_status_t zigpc_datastore_create_cluster(const zigbee_eui64_t eui64,
                                           zigbee_endpoint_id_t endpoint_id,
                                           zcl_cluster_side_t cluster_side,
                                           zcl_cluster_id_t cluster_id);
 
sl_status_t zigpc_datastore_read_cluster(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         zcl_cluster_side_t cluster_side,
                                         zcl_cluster_id_t cluster_id,
                                         zigpc_cluster_data_t *const data);
 
sl_status_t zigpc_datastore_write_cluster(const zigbee_eui64_t eui64,
                                          zigbee_endpoint_id_t endpoint_id,
                                          zcl_cluster_side_t cluster_side,
                                          zcl_cluster_id_t cluster_id,
                                          const zigpc_cluster_data_t *data);
 
sl_status_t zigpc_datastore_remove_cluster(const zigbee_eui64_t eui64,
                                           zigbee_endpoint_id_t endpoint_id,
                                           zcl_cluster_side_t cluster_side,
                                           zcl_cluster_id_t cluster_id);
 
/**********************************
 **********************************
 *
 * Cluster Attribute List API
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_attribute_count(const zigbee_eui64_t eui64,
                                           zigbee_endpoint_id_t endpoint_id,
                                           zcl_cluster_side_t cluster_side,
                                           zcl_cluster_id_t cluster_id);
 
sl_status_t
  zigpc_datastore_read_attribute_list(const zigbee_eui64_t eui64,
                                      zigbee_endpoint_id_t endpoint_id,
                                      zcl_cluster_side_t cluster_side,
                                      zcl_cluster_id_t cluster_id,
                                      zcl_attribute_id_t *const attribute_list,
                                      size_t *attribute_count);
 
sl_status_t
  zigpc_datastore_write_attribute_list(const zigbee_eui64_t eui64,
                                       zigbee_endpoint_id_t endpoint_id,
                                       zcl_cluster_side_t cluster_side,
                                       zcl_cluster_id_t cluster_id,
                                       const zcl_attribute_id_t *attribute_list,
                                       size_t attribute_count);
 
/**********************************
 **********************************
 *
 * Cluster Command List API
 *
 **********************************
 **********************************/
 
size_t zigpc_datastore_get_command_count(const zigbee_eui64_t eui64,
                                         zigbee_endpoint_id_t endpoint_id,
                                         zcl_cluster_side_t cluster_side,
                                         zcl_cluster_id_t cluster_id,
                                         zcl_command_type_t command_type);
 
sl_status_t
  zigpc_datastore_read_command_list(const zigbee_eui64_t eui64,
                                    zigbee_endpoint_id_t endpoint_id,
                                    zcl_cluster_side_t cluster_side,
                                    zcl_cluster_id_t cluster_id,
                                    zcl_command_type_t command_type,
                                    zcl_command_id_t *const command_list,
                                    size_t *command_count);
 
sl_status_t
  zigpc_datastore_write_command_list(const zigbee_eui64_t eui64,
                                     zigbee_endpoint_id_t endpoint_id,
                                     zcl_cluster_side_t cluster_side,
                                     zcl_cluster_id_t cluster_id,
                                     zcl_command_type_t command_type,
                                     const zcl_command_id_t *command_list,
                                     size_t command_count);
 
/**********************************
 **********************************
 *
 * Utility Functions
 *
 **********************************
 **********************************/
 
sl_status_t zigpc_datastore_find_endpoint_containing_cluster(
  const zigbee_eui64_t eui64,
  zcl_cluster_side_t cluster_side,
  zcl_cluster_id_t cluster_id,
  zigbee_endpoint_id_t *const endpoint_id);
 
/**********************************
 **********************************
 *
 * Utility Logging API
 *
 **********************************
 **********************************/
 
void zigpc_datastore_log_device_disc_state(const zigbee_eui64_t eui64);
 
sl_status_t zigpc_datastore_log_network(const char *log_tag,
                                        sl_log_level_t log_level,
                                        const char *log_prefix);
 
sl_status_t zigpc_datastore_log_device(const char *log_tag,
                                       sl_log_level_t log_level,
                                       const char *log_prefix,
                                       const zigbee_eui64_t eui64);
 
void zigpc_datastore_log_clusters(
    const zigbee_eui64_t eui64,
    const zigbee_endpoint_id_t endpoint_id);
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZIGPC_DATASTORE_H