ESPHome 2026.9.0-dev
Loading...
Searching...
No Matches
esphome::zephyr::ZephyrPreferences Class Referencefinal

#include <preferences.h>

Inheritance diagram for esphome::zephyr::ZephyrPreferences:
esphome::PreferencesMixin< ZephyrPreferences >

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 load_from_key (uint32_t type, uint8_t *data, size_t len)
 One-shot read of a stored preference by key, without allocating or registering a backend.
 
bool sync ()
 
bool reset ()
 
- Public Member Functions inherited from esphome::PreferencesMixin< ZephyrPreferences >
ESPPreferenceObject make_preference (uint32_t type, bool in_flash)
 
ESPPreferenceObject make_preference (uint32_t type)
 

Protected Member Functions

ZephyrPreferenceBackendfind_backend_ (uint32_t type)
 

Static Protected Member Functions

static int load_setting (const char *name, size_t len, settings_read_cb read_cb, void *cb_arg)
 
static int export_settings (int(*cb)(const char *name, const void *value, size_t val_len))
 

Protected Attributes

std::vector< ZephyrPreferenceBackend * > backends_
 

Detailed Description

Definition at line 11 of file preferences.h.

Member Function Documentation

◆ export_settings()

int esphome::zephyr::ZephyrPreferences::export_settings ( int(* cb )(const char *name, const void *value, size_t val_len))
staticprotected

Definition at line 128 of file preferences.cpp.

◆ find_backend_()

ZephyrPreferenceBackend * esphome::zephyr::ZephyrPreferences::find_backend_ ( uint32_t type)
protected

Definition at line 61 of file preferences.cpp.

◆ load_from_key()

bool esphome::zephyr::ZephyrPreferences::load_from_key ( uint32_t type,
uint8_t * data,
size_t len )

One-shot read of a stored preference by key, without allocating or registering a backend.

Definition at line 82 of file preferences.cpp.

◆ load_setting()

int esphome::zephyr::ZephyrPreferences::load_setting ( const char * name,
size_t len,
settings_read_cb read_cb,
void * cb_arg )
staticprotected

Definition at line 109 of file preferences.cpp.

◆ make_preference() [1/2]

ESPPreferenceObject esphome::zephyr::ZephyrPreferences::make_preference ( size_t length,
uint32_t type )

Definition at line 70 of file preferences.cpp.

◆ make_preference() [2/2]

ESPPreferenceObject esphome::zephyr::ZephyrPreferences::make_preference ( size_t length,
uint32_t type,
bool in_flash )
inline

Definition at line 15 of file preferences.h.

◆ open()

void esphome::zephyr::ZephyrPreferences::open ( )

Definition at line 34 of file preferences.cpp.

◆ reset()

bool esphome::zephyr::ZephyrPreferences::reset ( )

Definition at line 99 of file preferences.cpp.

◆ sync()

bool esphome::zephyr::ZephyrPreferences::sync ( )

Definition at line 89 of file preferences.cpp.

Field Documentation

◆ backends_

std::vector<ZephyrPreferenceBackend *> esphome::zephyr::ZephyrPreferences::backends_
protected

Definition at line 26 of file preferences.h.


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