preferences.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/preference_backend.h"
 
// Include the concrete preferences manager for the active platform.
// Each header defines its manager class and provides the Preferences,
// ESPPreferences, and global_preferences declarations.
#ifdef USE_ESP32
#include "esphome/components/esp32/preferences.h"
#elif defined(USE_ESP8266)
#include "esphome/components/esp8266/preferences.h"
#elif defined(USE_RP2)
#include "esphome/components/rp2/preferences.h"
#elif defined(USE_LIBRETINY)
#include "esphome/components/libretiny/preferences.h"
#elif defined(USE_HOST)
#include "esphome/components/host/preferences.h"
#elif defined(USE_ZEPHYR) && defined(CONFIG_SETTINGS)
#include "esphome/components/zephyr/preferences.h"
#else
namespace esphome {
struct Preferences : public PreferencesMixin<Preferences> {
  using PreferencesMixin<Preferences>::make_preference;
  ESPPreferenceObject make_preference(size_t, uint32_t, bool) { return {}; }
  ESPPreferenceObject make_preference(size_t, uint32_t) { return {}; }
  bool load_from_key(uint32_t, uint8_t *, size_t) { return false; }
 
  bool sync() { return false; }
 
  bool reset() { return false; }
};
using ESPPreferences = Preferences;
extern ESPPreferences *global_preferences;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
}  // namespace esphome
#endif
 
namespace esphome {
static_assert(PreferencesContract<ESPPreferences>,
              "The platform's preferences manager is missing part of the ESPPreferences surface "
              "(esphome/core/preference_backend.h)");
}  // namespace esphome
 
#ifdef USE_PREFERENCE_KEY_LOOKUP
namespace esphome {
static_assert(PreferencesKeyLookupContract<ESPPreferences>,
              "This platform emits USE_PREFERENCE_KEY_LOOKUP but its preferences manager does not provide "
              "load_from_key() (esphome/core/preference_backend.h)");
}  // namespace esphome
#endif  // USE_PREFERENCE_KEY_LOOKUP