dennn81freeside/settings

Простой конструктор вебморды для настроек esp8266/esp32

Settings [beta]

Библиотека для создания простой вебморды esp8266/esp32

• Веб-приложение весит всего 6кб и вшивается в программу в бинарном gzip виде, никакой возни с файлами
• Удобный билдер панели управления из скетча
• Десяток типовых виджетов с возможностью объединения в группы и вложенные страницы
• Интеграция с библиотекой GyverDB для полностью автоматического хранения данных
• Компактный бинарный протокол связи
• Из коробки работает на базе GyverHTTP, легко адаптируется под любую другую библиотеку HTTP сервера
• Это GyverHub на минималках

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

Совместима со всеми Arduino платформами (используются Arduino-функции)

Зависимости

• GTL v1.0.6+
• GyverDB v1.0.0+
• StringUtils v1.4.15+
• GyverHTTP v1.0.8+
• GSON v1.5.1+

platformio.ini

[env]
framework = arduino
lib_deps = 
    https://github.com/GyverLibs/GyverHTTP.git
    https://github.com/GyverLibs/GTL.git
    https://github.com/GyverLibs/StringUtils.git
    https://github.com/GyverLibs/GSON.git
    https://github.com/GyverLibs/GyverDB.git
    https://github.com/GyverLibs/Settings.git

[env:d1_mini]
platform = espressif8266
board = d1_mini
upload_speed = 921600
monitor_speed = 115200
monitor_filters = esp8266_exception_decoder, default
build_type = debug
board_build.filesystem = littlefs

[env:esp32-c3]
monitor_speed = 115200
platform = espressif32
board = esp32dev
board_build.mcu = esp32c3
upload_speed = 2000000
board_build.f_cpu = 80000000L
board_build.filesystem = littlefs

[env:esp32dev]
monitor_speed = 115200
platform = espressif32
board = esp32dev
upload_speed = 921600
board_build.filesystem = littlefs

Содержание

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

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

А ВОТ ДОКУМЕНТАЦИИ ПОКА ЧТО НЕТУ =)=)=)

Версии

• v1.0

Установка

• Библиотеку можно найти по названию Settings и установить через менеджер библиотек в:
  • 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, а лучше сразу пишите на почту [email protected]
Библиотека открыта для доработки и ваших Pull Request'ов!

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

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