ESP32_学习笔记（一）NVS的操作
- 前言
- 函数介绍
- - 创建句柄：
  - 定义存储空间：
  - 打开函数：
  - 存储函数：
  - 读取函数：
  - 提交函数：
  - 关闭函数：
- 易错点提醒：为什么明明存入了，读取的值为0
- - 这就是我们很多时候读取到的值为零的原因：
  - 解决方法：
- 具体代码实操
- - 这是一个完整的代码，将其复制到主文件之中就可以运行
- 参考文献：

ESP32_学习笔记（一）NVS的操作

前言

ESP32在RTOS3.0的环境下，拥有很多已经开发好的功能和组件供我们使用。NVS就是其中的一个。这么奇怪的名字其实就是我们原来的读写函数的抽象化，将原来的直接在地址上读写改为现在的通过系统来管理底层的存储，我们只需要像文件一样的写入和读出就行了，

函数介绍

创建句柄：

首先创建句柄用来操作。

nvs_handle_t nvs_handle;

定义存储空间：

存储空间是一个名字，用字符串表示：

#define STORAGE_NAMESPACE "storage"

打开函数：

esp_err_t nvs_open(const char* name, nvs_open_mode_t open_mode, nvs_handle_t *out_handle);
我们要实现NVS的存储，我们首先就需要打开一个存储空间。以上这个函数就是用来打开的函数。

存储函数：

下面的都是用来存储数据的函数：

esp_err_t nvs_set_i8  (nvs_handle_t handle, const char* key, int8_t value);
esp_err_t nvs_set_u8  (nvs_handle_t handle, const char* key, uint8_t value);
esp_err_t nvs_set_i16 (nvs_handle_t handle, const char* key, int16_t value);
esp_err_t nvs_set_u16 (nvs_handle_t handle, const char* key, uint16_t value);
esp_err_t nvs_set_i32 (nvs_handle_t handle, const char* key, int32_t value);
esp_err_t nvs_set_u32 (nvs_handle_t handle, const char* key, uint32_t value);
esp_err_t nvs_set_i64 (nvs_handle_t handle, const char* key, int64_t value);
esp_err_t nvs_set_u64 (nvs_handle_t handle, const char* key, uint64_t value);
esp_err_t nvs_set_str (nvs_handle_t handle, const char* key, const char* value);
//用来存储大二进制数据的函数（比如说结构体）
esp_err_t nvs_set_blob(nvs_handle_t handle, const char* key, const void* value, size_t length);

读取函数：

esp_err_t nvs_get_i8  (nvs_handle_t handle, const char* key, int8_t* out_value);
esp_err_t nvs_get_u8  (nvs_handle_t handle, const char* key, uint8_t* out_value);
esp_err_t nvs_get_i16 (nvs_handle_t handle, const char* key, int16_t* out_value);
esp_err_t nvs_get_u16 (nvs_handle_t handle, const char* key, uint16_t* out_value);
esp_err_t nvs_get_i32 (nvs_handle_t handle, const char* key, int32_t* out_value);
esp_err_t nvs_get_u32 (nvs_handle_t handle, const char* key, uint32_t* out_value);
esp_err_t nvs_get_i64 (nvs_handle_t handle, const char* key, int64_t* out_value);
esp_err_t nvs_get_u64 (nvs_handle_t handle, const char* key, uint64_t* out_value);
//这两个的长度需要特殊操作
esp_err_t nvs_get_str (nvs_handle_t handle, const char* key, char* out_value, size_t* length);
esp_err_t nvs_get_blob(nvs_handle_t handle, const char* key, void* out_value, size_t* length);

提交函数：

这个函数用于我们每次写入NVS之后提交更改的。每次存入之后必须提交

esp_err_t nvs_commit(nvs_handle_t handle);

关闭函数：

void nvs_close(nvs_handle_t handle);

易错点提醒：为什么明明存入了，读取的值为0

我们要注意，传入的长度参数。
注意这几个函数：

esp_err_t nvs_get_str (nvs_handle_t handle, const char* key, char* out_value, size_t* length);
esp_err_t nvs_get_blob(nvs_handle_t handle, const char* key, void* out_value, size_t* length);
esp_err_t nvs_set_str (nvs_handle_t handle, const char* key, const char* value);
esp_err_t nvs_set_blob(nvs_handle_t handle, const char* key, const void* value, size_t length);

这几个函数都是对不定长的数据进行存储和读取，可以看到我们需要传入一个长度和一个key。那么在这个过程中我们并不知道要读取的数据长度究竟是多少，所以我们需要传入一个长度的指针进去。
我们可以看他的源码是怎么要求这一个数据的：

 /* @param[inout]  length     A non-zero pointer to the variable holding the length of out_value.*                           In case out_value a zero, will be set to the length*                           required to hold the value. In case out_value is not*                           zero, will be set to the actual length of the value*                           written. For nvs_get_str this includes zero terminator.*                         length指向变量out_value的长度的非零指针。如果out_value为零，则将其设置为保存该值所需的长度。如果out_value不为零，则将其设置为写入值的实际长度。 对于nvs_get_str，它包括零终止符。*/

