libxr  1.0
Want to be the best embedded framework
Loading...
Searching...
No Matches
esp32_nvs_flash_database.hpp
1#pragma once
2
3#include <cstring>
4
5#include "libxr.hpp"
6#include "libxr_def.hpp"
7#include "libxr_type.hpp"
8#include "nvs.h"
9#include "nvs_flash.h"
10
11namespace LibXR
12{
13
18{
19 public:
24 explicit ESP32NvsFlashDatabase(const char* namespace_name = "storage")
25 : namespace_(namespace_name)
26 {
27 esp_err_t err = nvs_flash_init();
28 if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND)
29 {
30 nvs_flash_erase();
31 err = nvs_flash_init();
32 }
33 valid_ = (err == ESP_OK);
34 }
35
39 bool IsValid() const { return valid_; }
40
41 private:
42 const char* namespace_;
43 bool valid_{false};
44
45 ErrorCode Add(KeyBase& key) override { return Set(key, key.raw_data_); }
46
47 ErrorCode Get(KeyBase& key) override
48 {
49 if (!valid_) return ErrorCode::FAILED;
50
51 nvs_handle_t handle;
52 esp_err_t err = nvs_open(namespace_, NVS_READONLY, &handle);
53 if (err != ESP_OK) return ErrorCode::FAILED;
54
55 size_t required_size = 0;
56 err = nvs_get_blob(handle, key.name_, nullptr, &required_size);
57 if (err == ESP_ERR_NVS_NOT_FOUND)
58 {
59 nvs_close(handle);
60 return ErrorCode::NOT_FOUND;
61 }
62
63 if (required_size != key.raw_data_.size_)
64 {
65 nvs_close(handle);
66 return ErrorCode::FAILED;
67 }
68
69 err = nvs_get_blob(handle, key.name_, key.raw_data_.addr_, &required_size);
70 nvs_close(handle);
71 return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
72 }
73
74 ErrorCode Set(KeyBase& key, RawData data) override
75 {
76 if (!valid_) return ErrorCode::FAILED;
77
78 nvs_handle_t handle;
79 esp_err_t err = nvs_open(namespace_, NVS_READWRITE, &handle);
80 if (err != ESP_OK) return ErrorCode::FAILED;
81
82 err = nvs_set_blob(handle, key.name_, data.addr_, data.size_);
83 if (err != ESP_OK)
84 {
85 nvs_close(handle);
86 return ErrorCode::FAILED;
87 }
88
89 err = nvs_commit(handle);
90 nvs_close(handle);
91 return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
92 }
93};
94
95} // namespace LibXR
键的基类,存储键名及其数据 (Base class for keys, storing key name and associated data).
Definition database.hpp:28
RawData raw_data_
原始数据 (Raw data associated with the key).
Definition database.hpp:31
const char * name_
键名 (Key name).
Definition database.hpp:30
数据库接口,提供键值存储和管理功能 (Database interface providing key-value storage and management).
Definition database.hpp:21
ESP32 NVS 数据库存储实现 / ESP32 NVS-backed database implementation.
ESP32NvsFlashDatabase(const char *namespace_name="storage")
构造并初始化 NVS / Construct and initialize NVS storage
bool IsValid() const
查询初始化状态 / Check initialization state
ErrorCode Set(KeyBase &key, RawData data) override
设置数据库中的键值 (Set the key's value in the database).
ErrorCode Add(KeyBase &key) override
添加新键到数据库 (Add a new key to the database).
ErrorCode Get(KeyBase &key) override
从数据库获取键的值 (Retrieve the key's value from the database).
原始数据封装类。 A class for encapsulating raw data.
size_t size_
数据大小(字节)。 The size of the data (in bytes).
void * addr_
数据存储地址。 The storage address of the data.
LibXR 命名空间
Definition ch32_can.hpp:14