14 static const char *
const TAG =
"esp32.preferences";
18 std::vector<uint8_t> data;
21 static std::vector<NVSData> s_pending_save;
23 class ESP32PreferenceBackend :
public ESPPreferenceBackend {
27 bool save(
const uint8_t *data,
size_t len)
override {
29 for (
auto &obj : s_pending_save) {
31 obj.data.assign(data, data + len);
37 save.data.assign(data, data + len);
38 s_pending_save.emplace_back(save);
39 ESP_LOGVV(TAG,
"s_pending_save: key: %s, len: %d", key.c_str(),
len);
42 bool load(uint8_t *data,
size_t len)
override {
44 for (
auto &obj : s_pending_save) {
46 if (obj.data.size() !=
len) {
50 memcpy(data, obj.data.data(),
len);
56 esp_err_t err = nvs_get_blob(nvs_handle, key.c_str(),
nullptr, &actual_len);
58 ESP_LOGV(TAG,
"nvs_get_blob('%s'): %s - the key might not be set yet", key.c_str(), esp_err_to_name(err));
61 if (actual_len != len) {
62 ESP_LOGVV(TAG,
"NVS length does not match (%u!=%u)", actual_len, len);
65 err = nvs_get_blob(nvs_handle, key.c_str(), data, &
len);
67 ESP_LOGV(TAG,
"nvs_get_blob('%s') failed: %s", key.c_str(), esp_err_to_name(err));
70 ESP_LOGVV(TAG,
"nvs_get_blob: key: %s, len: %d", key.c_str(),
len);
76 class ESP32Preferences :
public ESPPreferences {
82 esp_err_t err = nvs_open(
"esphome", NVS_READWRITE, &nvs_handle);
86 ESP_LOGW(TAG,
"nvs_open failed: %s - erasing NVS...", esp_err_to_name(err));
91 err = nvs_open(
"esphome", NVS_READWRITE, &nvs_handle);
96 ESPPreferenceObject make_preference(
size_t length, uint32_t
type,
bool in_flash)
override {
97 return make_preference(length, type);
99 ESPPreferenceObject make_preference(
size_t length, uint32_t
type)
override {
100 auto *pref =
new ESP32PreferenceBackend();
101 pref->nvs_handle = nvs_handle;
103 uint32_t keyval =
type;
106 return ESPPreferenceObject(pref);
109 bool sync()
override {
110 if (s_pending_save.empty())
113 ESP_LOGD(TAG,
"Saving %d preferences to flash...", s_pending_save.size());
115 int cached = 0, written = 0, failed = 0;
116 esp_err_t last_err = ESP_OK;
117 std::string last_key{};
120 for (ssize_t i = s_pending_save.size() - 1; i >= 0; i--) {
121 const auto &save = s_pending_save[i];
122 ESP_LOGVV(TAG,
"Checking if NVS data %s has changed", save.key.c_str());
123 if (is_changed(nvs_handle, save)) {
124 esp_err_t err = nvs_set_blob(nvs_handle, save.key.c_str(), save.data.data(), save.data.size());
125 ESP_LOGV(TAG,
"sync: key: %s, len: %d", save.key.c_str(), save.data.size());
127 ESP_LOGV(TAG,
"nvs_set_blob('%s', len=%u) failed: %s", save.key.c_str(), save.data.size(),
128 esp_err_to_name(err));
136 ESP_LOGV(TAG,
"NVS data not changed skipping %s len=%u", save.key.c_str(), save.data.size());
139 s_pending_save.erase(s_pending_save.begin() + i);
141 ESP_LOGD(TAG,
"Saving %d preferences to flash: %d cached, %d written, %d failed", cached + written + failed, cached,
144 ESP_LOGE(TAG,
"Error saving %d preferences to flash. Last error=%s for key=%s", failed, esp_err_to_name(last_err),
149 esp_err_t err = nvs_commit(nvs_handle);
151 ESP_LOGV(TAG,
"nvs_commit() failed: %s", esp_err_to_name(err));
157 bool is_changed(
const uint32_t nvs_handle,
const NVSData &to_save) {
158 NVSData stored_data{};
160 esp_err_t err = nvs_get_blob(nvs_handle, to_save.key.c_str(),
nullptr, &actual_len);
162 ESP_LOGV(TAG,
"nvs_get_blob('%s'): %s - the key might not be set yet", to_save.key.c_str(), esp_err_to_name(err));
165 stored_data.data.resize(actual_len);
166 err = nvs_get_blob(nvs_handle, to_save.key.c_str(), stored_data.data.data(), &actual_len);
168 ESP_LOGV(TAG,
"nvs_get_blob('%s') failed: %s", to_save.key.c_str(), esp_err_to_name(err));
171 return to_save.data != stored_data.data;
174 bool reset()
override {
175 ESP_LOGD(TAG,
"Cleaning up preferences in flash...");
176 s_pending_save.clear();
187 auto *prefs =
new ESP32Preferences();
ESPPreferences * global_preferences
std::string str_sprintf(const char *fmt,...)