ESP32-IDF04-2 存储-NVS
Posted Ciaran-byte
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了ESP32-IDF04-2 存储-NVS相关的知识，希望对你有一定的参考价值。
NVS
文章目录
1. NVS
1.1 概述
NVS全称是非易失性存储。用在flash中以键值对的形成存储数据。
NVS 适合存储一些小数据，如果对象占用空间比较大，使用负载均衡的fat文件系统
如果nvs分区被截断，比如更改分区表布局的时候，应该擦除分区内容。可以使用idf.py erase_flash 命令擦除flash上全部的内容
1.2 键值对
key最大键长为154字符
value可以使用以下数据类型
- 整数型：uint8_t、int8_t、uint16_t、int16_t、uint32_t、int32_t、uint64_t 和 int64_t；
- 以 \\0 结尾的字符串；
- 可变长度的二进制数据 (BLOB)
1.2 命名空间
为了减少不同组件之间键名的潜在冲突，NVS 将每个键值对分配给一个命名空间。命名空间的命名规则遵循键名的命名规则，即最多可占 15 个字符。命名空间的名称在调用 nvs_open 或 nvs_open_from_part 中指定，调用后将返回一个不透明句柄，用于后续调用 nvs_get_、nvs_set_ 和 nvs_commit 函数。这样，一个句柄关联一个命名空间，键名便不会与其他命名空间中相同键名冲突。请注意，不同 NVS 分区中具有相同名称的命名空间将被视为不同的命名空间。
1.3 NVS使用流程
1.3.1 配置分区表
配置分区表: 我们也可以使用默认的分区表。默认分区表中nvs大小是24k(0x6000),可以根据自己需要对nvs空间进行修改
1.3.2 擦除nvs空间
如果nvs空间已经满了，或者希望清空原来的数据，就需要执行这一步
nvs_flash_erase()
1.3.3 初始化nvs空间
nvs 空间使用前要进行初始化
nvs_flash_init();
1.3.4 获取nvs空间的操作句柄
对nvs空间进行操作的时候，是使用句柄实现的。
同时，为了尽可能减少键值对的冲突，nvs引入了命名空间的概念，不同命名空间下的key捕获产生冲突。
同时也要在这里配置对nvs空间进行操作的权限，分为读和读写两种
nvs_handle_t my_handle;
nvs_open("storage", NVS_READWRITE, &my_handle);
1.3.4 读写nvs空间
按照不同的数据类型，对数据进行get和set操作
nvs_set_i8(nvs_handle_thandle, const char *key, int8_t value);
nvs_set_u8(nvs_handle_thandle, const char *key, uint8_t value);
nvs_set_i16(nvs_handle_thandle, const char *key, int16_t value);
nvs_set_u16(nvs_handle_thandle, const char *key, uint16_t value);
nvs_set_i32(nvs_handle_thandle, const char *key, int32_t value);
nvs_set_u32(nvs_handle_thandle, const char *key, uint32_t value);
nvs_set_i64(nvs_handle_thandle, const char *key, int64_t value);
nvs_set_u64(nvs_handle_thandle, const char *key, uint64_t value);
nvs_set_str(nvs_handle_thandle, const char *key, const char *value);
nvs_get_blob(nvs_handle_thandle, const char *key, void *out_value, size_t *length);
1.3.4 提交修改
nvs_commit(my_handle); //在修改被提交之前，是不会写入到falsh中的
1.3.5 关闭nvs空间
nvs_close(my_handle);
2. 使用案例
2.1 单变量操作
/*
Name: Sketch1.ino
Created: 2021/4/12 18:46:05
Author: hp
*/
// the setup function runs once when you press reset or power the board
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_system.h"
#include "nvs_flash.h"
#include "nvs.h"
void setup() {
//01 初始化nvs flash
esp_err_t err = nvs_flash_init();
//02 如果nvs flash 满了就清空
if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
// NVS partition was truncated and needs to be erased
// Retry nvs_flash_init
ESP_ERROR_CHECK(nvs_flash_erase());
err = nvs_flash_init();
}
ESP_ERROR_CHECK(err);
//03 打开nvs，配置句柄
printf("\\n");
printf("Opening Non-Volatile Storage (NVS) handle... ");
nvs_handle my_handle;
err = nvs_open("storage", NVS_READWRITE, &my_handle);
if (err != ESP_OK) {
printf("Error (%s) opening NVS handle!\\n", esp_err_to_name(err));
}
else {
printf("Done\\n");
//04 读操作
printf("Reading restart counter from NVS ... ");
int32_t restart_counter = 0; // value will default to 0, if not set yet in NVS
err = nvs_get_i32(my_handle, "restart_counter", &restart_counter);
switch (err) {
case ESP_OK:
printf("Done\\n");
printf("Restart counter = %d\\n", restart_counter);
break;
case ESP_ERR_NVS_NOT_FOUND:
printf("The value is not initialized yet!\\n");
break;
default:
printf("Error (%s) reading!\\n", esp_err_to_name(err));
}
//05 写操作
printf("Updating restart counter in NVS ... ");
restart_counter++;
err = nvs_set_i32(my_handle, "restart_counter", restart_counter);
printf((err != ESP_OK) ? "Failed!\\n" : "Done\\n");
//06 提交修改
printf("Committing updates in NVS ... ");
err = nvs_commit(my_handle);
printf((err != ESP_OK) ? "Failed!\\n" : "Done\\n");
//07 关闭nvs
nvs_close(my_handle);
}
printf("\\n");
// Restart module
for (int i = 10; i >= 0; i--) {
printf("Restarting in %d seconds...\\n", i);
vTaskDelay(1000 / portTICK_PERIOD_MS);
}
printf("Restarting now.\\n");
fflush(stdout);
esp_restart();
}
void loop() {
}
2.2 复杂结构体操作
/*
Name: Sketch1.ino
Created: 2021/4/12 18:46:05
Author: hp
*/
// the setup function runs once when you press reset or power the board
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_system.h"
#include "nvs_flash.h"
#include "nvs.h"
#define NameSpace "store" //定义命名空间标志
#define BufferSize 20 //定义buffer大小
#define Name "nvs" //定义要被使用的nvs区域的名称
#define Key "wrt" //定义键名
typedef uint32_t DataType; //给数据类型起别名
DataType wrt[5] = { 0,1,2,3,4 }; //用于测试写入的数据
DataType buffer[20]; //用于测试读取的buffer
size_t required_sise; //用于读取数据的时候，说明数据的大小
void setup() {
//01 初始化分区表命名为nvs的区域
//如果使用nvs_flash_init 是对所有type为data，subtype为nvs的区域进行初始化操作
esp_err_t err; //定义错误标志位
err=nvs_flash_init_partition(Name);
if (err == ESP_OK)
{
printf("初始化成功\\n");
//02 打开nvs区域，并配置句柄
nvs_handle my_handle; //定义句柄
//这里也是如果使用nvs_open 就会让句柄指向所有type为data，subtype为nvs的区域
err = nvs_open_from_partition(Name, NameSpace, NVS_READWRITE, &my_handle);
if (err != ESP_OK)
{
printf("打开失败 !\\n");
}
else
{
printf("打开成功\\n");
//03 执行写入操作
nvs_set_blob(my_handle, Key, wrt, sizeof(wrt));
//04 确认写入
//写入操作在进行commit之前，都没有进行真正的执行
err = nvs_commit(my_handle);
if (err != ESP_OK)
{
printf("写入失败\\n");
}
else
{
printf("写入成功\\n");
//05 进行数据的读取
//05-1 确定数据的长度
//有的时候，我们并不知道要读取的数据要多长，因此要先确认一下长度
//对于nvs_get_blob函数，如果输入的length为0，会有0字节的数据被存储到out_value中
//不过键key对于的值value的大小，会被写到length中，这样我们就知道了value的长度
//如果我们已经提前知道了这个数据的长度，可以直接进行读取，跳过这一步
err = nvs_get_blob(my_handle, Key, NULL, &required_sise);
if (err != ESP_OK)
{
printf("数据不存在\\n");
}
else
{
//05-2 读取数据
err = nvs_get_blob(my_handle, Key,buffer, &required_sise);
if (err != ESP_OK)
{
printf("get error %s\\n", esp_err_to_name(err));
}
else
{
for (int i = 0; i < required_sise / sizeof(DataType); i++)
{
printf("%d\\n", buffer[i]);
}
}
}
}
}
}
else
{
printf("初始化失败\\n");
}
}
void loop() {
}
3. 参考资料
以上是关于ESP32-IDF04-2 存储-NVS的主要内容，如果未能解决你的问题，请参考以下文章