TS-E+ базовая библиотека.
libTSE+
 Указатель Классы Функции Переменные Определения типов
Открытые члены | Полный список членов класса
Класс NVRAM

#include <nvram.h>

Открытые члены

void init ()
 
EthernetAddress getMACAddress ()
 
void setMACAddress (const EthernetAddress)
 
void clear ()
 
bool read (const char *key, char *val)
 
bool read_fmt (const char *key, const char *fmt, void *val)
 
bool isExists (const char *key)
 
bool write (const char *key, const char *val)
 
bool read_P (const char *key, char *val)
 
bool read_fmt_P (const char *key, const char *fmt, void *val)
 
bool isExists_P (const char *key)
 
bool write_P (const char *key, const char *val)
 
void forEach (bool(*iterator)(const char *key, const char *value, void *arg), void *arg)
 

Подробное описание

Работа с парами ключ=значение хранящимся в EEPROM

Методы

void NVRAM::clear ( )

Очистить все пользовательские записи

void NVRAM::forEach ( bool(*)(const char *key, const char *value, void *arg)  iterator,
void *  arg 
)

Проитерировать все значения

Аргументы
iterator- функция-итератор
arg- дополнительный аргумент
EthernetAddress NVRAM::getMACAddress ( )

Получить MAC адрес

void NVRAM::init ( )

Инициализировать систему хранения KV записей

bool NVRAM::isExists ( const char *  key)
inline

Проверить существование записи

bool NVRAM::isExists_P ( const char *  key)
inline

Проверить существование записи по ключу, хранящемуся в progmem

bool NVRAM::read ( const char *  key,
char *  val 
)
inline

Прочитать значение по ключу в буфер.

Аргументы
key- имя ключа
val- буфер. Размер должен быть не меньше NVRAM_VALUE_SIZE
Возвращает
true если запись с таким ключом существует
bool NVRAM::read_fmt ( const char *  key,
const char *  fmt,
void *  val 
)
inline

Прочитать значение по ключу в переменную

Аргументы
key- ключ
fmt- формат (см. printf)
val- адрес переменной
Возвращает
true если запись существует
bool NVRAM::read_fmt_P ( const char *  key,
const char *  fmt,
void *  val 
)
inline

Прочитать значение по ключу хранящемуся в progmem, в переменную

Аргументы
key- ключ в progmem
fmt- формат (см. printf)
val- адрес переменной
Возвращает
true если запись существует
bool NVRAM::read_P ( const char *  key,
char *  val 
)
inline

Прочитать значение по ключу хранящемуся в progmem, в буфер.

Аргументы
key- имя ключа в progmem
val- буфер. Размер должен быть не меньше NVRAM_VALUE_SIZE
Возвращает
true если запись с таким ключом существует
void NVRAM::setMACAddress ( const EthernetAddress  )

Назначить MAC адрес. Будет применен после перезагрузки модуля

bool NVRAM::write ( const char *  key,
const char *  val 
)
inline

Записать пару ключ-значение

Аргументы
key- ключ
value- значение. Размер не должен превышать NVRAM_VALUE_SIZE
bool NVRAM::write_P ( const char *  key,
const char *  val 
)
inline

Записать пару ключ-значение, ключ хранится в progmem

Аргументы
key- ключ в progmem
value- значение. Размер не должен превышать NVRAM_VALUE_SIZE

Объявления и описания членов класса находятся в файле: