datastore_attributes.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 DATASTORE_ATTRIBUTES_H
#define DATASTORE_ATTRIBUTES_H
 
#include <inttypes.h>
#include <stdbool.h>
#include "sl_status.h"
 
#define DATASTORE_ATTRIBUTE_VALUE_SIZE 255
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint32_t datastore_attribute_id_t;
 
typedef struct _datastore_attribute_ {
  datastore_attribute_id_t id;
  uint32_t type;
  datastore_attribute_id_t parent_id;
  uint8_t reported_value[DATASTORE_ATTRIBUTE_VALUE_SIZE];
  uint8_t reported_value_size;
  uint8_t desired_value[DATASTORE_ATTRIBUTE_VALUE_SIZE];
  uint8_t desired_value_size;
} datastore_attribute_t;
 
sl_status_t datastore_store_attribute(datastore_attribute_id_t id,
                                      uint32_t type,
                                      datastore_attribute_id_t parent_id,
                                      const uint8_t *reported_value,
                                      uint8_t reported_value_size,
                                      const uint8_t *desired_value,
                                      uint8_t desired_value_size);
 
sl_status_t datastore_fetch_attribute(const datastore_attribute_id_t id,
                                      uint32_t *type,
                                      datastore_attribute_id_t *parent_id,
                                      uint8_t *reported_value,
                                      uint8_t *reported_value_size,
                                      uint8_t *desired_value,
                                      uint8_t *desired_value_size);
 
sl_status_t datastore_fetch_all_attributes(datastore_attribute_t *attribute);
 
sl_status_t datastore_fetch_attribute_child(datastore_attribute_id_t parent_id,
                                            uint32_t child_index,
                                            datastore_attribute_id_t *child_id,
                                            uint32_t *type,
                                            uint8_t *reported_value,
                                            uint8_t *reported_value_size,
                                            uint8_t *desired_value,
                                            uint8_t *desired_value_size);
 
sl_status_t
  datastore_fetch_attribute_child_id(datastore_attribute_id_t parent_id,
                                     uint32_t child_index,
                                     datastore_attribute_id_t *child_id);
 
bool datastore_contains_attribute(const datastore_attribute_id_t id);
 
sl_status_t datastore_delete_attribute(const datastore_attribute_id_t id);
 
sl_status_t datastore_delete_all_attributes();
 
#ifdef __cplusplus
}
#endif
 
#endif  //DATASTORE_ATTRIBUTES_H