attribute_store.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_STORE_H
#define ATTRIBUTE_STORE_H
 
// Includes from this component
 
// Includes from other components
#include "datastore_attributes.h"
#include "sl_status.h"
#include <stddef.h>
 
#ifdef ATTRIBUTE_TYPE_MAP
#define DEFINE_ATTRIBUTE(name, value) {value, #name},
#else
#ifdef ATTRIBUTE_NAME_MAP
#define DEFINE_ATTRIBUTE(name, value) {#name, value},
#else
#define DEFINE_ATTRIBUTE(name, value) enum { name = value };
#endif
#endif
 
#define ATTRIBUTE_STORE_INVALID_ATTRIBUTE_TYPE \
  ((attribute_store_type_t)0x0000)  
 
#define ATTRIBUTE_TREE_ROOT \
  ((attribute_store_type_t)0x0001)  
 
typedef uint32_t attribute_store_type_t;
 
//typedef void *attribute_store_node_t;
typedef datastore_attribute_id_t attribute_store_node_t;
 
#define ATTRIBUTE_STORE_MAXIMUM_VALUE_LENGTH DATASTORE_ATTRIBUTE_VALUE_SIZE
#define ATTRIBUTE_STORE_INVALID_NODE (attribute_store_node_t)0
 
typedef enum {
  ATTRIBUTE_CREATED,
  ATTRIBUTE_UPDATED,
  ATTRIBUTE_DELETED,
} attribute_store_change_t;
 
typedef enum {
  REPORTED_ATTRIBUTE,  
  DESIRED_ATTRIBUTE,  
  DESIRED_OR_REPORTED_ATTRIBUTE,  
} attribute_store_node_value_state_t;
 
typedef void (*attribute_store_node_changed_callback_t)(
  attribute_store_node_t, attribute_store_change_t);
 
typedef void (*attribute_store_node_touch_callback_t)(attribute_store_node_t);
 
typedef void (*attribute_store_node_delete_callback_t)(attribute_store_node_t);
 
typedef struct attribute_changed_event {
  attribute_store_node_t updated_node;
  attribute_store_type_t type;
  attribute_store_node_value_state_t value_state;
  attribute_store_change_t change;
} attribute_changed_event_t;
 
typedef void (*attribute_store_node_update_callback_t)(
  attribute_changed_event_t *event_data);
 
#ifdef __cplusplus
extern "C" {
#endif
 
attribute_store_node_t attribute_store_get_root();
 
attribute_store_node_t
  attribute_store_add_node(attribute_store_type_t type,
                           attribute_store_node_t parent_node);
sl_status_t attribute_store_delete_node(attribute_store_node_t node);
 
attribute_store_node_t
  attribute_store_get_node_parent(attribute_store_node_t node);
 
attribute_store_node_t attribute_store_get_first_parent_with_type(
  attribute_store_node_t node, attribute_store_type_t parent_type);
 
sl_status_t attribute_store_set_node_attribute_value(
  attribute_store_node_t node,
  attribute_store_node_value_state_t value_state,
  const uint8_t *value,
  uint8_t value_size);
 
sl_status_t attribute_store_get_node_attribute_value(
  attribute_store_node_t node,
  attribute_store_node_value_state_t value_state,
  uint8_t *value,
  uint8_t *value_size);
 
attribute_store_type_t
  attribute_store_get_node_type(attribute_store_node_t node);
 
attribute_store_node_t
  attribute_store_get_node_child(attribute_store_node_t node,
                                 uint32_t child_index);
 
size_t attribute_store_get_node_child_count(attribute_store_node_t node);
 
size_t attribute_store_get_node_child_count_by_type(
  attribute_store_node_t node, attribute_store_type_t child_type);
 
size_t attribute_store_get_node_total_child_count(attribute_store_node_t node);
 
attribute_store_node_t
  attribute_store_get_node_child_by_type(attribute_store_node_t node,
                                         attribute_store_type_t child_type,
                                         uint32_t child_index);
 
static inline attribute_store_node_t
  attribute_store_get_first_child_by_type(attribute_store_node_t node,
                                          attribute_store_type_t child_type)
{
  return attribute_store_get_node_child_by_type(node, child_type, 0);
}
 
attribute_store_node_t attribute_store_get_node_child_by_value(
  attribute_store_node_t node,
  attribute_store_type_t child_type,
  attribute_store_node_value_state_t value_state,
  const uint8_t *value,
  uint8_t value_size,
  uint32_t child_index);
 
sl_status_t attribute_store_register_callback(
  attribute_store_node_update_callback_t callback_function);
 
sl_status_t attribute_store_register_touch_notification_callback(
  attribute_store_node_touch_callback_t callback_function);
 
sl_status_t attribute_store_register_delete_callback(
  attribute_store_node_delete_callback_t callback_function);
 
sl_status_t attribute_store_register_callback_by_type(
  attribute_store_node_changed_callback_t callback_function,
  attribute_store_type_t type);
 
sl_status_t attribute_store_register_callback_by_type_and_state(
  attribute_store_node_changed_callback_t callback_function,
  attribute_store_type_t type,
  attribute_store_node_value_state_t value_state);
 
bool attribute_store_node_exists(attribute_store_node_t node);
 
bool attribute_store_is_node_a_child(attribute_store_node_t node,
                                     attribute_store_node_t possible_parent);
 
uint8_t attribute_store_get_node_value_size(
  attribute_store_node_t node, attribute_store_node_value_state_t value_state);
 
sl_status_t attribute_store_refresh_node_and_children_callbacks(
  attribute_store_node_t node);
 
void attribute_store_log(void);
 
void attribute_store_log_node(attribute_store_node_t node, bool log_children);
 
#ifdef __cplusplus
}
#endif
 
#endif  //ATTRIBUTE_STORE_H