ESP32 NVS-Wert in std::string einlesen

English Deutsch

In unserem vorherigen Post haben wir Länge / Größe eines NVS-Werts auf ESP32 abrufen besprochen. Darauf basierend können wir einen NVS-Wert in einen std::string einlesen.

Strategie

  1. Größe des Werts im NVS ermitteln
  2. Temporären Buffer der ermittelten Größe allozieren
  3. Wert aus dem NVS in den temporären Buffer einlesen
  4. std::string aus dem Wert erstellen
  5. Temporären Buffer aufräumen

Hilfsfunktion zum Lesen eines NVS-Werts als std::string

Falls der Schlüssel nicht im NVS existiert, gibt diese Funktion einen leeren String ("") zurück.

read_nvs_to_stdstring.cpp
#include <nvs.h>
#include <string>

std::string ReadNVSValueAsStdString(nvs_handle_t nvs, const char* key) {
    /**
     * Strategy:
     *  1. Determine size of value in NVS
     *  2. Allocate temporary buffer of determined size
     *  3. Read value from NVS into temporary buffer
     *  4. Create std::string from value
     *  5. Cleanup
     */
    // Step 1: Get size of key
    esp_err_t err;
    size_t value_size = 0;
    if((err = nvs_get_str(nvs, _key.c_str(), nullptr, &value_size)) != ESP_OK) {
        if(err == ESP_ERR_NVS_NOT_FOUND) {
            // Not found, no error
            return "";
        } else {
            printf("Failed to get size of NVS key %s: %s\r\n", key, esp_err_to_name(err));
            return;
        }
    }
    // Step 2: Allocate temporary buffer to read from
    char* buf = (char*)malloc(value_size);
    // Step 3: Read value into temporary buffer.
    esp_err_t err;
    if((err = nvs_get_str(nvs, _key.c_str(), buf, &value_size)) != ESP_OK) {
        // "Doesn't exist" has already been handled before, so this is an actual error.
        // We assume that the value did not change between reading the size (step 1) and now.
        // In case that assumption is value, this will fail with ESP_ERR_NVS_INVALID_LENGTH.
        // This is extremely unlikely in all usage scenarios, however.
        printf("Failed to read NVS key %s: %s\r\n", key, esp_err_to_name(err));
        free(buf);
        return "";
    }
    // Step 4: Make string
    std::string value = std::string(buf, value_size);
    // Step 5: cleanup
    free(buf);

    return value;
}

Verwendungsbeispiel

Dies setzt voraus, dass Sie myNvs eingerichtet haben, wie in unserem vorherigen Post NVS auf ESP32 initialisieren gezeigt.

example_usage.cpp
std::string value = ReadNVSValueAsStdString(myNvs, "MyKey");

C++17-Optimierungen

Ab C++17 können Sie möglicherweise einen std::string direkt erstellen, anstatt den temporären Buffer zu verwenden, da es eine Überladung von .data() gibt, die einen nicht-const-Zeiger zurückgibt – sodass Sie direkt in den Buffer des std::string schreiben können.

Da meine PlatformIO-basierte Toolchain dies jedoch derzeit nicht unterstützt, habe ich diesen Code noch nicht geschrieben.


Check out similar posts by category: C/C++, ESP8266/ESP32