Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
cascoda_settings.h File Reference

This file includes platform abstraction for non-volatile storage of settings. More...

#include "ca821x_api.h"
Include dependency graph for cascoda_settings.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  settingBuffer
 Data structure for vectored I/O using caUtilSettingsAddVector. More...
 

Functions

void caUtilSettingsInit (struct ca821x_dev *aInstance, const char *aApplicationName, uint32_t aNodeId)
 Performs any initialization for the settings subsystem, if necessary. More...
 
void caUtilSettingsDeinit (struct ca821x_dev *aInstance)
 Performs any de-initialization for the settings subsystem, if necessary. More...
 
ca_error caUtilSettingsGet (struct ca821x_dev *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
 This function fetches the value of the setting identified by aKey and write it to the memory pointed to by aValue. More...
 
ca_error caUtilSettingsSet (struct ca821x_dev *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
 Sets or replaces the value of a setting. More...
 
ca_error caUtilSettingsAdd (struct ca821x_dev *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
 Adds a value to a setting This function adds the value to a setting identified by aKey, without replacing any existing values. More...
 
ca_error caUtilSettingsDelete (struct ca821x_dev *aInstance, uint16_t aKey, int aIndex)
 Removes a setting from the setting store. More...
 
void caUtilSettingsWipe (struct ca821x_dev *aInstance, const char *aApplicationName, uint32_t aNodeId)
 Removes all settings from the setting store. More...
 
ca_error caUtilSettingsGetAddress (struct ca821x_dev *aInstance, uint16_t aKey, int aIndex, void **aValue, uint16_t *aValueLength)
 Get the address at which a particular setting is stored. More...
 
ca_error caUtilSettingsAddVector (struct ca821x_dev *aInstance, uint16_t aKey, struct settingBuffer *aVector, size_t aCount)
 Add a vector of buffers to the storage. More...
 

Detailed Description

This file includes platform abstraction for non-volatile storage of settings.