这就是我们很多时候读取到的值为零的原因：

如果我们传入的值就是零的话，那么我们读取到的数据长度就是0：
官方文档解释：这里我们可以看到，如果读的到数据的话，这个长度指针的值会被设置为你传入的值，但是如果读不到数据既数据为零的情况了?

    // Read the size of memory space required for blobsize_t required_size = 0;  // value will default to 0, if not set yet in NVSerr = nvs_get_blob(my_handle, "run_time", NULL, &required_size);if (err != ESP_OK && err != ESP_ERR_NVS_NOT_FOUND) return err;// Read previously saved blob if availableuint32_t* run_time = malloc(required_size + sizeof(uint32_t));if (required_size > 0) {err = nvs_get_blob(my_handle, "run_time", run_time, &required_size);if (err != ESP_OK) {free(run_time);return err;}}

解决方法：

这里，我拿出官方的例程操作，我们可以看到，他开始为了读取所取得键得大小，传入空，获取到一个长度数据，然后再将这个长度数据来传入，从而获取所需要的值。
所以在这里我推荐，如果不知道这个实际的大小，大家都先采例程的方法，先读取长度，然后读取数据

具体代码实操

下面是一个用来存储和读取结构体的例子

//定义
//注意，我们可以定义多个存储空间来存储对应的值
#define STORAGE_NAMESPACE "storage"//结构体
struct Temp_st
{uint32_t temp_a;uint8_t * temp_str;char      temp_b;
}

//读取函数
/*
*读取函数
*para1:要读取的结构体指针。
*para2:长度*/
esp_err_t nvs_read_wifi(struct Temp_st *Temp_st, uint32_t *len)
{nvs_handle_t nvs_handle;esp_err_t err;//首先一部操作打开存储空间// Open//para(空间名字（字符串），操作类型（只读还是读写），操作句柄)err = nvs_open(STORAGE_NAMESPACE, NVS_READONLY, &nvs_handle);if (err != ESP_OK){printf("NVS_READ：存储空间打开失败\n");return err;}//注意这一步十分重要，因为在NVS存储已知长度类型的数据时，我们可以明确的传入已知的长度。
//但是这个地方对于我们传入的数组或者说结构体，我们不知道明确长度，于是我们采用下面的操作来获取要读取的数据的长度。// Read the size of memory space required for blobsize_t required_size = 0;  // value will default to 0, if not set yet in NVSerr = nvs_get_blob(nvs_handle, "Temp_st", NULL, &required_size);if (err != ESP_OK && err != ESP_ERR_NVS_NOT_FOUND) return err;//再来读取对应的值err = nvs_get_blob(nvs_handle, "Temp_st", Temp_st, &required_size);if (err ==ESP_ERR_NVS_NOT_FOUND ){printfln("NVS_READ：key doesn’t exist");return err;}else if (err ==ESP_ERR_NVS_INVALID_HANDLE  ){printfln("NVS_READ：handle has been closed or is NULL");return err;}else if (err ==ESP_ERR_NVS_INVALID_NAME  ){printfln("NVS_READ：name doesn’t satisfy constraints ");return err;}else if (err ==ESP_ERR_NVS_INVALID_LENGTH  ){printfln("NVS_READ：length is not sufficient to store data");return err;}else{printfln("NVS_READ：读取成功");}//关闭句柄nvs_close(nvs_handle);return ESP_OK;
}

存储函数


/*
*存储函数
*para1:要读取的结构体指针。
*para2:长度*/
esp_err_t nvs_write_wifi(struct Temp_st *Temp_st, uint32_t len)
{nvs_handle_t nvs_handle;esp_err_t err;printfln("NVS_WRITE：存储wifi信息\n");// Openerr = nvs_open(STORAGE_NAMESPACE, NVS_READWRITE, &nvs_handle);if (err != ESP_OK){printf("NVS_WRITE：存储空间打开失败\n");return err;}err = nvs_set_blob(nvs_handle, "Temp_st", Temp_st, len);if (err != ESP_OK){printf("NVS_WRITE：存储空间存储失败\n");return err;}err = nvs_commit(nvs_handle);if (err != ESP_OK){printf("NVS_WRITE：存储空间提交失败\n");return err;}err = nvs_close(nvs_handle);if (err != ESP_OK){printf("NVS_WRITE：存储空间关闭失败\n");return err;}return ESP_OK;
}

这是一个完整的代码，将其复制到主文件之中就可以运行

源代码

参考文献：