mirror of
https://github.com/HASwitchPlate/openHASP.git
synced 2025-07-28 13:46:36 +00:00
Add nvs_user_begin
This commit is contained in:
fvanroie
parent
a6cf4060d6
commit
0362cdc1ce
@ -1,4 +1,4 @@
|
||||
/* MIT License - Copyright (c) 2019-2022 Francis Van Roie
|
||||
/* MIT License - Copyright (c) 2019-2023 Francis Van Roie
|
||||
For full license information read the LICENSE file in the project folder */
|
||||
|
||||
#ifndef HASP_H
|
||||
|
||||
@ -1,14 +1,31 @@
|
||||
/* MIT License - Copyright (c) 2019-2023 Francis Van Roie
|
||||
For full license information read the LICENSE file in the project folder */
|
||||
|
||||
#ifdef ESP32
|
||||
|
||||
#include "hasplib.h"
|
||||
#include "hasp_nvs.h"
|
||||
|
||||
bool nvs_user_begin(Preferences& preferences, const char* key, bool readonly)
|
||||
{
|
||||
if(preferences.begin(key, false, "config")) {
|
||||
LOG_DEBUG(TAG_NVS, "config partition opened");
|
||||
return true;
|
||||
}
|
||||
if(preferences.begin(key, false)) {
|
||||
LOG_WARNING(TAG_NVS, "config partition not found");
|
||||
return true;
|
||||
}
|
||||
LOG_ERROR(TAG_NVS, "Failed to open partition");
|
||||
return false;
|
||||
}
|
||||
|
||||
bool nvs_clear_user_config()
|
||||
{
|
||||
const char* name[8] = {"time", "ota"};
|
||||
const char* name[8] = {"time", "ota", "http", "mqtt", "wifi"};
|
||||
Preferences preferences;
|
||||
|
||||
for(int i = 0; i < 2; i++) {
|
||||
for(int i = 0; i < 5; i++) {
|
||||
preferences.begin(name[i], false);
|
||||
preferences.clear();
|
||||
preferences.end();
|
||||
@ -55,4 +72,219 @@ bool nvsUpdateUInt(Preferences& preferences, const char* key, JsonVariant value)
|
||||
return changed;
|
||||
}
|
||||
|
||||
// Show_nvs_keys.ino
|
||||
// Read all the keys from nvs partition and dump this information.
|
||||
// 04-dec-2017, Ed Smallenburg.
|
||||
//
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <esp_partition.h>
|
||||
#include <nvs.h>
|
||||
// Debug buffer size
|
||||
#define DEBUG_BUFFER_SIZE 130
|
||||
#define DEBUG true
|
||||
|
||||
struct nvs_entry
|
||||
{
|
||||
uint8_t Ns; // Namespace ID
|
||||
uint8_t Type; // Type of value
|
||||
uint8_t Span; // Number of entries used for this item
|
||||
uint8_t Rvs; // Reserved, should be 0xFF
|
||||
uint32_t CRC; // CRC
|
||||
char Key[16]; // Key in Ascii
|
||||
uint64_t Data; // Data in entry
|
||||
};
|
||||
|
||||
struct nvs_page // For nvs entries
|
||||
{ // 1 page is 4096 bytes
|
||||
uint32_t State;
|
||||
uint32_t Seqnr;
|
||||
|
||||
uint32_t Unused[5];
|
||||
uint32_t CRC;
|
||||
uint8_t Bitmap[32];
|
||||
nvs_entry Entry[126];
|
||||
};
|
||||
|
||||
// Common data
|
||||
nvs_page buf;
|
||||
|
||||
//**************************************************************************************************
|
||||
// D B G P R I N T *
|
||||
//**************************************************************************************************
|
||||
// Send a line of info to serial output. Works like vsprintf(), but checks the DEBUG flag. *
|
||||
// Print only if DEBUG flag is true. Always returns the formatted string. *
|
||||
//**************************************************************************************************
|
||||
char* dbgprint(const char* format, ...)
|
||||
{
|
||||
static char sbuf[DEBUG_BUFFER_SIZE]; // For debug lines
|
||||
va_list varArgs; // For variable number of params
|
||||
|
||||
va_start(varArgs, format); // Prepare parameters
|
||||
vsnprintf(sbuf, sizeof(sbuf), format, varArgs); // Format the message
|
||||
va_end(varArgs); // End of using parameters
|
||||
if(DEBUG) // DEBUG on?
|
||||
{
|
||||
Serial.print("D: "); // Yes, print prefix
|
||||
Serial.println(sbuf); // and the info
|
||||
}
|
||||
return sbuf; // Return stored string
|
||||
}
|
||||
|
||||
//**************************************************************************************************
|
||||
// F I N D N S I D *
|
||||
//**************************************************************************************************
|
||||
// Find the namespace ID for the namespace passed as parameter. *
|
||||
//**************************************************************************************************
|
||||
uint8_t FindNsID(const esp_partition_t* nvs, const char* ns)
|
||||
{
|
||||
esp_err_t result = ESP_OK; // Result of reading partition
|
||||
uint32_t offset = 0; // Offset in nvs partition
|
||||
uint8_t i; // Index in Entry 0..125
|
||||
uint8_t bm; // Bitmap for an entry
|
||||
uint8_t res = 0xFF; // Function result
|
||||
|
||||
while(offset < nvs->size) {
|
||||
result = esp_partition_read(nvs, offset, // Read 1 page in nvs partition
|
||||
&buf, sizeof(nvs_page));
|
||||
if(result != ESP_OK) {
|
||||
dbgprint("Error reading NVS!");
|
||||
break;
|
||||
}
|
||||
i = 0;
|
||||
while(i < 126) {
|
||||
bm = (buf.Bitmap[i / 4] >> ((i % 4) * 2)) & 0x03; // Get bitmap for this entry
|
||||
if((bm == 2) && (buf.Entry[i].Ns == 0) && (strcmp(ns, buf.Entry[i].Key) == 0)) {
|
||||
res = buf.Entry[i].Data & 0xFF; // Return the ID
|
||||
offset = nvs->size; // Stop outer loop as well
|
||||
break;
|
||||
} else {
|
||||
if(bm == 2) {
|
||||
i += buf.Entry[i].Span; // Next entry
|
||||
} else {
|
||||
i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
offset += sizeof(nvs_page); // Prepare to read next page in nvs
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
void nvs_setup()
|
||||
{
|
||||
/*
|
||||
// Example of listing all the key-value pairs of any type under specified partition and namespace
|
||||
nvs_iterator_t it = NULL;
|
||||
esp_err_t res = nvs_entry_find("data", NULL, NVS_TYPE_ANY, &it);
|
||||
while(res == ESP_OK) {
|
||||
nvs_entry_info_t info;
|
||||
nvs_entry_info(it, &info); // Can omit error check if parameters are guaranteed to be non-NULL
|
||||
printf("key '%s', type '%d' \n", info.key, info.type);
|
||||
res = nvs_entry_next(&it);
|
||||
}
|
||||
nvs_release_iterator(it);
|
||||
*/
|
||||
|
||||
nvs_iterator_t it = nvs_entry_find("config", NULL, NVS_TYPE_ANY);
|
||||
nvs_entry_info_t info;
|
||||
|
||||
while(it) {
|
||||
nvs_entry_info(it, &info);
|
||||
printf("%s::%s type=%d\n", info.namespace_name, info.key, info.type);
|
||||
it = nvs_entry_next(it);
|
||||
}
|
||||
|
||||
// Example of nvs_get_stats() to get the number of used entries and free entries:
|
||||
nvs_stats_t nvs_stats;
|
||||
nvs_get_stats(NULL, &nvs_stats);
|
||||
printf("Count: UsedEntries = (%d), FreeEntries = (%d), AllEntries = (%d)\n", nvs_stats.used_entries,
|
||||
nvs_stats.free_entries, nvs_stats.total_entries);
|
||||
|
||||
{ // TODO: remove migratrion of keys from default NVS partition to CONFIG partition
|
||||
const char* name[8] = {"time", "ota", "http", "mqtt", "wifi"};
|
||||
Preferences oldPrefs, newPrefs;
|
||||
|
||||
for(int i = 0; i < 5; i++) {
|
||||
if(oldPrefs.begin(name[i], false) && newPrefs.begin(name[i], false, "config")) {
|
||||
LOG_INFO(TAG_NVS, "opened %s", name[i]);
|
||||
String password = oldPrefs.getString(FP_CONFIG_PASS, D_PASSWORD_MASK);
|
||||
if(password != D_PASSWORD_MASK) {
|
||||
LOG_INFO(TAG_NVS, "found %s %s => %s", name[i], D_PASSWORD_MASK, password.c_str());
|
||||
size_t len = newPrefs.putString(FP_CONFIG_PASS, password);
|
||||
if(len == password.length()) {
|
||||
oldPrefs.remove(FP_CONFIG_PASS);
|
||||
LOG_INFO(TAG_NVS, "Moved %s key %s to new NVS partition", name[i], FP_CONFIG_PASS);
|
||||
}
|
||||
}
|
||||
}
|
||||
oldPrefs.end();
|
||||
newPrefs.end();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//**************************************************************************************************
|
||||
// S E T U P *
|
||||
//**************************************************************************************************
|
||||
//**************************************************************************************************
|
||||
void nvs_setup2()
|
||||
{
|
||||
esp_partition_iterator_t pi; // Iterator for find
|
||||
const esp_partition_t* nvs; // Pointer to partition struct
|
||||
esp_err_t result = ESP_OK;
|
||||
const char* partname = "nvs";
|
||||
uint8_t pagenr = 0; // Page number in NVS
|
||||
uint8_t i; // Index in Entry 0..125
|
||||
uint8_t bm; // Bitmap for an entry
|
||||
uint32_t offset = 0; // Offset in nvs partition
|
||||
uint8_t namespace_ID; // Namespace ID found
|
||||
|
||||
Serial.begin(115200); // For debug
|
||||
Serial.println();
|
||||
pi = esp_partition_find(ESP_PARTITION_TYPE_DATA, // Get partition iterator for
|
||||
ESP_PARTITION_SUBTYPE_ANY, // this partition
|
||||
partname);
|
||||
if(pi) {
|
||||
nvs = esp_partition_get(pi); // Get partition struct
|
||||
esp_partition_iterator_release(pi); // Release the iterator
|
||||
dbgprint("Partition %s found, %d bytes", partname, nvs->size);
|
||||
} else {
|
||||
dbgprint("Partition %s not found!", partname);
|
||||
return;
|
||||
}
|
||||
namespace_ID = FindNsID(nvs, "mqtt"); // Find ID of our namespace in NVS
|
||||
dbgprint("Namespace ID of ESP32Radio is %d", namespace_ID);
|
||||
while(offset < nvs->size) {
|
||||
result = esp_partition_read(nvs, offset, // Read 1 page in nvs partition
|
||||
&buf, sizeof(nvs_page));
|
||||
if(result != ESP_OK) {
|
||||
dbgprint("Error reading NVS!");
|
||||
return;
|
||||
}
|
||||
// dbgprint ( "" ) ;
|
||||
// dbgprint ( "Dump page %d", pagenr ) ;
|
||||
// dbgprint ( "State is %08X", buf.State ) ;
|
||||
// dbgprint ( "Seqnr is %08X", buf.Seqnr ) ;
|
||||
// dbgprint ( "CRC is %08X", buf.CRC ) ;
|
||||
i = 0;
|
||||
while(i < 126) {
|
||||
bm = (buf.Bitmap[i / 4] >> ((i % 4) * 2)) & 0x03; // Get bitmap for this entry
|
||||
if(bm == 2) {
|
||||
if((namespace_ID == 0xFF) || // Show all if ID = 0xFF
|
||||
(buf.Entry[i].Ns == namespace_ID)) // otherwise just my namespace
|
||||
{
|
||||
dbgprint("Key %03d: %s", i, // Print entrynr
|
||||
buf.Entry[i].Key); // Print the key
|
||||
}
|
||||
i += buf.Entry[i].Span; // Next entry
|
||||
} else {
|
||||
i++;
|
||||
}
|
||||
}
|
||||
offset += sizeof(nvs_page); // Prepare to read next page in nvs
|
||||
pagenr++;
|
||||
}
|
||||
}
|
||||
|
||||
#endif
|
||||
@ -15,6 +15,8 @@
|
||||
#include <string>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "ArduinoJson.h"
|
||||
|
||||
#include "hasp_conf.h"
|
||||
#include "hasp_mem.h"
|
||||
|
||||
@ -38,8 +40,6 @@
|
||||
#include "hasp/hasp_nvs.h"
|
||||
#endif
|
||||
|
||||
#include "ArduinoJson.h"
|
||||
|
||||
#if HASP_USE_FREETYPE > 0
|
||||
#include "lv_freetype.h"
|
||||
#endif
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
/* MIT License - Copyright (c) 2019-2022 Francis Van Roie
|
||||
/* MIT License - Copyright (c) 2019-2023 Francis Van Roie
|
||||
For full license information read the LICENSE file in the project folder */
|
||||
|
||||
#include <Arduino.h>
|
||||
@ -502,7 +502,7 @@ void wifiSetup()
|
||||
WiFi.onEvent(wifi_callback);
|
||||
|
||||
Preferences preferences;
|
||||
preferences.begin("wifi", true);
|
||||
nvs_user_begin(preferences,"wifi", true);
|
||||
String password = preferences.getString(FP_CONFIG_PASS, WIFI_PASSWORD);
|
||||
strncpy(wifiPassword, password.c_str(), sizeof(wifiPassword));
|
||||
LOG_DEBUG(TAG_WIFI, F(D_BULLET "Read %s => %s (%d bytes)"), FP_CONFIG_PASS, password.c_str(),
|
||||
@ -685,7 +685,7 @@ bool wifiGetConfig(const JsonObject& settings)
|
||||
bool wifiSetConfig(const JsonObject& settings)
|
||||
{
|
||||
Preferences preferences;
|
||||
preferences.begin("wifi", false);
|
||||
nvs_user_begin(preferences,"wifi", false);
|
||||
|
||||
configOutput(settings, TAG_WIFI);
|
||||
bool changed = false;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user