ESPHome 2026.4.0-dev
Loading...
Searching...
No Matches
esphome::esp32::ESP32Preferences Class Referencefinal

#include <preferences.h>

Inheritance diagram for esphome::esp32::ESP32Preferences:
esphome::PreferencesMixin< ESP32Preferences >

Public Member Functions

void open ()
 
ESPPreferenceObject make_preference (size_t length, uint32_t type, bool in_flash)
 
ESPPreferenceObject make_preference (size_t length, uint32_t type)
 
bool sync ()
 
bool reset ()
 
- Public Member Functions inherited from esphome::PreferencesMixin< ESP32Preferences >
ESPPreferenceObject make_preference (uint32_t type, bool in_flash)
 
ESPPreferenceObject make_preference (uint32_t type)
 

Data Fields

uint32_t nvs_handle
 

Protected Member Functions

bool is_changed_ (uint32_t nvs_handle, const NVSData &to_save, const char *key_str)
 

Detailed Description

Definition at line 10 of file preferences.h.

Member Function Documentation

◆ is_changed_()

bool esphome::esp32::ESP32Preferences::is_changed_ ( uint32_t nvs_handle,
const NVSData & to_save,
const char * key_str )
protected

Definition at line 153 of file preferences.cpp.

◆ make_preference() [1/2]

ESPPreferenceObject esphome::esp32::ESP32Preferences::make_preference ( size_t length,
uint32_t type )

Definition at line 93 of file preferences.cpp.

◆ make_preference() [2/2]

ESPPreferenceObject esphome::esp32::ESP32Preferences::make_preference ( size_t length,
uint32_t type,
bool in_flash )
inline

Definition at line 14 of file preferences.h.

◆ open()

void esphome::esp32::ESP32Preferences::open ( )

Definition at line 76 of file preferences.cpp.

◆ reset()

bool esphome::esp32::ESP32Preferences::reset ( )

Definition at line 174 of file preferences.cpp.

◆ sync()

bool esphome::esp32::ESP32Preferences::sync ( )

Definition at line 101 of file preferences.cpp.

Field Documentation

◆ nvs_handle

uint32_t esphome::esp32::ESP32Preferences::nvs_handle

Definition at line 21 of file preferences.h.


The documentation for this class was generated from the following files: