ESP32_NVS

ESP32 IDF非挥发存储库

ESP32 IDF非易失性存储（NVS）库旨在将键值对存储在Flash中。

目录

1。功能
2。ESP32NVS
3。基本用法
4。入门
5。示例
6。贡献
7.许可

1。功能

• ESP-IDF v5.0.2
• 支持浮动和双重类型。
• 用C语言写。
• 麻省理工学院许可证。

2。ESP32NVS

NVS以键值对运行。键是ASCII字符串，最大密钥长度当前为15个字符。值可以具有以下类型之一：

• 整数类型： uint8_t ， int8_t ， uint16_t ， int16_t ， uint32_t ， int32_t ， uint64_t ， int64_t
• 浮点类型：浮动，双
• 零终端的字符串
• 可变长度二进制数据（ BLOB ）

NVS将每个键值对分配给一个名称空间之一。名称名称遵循与关键名称相同的规则，即，最大长度为15个字符。此外，一个NVS分区中不得超过254个不同的名称空间。

3。基本用法

 #include <stdlib.h>

#include "esp_check.h"
#include "esp_log.h"

#include "non_volatile_storage.h"

static const char * TAG = "app_main" ;

void app_main ( void )
{
    ESP_ERROR_CHECK ( nvs_init ());

    // Float

    float write_float = 123456.789 ;
    if ( nvs_write_float ( "namespace_1" , "key_1" , write_float ) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully write float to NVS" );
    } else {
        ESP_LOGE ( TAG , "Failed to write float to NVS" );
    }

    float read_float ;
    if ( nvs_read_float ( "namespace_1" , "key_1" , & read_float ) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully read float from NVS: %f" , read_float );
    } else {
        ESP_LOGE ( TAG , "Failed to read float from NVS" );
    }

    // String

    char * write_string = "Hello, World!" ;
    if ( nvs_write_string ( "namespace_1" , "key_2" , write_string ) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully write string to NVS" );
    } else {
        ESP_LOGE ( TAG , "Failed to write string to NVS" );
    }

    char * read_string = NULL ;
    if ( nvs_read_string ( "namespace_1" , "key_2" , & read_string ) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully read string from NVS: %s" , read_string );
    } else {
        ESP_LOGE ( TAG , "Failed to read string from NVS" );
    }
    // IMPORTANT NOTE!: This applies ONLY to strings. Remember to delete the pointer to avoid a memory leak.
    free ( read_string );

    // Blob

    #define MAX_STRING_LENGTH 10 
    typedef struct {
        char name [ MAX_STRING_LENGTH ];
        uint32_t id ;
    } person_t ;

    const person_t write_blob = {
        . name = "Joe" ,
        . id = 123 ,
    };

    if ( nvs_write_blob ( "namespace_1" , "key_3" , & write_blob , sizeof ( person_t )) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully write blob to NVS" );
    } else {
        ESP_LOGE ( TAG , "Failed to write blob to NVS" );
    }

    person_t read_blob = {};
    if ( nvs_read_blob ( "namespace_1" , "key_3" , & read_blob , sizeof ( person_t )) == ESP_OK ) {
        ESP_LOGI ( TAG , "Successfully read blob from NVS: name:%s, id:%d" , read_blob . name , read_blob . id );
    } else {
        ESP_LOGE ( TAG , "Failed to read blob from NVS" );
    }
}

4。入门

为了开始使用ESP32任务监视器项目，您将需要ESP32微控制器和运行Python的主机计算机。您还需要安装ESP-IDF开发框架和所需的Python软件包。

4.1克隆项目存储库：

    git clone git @ github . com : VPavlusha / ESP32_NVS . git

4.2建立项目：

    cd ESP32_NVS / example
    idf . py build

4.3在您的ESP32微控制器上闪烁：

    idf . py - p PORT [ - b BAUD ] flash

用ESP32板的串行端口名称替换端口。您还可以通过用所需的波特率代替波特来更改闪光灯波特率。默认的波特率为460800。

4.4监视输出：

    idf . py - p < PORT > monitor

不要忘记用串行端口名称替换端口。

更多信息如何构建项目：ESP-IDF编程指南。

5。示例

该项目包括一个显示任务监视器库功能的示例。此示例提供了有关如何使用NVS API在您自己的应用程序中使用NVS编写/读取数据的实用证明。

6。贡献

欢迎对ESP32 NVS项目的贡献。如果您找到错误或有功能请求，请在项目的GitHub页面上提交问题。如果您想撰写代码，请提交拉动请求。

7.许可

ESP32 NVS项目已根据MIT许可获得许可。有关更多信息，请参见MIT许可证文件。