Super-2024-Swadge-FW/hdw-nvs_8h_source.html

#ifndef _NVS_MANAGER_H_

#define _NVS_MANAGER_H_


#include <stdbool.h>

#include <stdint.h>

#include <stddef.h>


#include "nvs.h"

#include "linked_list.h"


//==============================================================================

// Defines

//==============================================================================


#define NVS_PART_NAME_MAX_SIZE 16

#define NVS_KEY_NAME_MAX_SIZE  16

#define NVS_NAMESPACE_NAME     "storage"


//==============================================================================

// Function Prototypes

//==============================================================================


bool initNvs(bool firstTry);

bool deinitNvs(void);

bool eraseNvs(void);

bool readNvs32(const char* key, int32_t* outVal);

bool writeNvs32(const char* key, int32_t val);

bool readNamespaceNvs32(const char* namespace, const char* key, int32_t* outVal);

bool writeNamespaceNvs32(const char* namespace, const char* key, int32_t val);

bool readNvsBlob(const char* key, void* out_value, size_t* length);

bool writeNvsBlob(const char* key, const void* value, size_t length);

bool readNamespaceNvsBlob(const char* namespace, const char* key, void* out_value, size_t* length);

bool writeNamespaceNvsBlob(const char* namespace, const char* key, const void* value, size_t length);

bool eraseNvsKey(const char* key);

bool eraseNamespaceNvsKey(const char* namespace, const char* key);

bool readNvsStats(nvs_stats_t* outStats);

bool readAllNvsEntryInfos(nvs_stats_t* outStats, nvs_entry_info_t* outEntryInfos, size_t* numEntryInfos);

bool readNamespaceNvsEntryInfos(const char* namespace, nvs_stats_t* outStats, nvs_entry_info_t* outEntryInfos,

                                size_t* numEntryInfos);

bool nvsNamespaceInUse(const char* namespace);

void getNvsKeys(const char* namespace, list_t* list);


#endif

eraseNamespaceNvsKey
bool eraseNamespaceNvsKey(const char *namespace, const char *key)
Delete the value with the given key from NVS.
Definition hdw-nvs.c:487

eraseNvsKey
bool eraseNvsKey(const char *key)
Delete the value with the given key from NVS.
Definition hdw-nvs.c:475

readNamespaceNvs32
bool readNamespaceNvs32(const char *namespace, const char *key, int32_t *outVal)
Read a 32 bit value from NVS with a given string key.
Definition hdw-nvs.c:168

readAllNvsEntryInfos
bool readAllNvsEntryInfos(nvs_stats_t *outStats, nvs_entry_info_t *outEntryInfos, size_t *numEntryInfos)
Read info about each used entry in the default NVS namespace. Typically, this should be called once w...
Definition hdw-nvs.c:587

readNvsStats
bool readNvsStats(nvs_stats_t *outStats)
Read info about used memory in NVS.
Definition hdw-nvs.c:556

readNamespaceNvsBlob
bool readNamespaceNvsBlob(const char *namespace, const char *key, void *out_value, size_t *length)
Read a blob from NVS with a given string key. Typically, this should be called once with NULL passed ...
Definition hdw-nvs.c:339

writeNamespaceNvsBlob
bool writeNamespaceNvsBlob(const char *namespace, const char *key, const void *value, size_t length)
Write a blob to NVS with a given string key.
Definition hdw-nvs.c:407

writeNvs32
bool writeNvs32(const char *key, int32_t val)
Write a 32 bit value to NVS with a given string key.
Definition hdw-nvs.c:155

eraseNvs
bool eraseNvs(void)
Erase and re-initialize the nonvolatile storage.
Definition hdw-nvs.c:103

readNvsBlob
bool readNvsBlob(const char *key, void *out_value, size_t *length)
Read a blob from NVS with a given string key. Typically, this should be called once with NULL passed ...
Definition hdw-nvs.c:309

readNvs32
bool readNvs32(const char *key, int32_t *outVal)
Read a 32 bit value from NVS with a given string key.
Definition hdw-nvs.c:143

getNvsKeys
void getNvsKeys(const char *namespace, list_t *list)
Fill a given list_t with all the NVS string keys for the given namespace.
Definition hdw-nvs.c:657

deinitNvs
bool deinitNvs(void)
Deinitialize NVS.
Definition hdw-nvs.c:93

readNamespaceNvsEntryInfos
bool readNamespaceNvsEntryInfos(const char *namespace, nvs_stats_t *outStats, nvs_entry_info_t *outEntryInfos, size_t *numEntryInfos)
Read info about each used entry in a specific NVS namespace. Typically, this should be called once wi...
Definition hdw-nvs.c:605

writeNvsBlob
bool writeNvsBlob(const char *key, const void *value, size_t length)
Write a blob to NVS with a given string key.
Definition hdw-nvs.c:322

nvsNamespaceInUse
bool nvsNamespaceInUse(const char *namespace)
Quickly return whether or not any entries exist in a given NVS namespace.
Definition hdw-nvs.c:700

initNvs
bool initNvs(bool firstTry)
Initialize the nonvolatile storage.
Definition hdw-nvs.c:36

writeNamespaceNvs32
bool writeNamespaceNvs32(const char *namespace, const char *key, int32_t val)
Write a 32 bit value to NVS with a given string key.
Definition hdw-nvs.c:236

linked_list.h

list_t
A doubly linked list with pointers to the first and last nodes.
Definition linked_list.h:87