vgdn1942/gyverhub

Панель управления для esp8266, esp32 и других Arduino. Конструктор интерфейса. Интеграция в умный дом

GyverHub

Панель управления для esp8266, esp32 и других Arduino. Конструктор интерфейса, интеграция в умный дом

Документация находится в Wiki репозитория. English docs - translate

⚠️⚠️⚠️ Бета-версия! Проект пока что тестируется, следите за коммитами. Известные проблемы, особенности версии, обсуждение, предложения, баги - всё вот тут ⚠️⚠️⚠️

☕☕☕ Библиотека разработана благодаря народной поддержке на Boosty. Также есть другие способы поддержать автора ☕☕☕

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

Все Arduino

• НЕ РАБОТАЕТ НА ESP32 SDK 2.0.8

Установка

• Зависимости: Stamp, PubSubClient, arduinoWebSockets, ESPAsyncWebServer, ESPAsyncTCP, AsyncTCP, async-mqtt-client
• Подробнее читай в документации

О проекте

GyverHub - это платформа, включающая в себя библиотеку для микроконтроллеров и программу для управления. Программа написана на JavaScript и по сути является сайтом, который доступен:

• С официального сайта hub.gyver.ru, а также зеркала на GitHub Pages (только HTTPS)
• Android приложение: Google Play, скачать APK - особенности
• Сайт можно установить как веб-приложение (PWA) на любое устройство (Android/iOS/Windows...)
• Локально с компьютера, для этого нужно скачать сайт (правой кнопкой - сохранить ссылку как) и открыть его в браузере
• Из памяти ESP8266/32
• Из Телеграм-бота

Микроконтроллер и приложение обмениваются данными по своему протоколу (см. API) через различные интерфейсы связи:

• MQTT (через Интернет)
• WebSocket (в локальной сети)
• Serial (в разработке)
• Bluetooth (в разработке)

Основные моменты:

• Приложение может обнаруживать устройства в своей "сети"
• В программе для микроконтроллера "собирается" графический интерфейс, который отправляется в приложение
• Можно управлять микроконтроллером с полученного интерфейса в приложении или с сайта
• В случае с ESP8266/ESP32 это работает через Интернет
• Библиотека реализована таким образом, что помимо использования в паре с родным приложением можно очень просто и быстро интегрировать свою самоделку в любую систему умного дома, которая поддерживает MQTT (Алиса, Home Assistant...)
• Открытая база пользовательских проектов (вкладка Projects в приложении) - обновление при выходе новых версий. Читай как добавить свой проект в базу

Особенности:

• Библиотека невероятно проста в использовании
• Стильный дизайн ;) светлая и тёмная темы, несколько цветовых схем
• Удобный парсинг действий с приложения/сайта или сервера умного дома
• Более 20 активных компонентов интерфейса (кнопки, слайдеры, выбор...) + блоки оформления и навигации
• Доп. модули: Canvas API, загрузка и скачивание файлов, информация о плате, OTA обновление, защита паролем, интерфейс командной строки...
• 1000 FontAwesome иконок оформления для кнопок и списка устройств
• Библиотека асинхронная (опционально для ESP8266/ESP32)
• Оптимальное использование памяти для работы на слабых МК

Аналоги:

• Приложение RemoteXY
• Сервис Blynk

В отличие от них GyverHub полностью бесплатный, безопасный, не имеет ограничений и не нуждается в локальном сервере

Обновление

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

Версии

• v1.0

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

При нахождении багов создавайте Issue, а лучше сразу пишите на почту [email protected]
Библиотека открыта для доработки и ваших Pull Request'ов!

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

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