Документация
Полное руководство по настройке и использованию MQTT Dashboard Client
1. Подключение брокера
MQTT-брокер — сервер, через который устройства обмениваются сообщениями. Чтобы начать работу, добавьте хотя бы один брокер.
- Откройте вкладку Брокеры (нижнее меню)
- Нажмите кнопку + в правом верхнем углу
- Заполните обязательные поля:
- Название — произвольное название (например, «Домашний сервер»)
- URL — IP-адрес или домен брокера
- Порт — порт (1883 для TCP, 8883 для SSL)
- Протокол — выберите tcp://, ssl://, ws:// или wss://
- При необходимости включите Авторизация и укажите логин/пароль
- Настройте дополнительные параметры (ID клиента, Очистка сессии, Интервал Keep Alive, Автоподключение)
- Нажмите Готово
Совет: Включите Автоподключение, чтобы брокер подключался автоматически при запуске приложения.
2. Адреса подключения брокера
Брокер может иметь несколько адресов подключения. Это удобно, когда брокер доступен по разным адресам — например, локальный IP дома и облачный домен через интернет. Если текущий адрес недоступен, приложение автоматически переключится на следующий.
Основной адрес задаётся при создании брокера. Чтобы добавить ещё один — в редакторе брокера нажмите Добавить адрес подключения и укажите:
- Хост — IP-адрес или домен
- Протокол — tcp://, ssl://, ws:// или wss://
- Порт — порт подключения
- SSL — для ssl:///wss://: самоподписанный сертификат или файл кастомного CA-сертификата
Дополнительные настройки:
- Приоритет — Высокий / Средний / Низкий. Адреса с высоким приоритетом пробуются первыми.
- Сеть — для каких сетей подходит адрес: Любая / Только Wi-Fi / Только моб. сеть.
- Включён — отключённые адреса не используются. Переключить или удалить адрес можно из меню на экране редактирования.
Совет: Первый адрес — бесплатно, дополнительные адреса — подписка Premium.
- При подключении перебираются включённые адреса по приоритету (Высокий → Средний → Низкий)
- Если адрес недоступен — автоматический переход к следующему
- После перебора всех адресов пауза между попытками растёт (2 с → 4 с → … → 60 с)
- При смене сети (Wi-Fi ↔ мобильный интернет) перебор начинается с приоритетного адреса
- В карточке брокера виден активный адрес и ошибки по каждому адресу
- Должен быть включён хотя бы один адрес
- Адреса подключения входят в резервную копию данных
5. Обработка данных (JsonPath, Regex)
Приложение поддерживает несколько способов извлечения данных из MQTT-payload.
Извлекает значение из JSON-сообщения.
Пример:
Payload: {"temperature": 25.5, "humidity": 60}
JsonPath: $.temperature → 25.5
Поддерживаются dot-нотация ($.object.array[0].value) и bracket-нотация ($[\'store\'][\'book\'][0][\'title\']).
Извлекает данные с помощью регулярных выражений. Работает как второй этап после JsonPath.
Трёхшаговый pipeline:
- JsonPath → извлечение поля из JSON
- Regex (основной) → извлечение данных из строки
- Regex (вторичный) → постобработка результата
Пример:
Payload: {"data": "temp: 25.5C hum: 60%"}
1. JsonPath $.data → "temp: 25.5C hum: 60%"
2. Regex temp:\s*([\d.]+)C → 25.5
Regex времени — отдельное выражение для извлечения временной метки из payload.
Извлекает временную метку из отдельного JSON-поля.
- Укажите JsonPath до поля с временем
- Доступна коррекция часового пояса — слайдер от -12 до +12
- Поддерживаются различные форматы даты/времени
6. Префикс и постфикс
Позволяют добавлять текст до и после значения для форматирования.
Форматирование данных перед отправкой на брокер.
Пример: ползунок = 1
Префикс: {"command": "
Постфикс: "}
Результат: {"command": "1"}
Полезно для формирования JSON-команд.
Форматирование полученных данных перед отображением на виджете.
Пример: датчик = 42
Постфикс: °C
Результат: 42°C
Удобно для добавления единиц измерения.
7. Группы виджетов
Группы помогают организовать виджеты по смыслу — например, «Датчики», «Управление светом», «Температура».
- Откройте вкладку Группы (нижнее меню) и нажмите + в правом верхнем углу — или на главном экране нажмите + и выберите Создать группу
- Введите Название группы и нажмите Готово
- Чтобы перенести виджет в другую группу, откройте виджет на редактирование и выберите нужную Группу виджетов
На главном экране группы отображаются заголовками-разделами: нажатие на заголовок сворачивает и разворачивает группу. На вкладке Группы список можно отсортировать вручную, по названию или по количеству виджетов.
В «Настройки» → «Интерфейс» → «Группы на главном экране» можно включить вид «Чипами»: на экране остаётся одна группа, переключение — чипами вверху (включая «Все»). Вид «Списком» — прежний, все группы подряд.
8. Скрипты и автоматизация ПРЕМИУМ
Скрипты позволяют автоматизировать действия: отправлять сообщения по условию, выполнять сценарии при запуске и многое другое.
- Откройте вкладку Сценарии (нижнее меню)
- Нажмите + в правом верхнем углу и выберите Создать сценарий
- Настройте триггеры срабатывания:
- Виджет — срабатывает по значению выбранного параметра виджета: равно, не равно, больше, меньше. Топик берётся из настроек самого параметра
- Приложение запускается — выполняется при запуске приложения или при его появлении на экране
- Логический блок — объединяет несколько условий
- В Логическом блоке доступны операторы И, ИЛИ, НЕ ВЫПОЛНЕНО НИ ОДНО и НЕ ВСЕ; блоки можно вкладывать друг в друга
- Настройте действия:
- Виджет — Отправить сообщение через параметр виджета или Мигать виджетом выбранным цветом
- Push-уведомление — показать уведомление с вашим текстом
- Воспроизводить звук ПРЕМИУМ — системный или собственный звуковой файл
- Включите скрипт — переключатель в карточке скрипта. Выключенные скрипты не выполняются, но доступны для редактирования
Пример: «Если температура > 30°C И влажность < 20% → отправить команду на включение увлажнителя и показать уведомление»
Выключенный скрипт можно открыть и отредактировать — изменения сохранятся и вступят в силу после включения.
У условия по значению параметра есть два дополнительных поля:
- Держится не менее — сценарий сработает, только если условие выполняется столько времени подряд (до 24 ч). Пусто или 0 — срабатывает сразу
- Сброс при — порог, после которого условие может сработать повторно: для «больше» повторно сработает, когда значение опустится ниже порога, для «меньше» — поднимется выше. Пусто — повторно сработает, как только условие перестанет выполняться
Настройки видны в карточке условия: «держится…», «сброс при…».
Оба поля — Premium. Без подписки условие срабатывает сразу и повторно — как только перестанет выполняться; если подписка закончится во время отсчёта задержки, сценарий сработает сразу.
9. Сцены
Сцена — это переключатель, который одним нажатием отправляет сразу несколько сообщений на разные устройства. У сцены два состояния — Включено и Выключено, и для каждого задаётся свой список сообщений. Запуск ручной: по условию сцены не срабатывают — для этого используйте скрипты.
- Откройте вкладку Сценарии (нижнее меню)
- Нажмите + в правом верхнем углу и выберите Создать сцену
- Укажите Название сцены и Группу виджетов, к которой она относится
- Для состояния «Включено» выберите иконку и цвет, затем в блоке Сообщения для «Включено» добавьте действия
- То же самое настройте для состояния «Выключено»
- Нажмите Готово
Список сообщений для состояния «Включено» обязателен — без него сцену сохранить нельзя. Список для «Выключено» можно оставить пустым.
Сцена работает не с «сырыми» топиками, а с уже настроенными виджетами: топик, QoS, префикс и постфикс берутся из параметра виджета. Поэтому перед созданием сцены нужен хотя бы один виджет.
- Нажмите + в нужном списке сообщений
- Выберите Группу виджетов
- Выберите Виджет
- Выберите Параметр виджета
- Укажите Отправить значение — для переключателей, выпадающих списков, кнопок и регуляторов подставляются подсказки из настроек параметра
- Нажмите Готово
Готовая сцена появляется на вкладке Сценарии в виде переключателя. Включение отправляет все сообщения из списка «Включено», выключение — из списка «Выключено». Иконка и цвет меняются в зависимости от состояния.
Пример: Сцена «Уход из дома»: в списке «Выключено» — команды на отключение света, закрытие жалюзи и выключение кондиционера; в списке «Включено» — обратные команды на возвращение домой.
10. SSL/TLS сертификаты ПРЕМИУМ
Подключайтесь к брокерам с шифрованием и собственными сертификатами.
- При создании брокера выберите протокол ssl:// или wss://
- Включите Самоподписанный сертификат
- Приложение будет доверять любому сертификату этого брокера
Подходит для локальных серверов (Raspberry Pi, домашний сервер).
- Выберите протокол ssl:// или wss://
- Опция Self-Signed должна быть выключена
- Нажмите Выберите файл сертификата
- Выберите файл .pem через файловый менеджер
Для корпоративных и облачных MQTT-брокеров.
11. Резервное копирование
Сохраняйте и восстанавливайте полную конфигурацию приложения — все настройки, виджеты, брокеры, скрипты и сцены.
- Настройки → Резервное копирование конфигурации
- При желании включите сохранение логов данных (история значений датчиков)
- Нажмите Создать и выберите место сохранения
Виджеты
- Тип, иконка, цвет, стиль оформления
- Список состояний переключателей и выпадающих списков (подпись, MQTT-значение, иконка, цвет)
- Надпись и отображаемые данные
- Позиция на главном экране (отдельно для портретной и ландшафтной ориентации)
- Топики подписки, JsonPath, Regex, префикс/суффикс
- Настройки отправки данных (топик, QoS, формат)
Брокеры
- Адрес и порт подключения
- Логин и пароль
- Настройки SSL/TLS и сертификаты
- Дополнительные адреса подключения с приоритетом и требованием к сети
Группы виджетов
- Название, порядок групп и состояние «свёрнута/развёрнута»
Скрипты и автоматизация
- Все скрипты с названиями и состоянием (вкл/выкл)
- Триггеры — по значению параметра виджета и при запуске приложения
- Логические блоки (И / ИЛИ / НЕ ВЫПОЛНЕНО НИ ОДНО / НЕ ВСЕ)
- Действия — отправка сообщения, push-уведомление, звук, мигание виджетом
Сцены
- Сцены с иконками и цветами для состояний «Включено» и «Выключено»
- Списки сообщений обоих состояний (параметр виджета + отправляемое значение)
Настройки приложения
- Все общие настройки, избранные цвета, порядок виджетов
- Отложенные (pending) сообщения
- История данных датчиков (опционально)
- Настройки → Восстановление конфигурации
- Выберите файл резервной копии
- После восстановления приложение перезапустится. ID клиента изменятся, чтобы избежать конфликтов подключения
Восстановление заменяет все текущие данные приложения. Рекомендуется перед восстановлением создать свежую резервную копию.
12. Обмен конфигурациями по MQTT ПРЕМИУМ
Переносите настройки приложения между устройствами через MQTT-брокер: виджеты, группы, сцены и скрипты. Не нужно настраивать каждое устройство вручную.
- Настройки → Обмен конфигурациями по MQTT → Экспорт конфигурации
- При желании укажите Название конфигурации
- Выберите, что включить: Сцены, Скрипты, Учётные данные брокеров (последнее — только с паролем шифрования)
- При желании задайте Пароль шифрования и Срок хранения конфигураций (1, 3, 7, 14 или 30 дней; по умолчанию 7)
- Выберите брокера и нажмите Опубликовать
Конфигурация публикуется в топик {префикс}/{id} и хранится на брокере. Без пароля данные только сжимаются (не шифруются), пароли брокеров не включаются.
Отзыв: у конфигурации, которую опубликовали вы сами, кнопка Скрыть становится Отозвать — она стирает конфигурацию на брокере, и другие устройства её больше не увидят.
- Настройки → Обмен конфигурациями по MQTT
- Включите Получать конфигурации — приложение подпишется на {префикс}/+ (по умолчанию config/share/+)
- Полученные конфигурации появляются карточками: Подробнее (что изменится), Применить, Отклонить
Режимы импорта:
- Объединить — обновить существующие элементы и добавить новые
- Заменить всё — удалить текущие виджеты, группы, сцены и скрипты и импортировать новые. Требует повторного подтверждения с чекбоксом.
Если конфигурация защищена паролем, при импорте будет запрошен пароль. Брокеры с авторизацией попросят логин и пароль. После успешной расшифровки пароль можно сохранить, чтобы он применялся автоматически к будущим конфигурациям.
Префикс топика по умолчанию — config/share. Его можно изменить — например, чтобы разделить конфигурации между группами устройств.
13. Настройки интерфейса
Настройки → Интерфейс: оформление приложения и всё, что относится к главному экрану.
- Тема — Системная, Светлая или Тёмная. По умолчанию приложение следует за темой устройства.
- Язык — язык интерфейса приложения. Значение Системный берёт язык устройства.
Настройки → Интерфейс → Главный экран → Блокировка главного экрана. По умолчанию выключена.
Когда блокировка включена, долгое нажатие по виджету не делает ничего: не открывается контекстное меню, нет вибрации, не начинается перетаскивание. Раскладку нельзя случайно сломать — это полезно на общем или настенном планшете.
- Короткие нажатия работают как обычно: переключатели, кнопки, регуляторы и выпадающие списки продолжают управлять устройствами
- Блокировка действует и внутри группы виджетов
- Редактирование, клонирование и удаление остаются доступны обычным путём: нажатие на виджет → экран виджета → нужное действие
Блокировка не защищена паролем и снимается тем же переключателем — это защита от случайного жеста, а не родительский контроль.
Настройки → Интерфейс → Главный экран. Семь размеров, каждый настраивается отдельно:
- Размер виджета — размер плитки на главном экране
- Значение (Текст) — шрифт значения параметра
- Название виджета — шрифт подписи виджета
- Время последнего сообщения — шрифт отметки времени
- Иконка параметра — размер иконки
- Значение — только для типов Логический и Цвет
- Кнопка — только для типа Кнопка
Каждый пункт открывает экран с бегунком и предпросмотром главного экрана: изменения сразу видно на своих же виджетах. Значение Авто означает, что размер подбирает приложение; заданное вручную значение показывается в dp рядом с названием настройки.
Предпросмотр на этих экранах не реагирует на долгое нажатие и не показывает панель переподключения брокеров — он нужен только для оценки размеров.
14. Дома ПРЕМИУМ
Квартира, дача и офис живут отдельно: у каждого дома свои группы, виджеты, сцены и сценарии, а брокеры общие для всех домов.
- «Настройки» → карточка Текущий дом → откроется экран Дома
- Нажмите Новый дом и введите название
- При желании включите Добавить стандартные комнаты — сразу создадутся гостиная, кухня, спальня и другие группы
- Нажмите на дом в списке — он станет текущим, и главный экран перестроится
- Переименовать и Изменить порядок — из меню дома в списке
- Удаление удаляет группы, виджеты, сцены и сценарии этого дома; виджеты рабочего стола с ними перестанут работать. Брокеры останутся — они общие
- Сценарии и уведомления работают во всех домах, а не только в открытом
- Дома участвуют в обмене конфигурациями
Один дом — бесплатно, дополнительные дома — с Premium.
15. Телефон как устройство ПРЕМИУМ
Приложение публикует на ваш брокер данные самого телефона как отдельного устройства: заряд, сеть, экран — как у любого другого датчика. Их увидят другие устройства с приложением и ваши автоматизации.
- «Настройки» → Телефон как устройство
- Включите Публиковать данные телефона
- В Куда отправлять выберите брокер — данные уходят только на него
- При желании задайте Имя устройства — по умолчанию используется имя модели
- Включите нужные Датчики: батарея (уровень, зарядка, тип зарядки, температура), экран, энергосбережение, звук (режим звонка и «Не беспокоить»), сеть, память, будильник, версия приложения
- Для Местоположения выберите, как часто отправлять точку, и выдайте доступ к геолокации «в любом режиме» — иначе в фоне точки не отправляются
- Включите Объявлять устройство, чтобы телефон сам появлялся в поиске устройств приложения
Топик, в который уходят данные, показан на экране — его можно скопировать для автоматизаций.
- С включенной работой в фоне — сразу при каждом изменении. Работа в фоне не даёт телефону уснуть, расход батареи заметный
- Без неё — примерно раз в 15 минут, а во сне телефона реже
- Точки местоположения отправляются с выбранной частотой; с работой в фоне точка уходит и раньше, если телефон сдвинулся больше чем на 50 м
- При выключении публикации приложение очищает свои сообщения на брокере
По умолчанию ничего не отправляется: каждый датчик включается отдельно. Батарея — бесплатно, остальные датчики и местоположение — Premium. Если брокер удалён, приложение спросит, куда теперь публиковать данные, или отключит публикацию.
16. Выгрузка истории ПРЕМИУМ
История значений и сообщений сохраняется в файл CSV или JSON — для разбора в таблицах и своих скриптов.
- Откройте Выгрузить историю: в меню терминала на экране виджета или параметра либо в меню самого экрана виджета
- Выберите, что выгружается:
- Сообщения под фильтром терминала — брокер, топики и поиск берутся из самого терминала
- Параметры виджета — отметьте один или несколько параметров
- Задайте период — от 5 минут до 30 дней или за всё время
- Выберите формат: CSV (разделитель — запятая) или JSON
- Нажмите Выгрузить
Выгрузка идёт в фоне: плашка показывает прогресс, её можно свернуть («Свернуть»), остановить («Остановить») или по завершении сразу открыть файл («Открыть»).
Выгрузка — Premium (кнопка «Выгрузить с Premium»). Если остановить выгрузку или она прервётся, недописанный файл удаляется. Значения записываются строками, как их прислало устройство.
17. Графики
Числовые параметры и регуляторы показывают историю значений графиком на экране виджета и на экране параметра. Селектор интервала общий, у каждого графика своя шкала времени — от первой точки до текущего момента.
- Щипок по графику приближает его — вплоть до 1/60 выбранного интервала
- Приближённый график прокручивается по времени
- Смена интервала сбрасывает масштаб
- Работает и на объединённом графике нескольких величин
В редакторе параметра числа или регулятора настройки графика задают вид (линия, свечи, область), цвета и толщину линии; их можно сохранить настройками по умолчанию или применить ко всем графикам. Свеча показывает первое, последнее, наименьшее и наибольшее значение за 1/60 периода.