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 "esp_def.hpp"
4
5#include <cstring>
6
7#include "libxr.hpp"
8#include "libxr_def.hpp"
9#include "libxr_type.hpp"
10#include "nvs.h"
11#include "nvs_flash.h"
12
13namespace LibXR
14{
15
20{
21 public:
26 explicit ESP32NvsFlashDatabase(const char* namespace_name = "storage")
27 : namespace_(namespace_name)
28 {
29 esp_err_t err = nvs_flash_init();
30 if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND)
31 {
32 nvs_flash_erase();
33 err = nvs_flash_init();
34 }
35 valid_ = (err == ESP_OK);
36 }
37
41 bool IsValid() const { return valid_; }
42
43 private:
44 const char* namespace_;
45 bool valid_{false};
46
47 ErrorCode Add(KeyBase& key) override { return Set(key, key.raw_data_); }
48
49 ErrorCode Get(KeyBase& key) override
50 {
51 if (!valid_) return ErrorCode::FAILED;
52
53 nvs_handle_t handle;
54 esp_err_t err = nvs_open(namespace_, NVS_READONLY, &handle);
55 if (err != ESP_OK) return ErrorCode::FAILED;
56
57 size_t required_size = 0;
58 err = nvs_get_blob(handle, key.name_, nullptr, &required_size);
59 if (err == ESP_ERR_NVS_NOT_FOUND)
60 {
61 nvs_close(handle);
63 }
64
65 if (required_size != key.raw_data_.size_)
66 {
67 nvs_close(handle);
68 return ErrorCode::FAILED;
69 }
70
71 err = nvs_get_blob(handle, key.name_, key.raw_data_.addr_, &required_size);
72 nvs_close(handle);
73 return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
74 }
75
76 ErrorCode Set(KeyBase& key, RawData data) override
77 {
78 if (!valid_) return ErrorCode::FAILED;
79
80 nvs_handle_t handle;
81 esp_err_t err = nvs_open(namespace_, NVS_READWRITE, &handle);
82 if (err != ESP_OK) return ErrorCode::FAILED;
83
84 err = nvs_set_blob(handle, key.name_, data.addr_, data.size_);
85 if (err != ESP_OK)
86 {
87 nvs_close(handle);
88 return ErrorCode::FAILED;
89 }
90
91 err = nvs_commit(handle);
92 nvs_close(handle);
93 return (err == ESP_OK) ? ErrorCode::OK : ErrorCode::FAILED;
94 }
95};
96
97} // namespace LibXR
键的基类,存储键名及其数据 (Base class for keys, storing key name and associated data).
Definition database.hpp:29
RawData raw_data_
原始数据 (Raw data associated with the key).
Definition database.hpp:32
const char * name_
键名 (Key name).
Definition database.hpp:31
数据库接口,提供键值存储和管理功能 (Database interface providing key-value storage and management).
Definition database.hpp:22
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
ErrorCode
定义错误码枚举
Definition libxr_def.hpp:64
@ NOT_FOUND
未找到 | Not found
@ FAILED
操作失败 | Operation failed
@ OK
操作成功 | Operation successful