rtc_utils

Обёртка для более удобного использования RTC памяти на esp8266

• Чтение и запись
• Контроль crc32

Совместимость

esp8266

Содержание

• Использование
• Версии
• Установка
• Баги и обратная связь

Использование

// записать данные в rtc память. Вернёт false при ошибке
bool rtc_write(T* data, uint8_t offset = 0);

// прочитать данные из rtc памяти. Вернёт 0 при ошибке, 1 если данные прочитаны, 2 если это первый запуск (данные сброшены)
uint8_t rtc_read(T* data, uint8_t offset = 0);

// размер данных в количестве блоков (включая crc32)
size_t rtc_size(T* data);

• Максимальный offset - 127, одна единица - 4 байта памяти
• Библиотека дописывает 4 байта crc в начало области, учитываем это при расчёте смещений для других данных
• Хранить можно любые данные, у которых есть конструктор (базовые типы, классы, структуры). Если нужно хранить массив - оборачиваем его в структуру

Примеры

// счётчик перезагрузок микроконтроллера

void setup() {
    uint16_t count = 0;
    rtc_read(&count);

    Serial.println(count);

    count++;
    rtc_write(&count);
}

Версии

• v1.0

Установка

• Библиотеку можно найти по названию rtc_utils и установить через менеджер библиотек в:
  • Arduino IDE
  • Arduino IDE v2
  • PlatformIO
• Скачать библиотеку .zip архивом для ручной установки:
  • Распаковать и положить в C:\Program Files (x86)\Arduino\libraries (Windows x64)
  • Распаковать и положить в C:\Program Files\Arduino\libraries (Windows x32)
  • Распаковать и положить в Документы/Arduino/libraries/
  • (Arduino IDE) автоматическая установка из .zip: Скетч/Подключить библиотеку/Добавить .ZIP библиотеку… и указать скачанный архив
• Читай более подробную инструкцию по установке библиотек здесь

Обновление

• Рекомендую всегда обновлять библиотеку: в новых версиях исправляются ошибки и баги, а также проводится оптимизация и добавляются новые фичи
• Через менеджер библиотек IDE: найти библиотеку как при установке и нажать "Обновить"
• Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!

Баги и обратная связь

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!

При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:

• Версия библиотеки
• Какой используется МК
• Версия SDK (для ESP)
• Версия Arduino IDE
• Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
• Какой код загружался, какая работа от него ожидалась и как он работает в реальности
• В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код