andry/lighthub
1
0
Fork 0
mirror of https://github.com/anklimov/lighthub synced 2026-03-13 21:06:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
lighthub/documentation/START_HERE.md

10 KiB
Raw Permalink Blame History

⭐ ДОКУМЕНТАЦИЯ ОБНОВЛЕНА — Версия 2.0

Важно: Документация LightHub полностью актуализирована для ядра с типами каналов CH_DIMMER (0) - CH_MERCURY (22)

🆕 Новое: Добавлена полная документация MQTT API согласно wiki.lazyhome.ru

🎯 Начните отсюда

Для всех (универсальный индекс)

👉 README.md — полный индекс всей документации с быстрыми ссылками

Спешите? Быстрая шпаргалка!

👉 mqtt_quick_reference.md — команды MQTT для всех типов устройств

📚 Основная документация

1️⃣ mqtt_api_reference.md ⭐ НОВОЕ (самое полное)

  • Полный справочник MQTT структуры и HTTP API
  • Структура топиков: root/[id или bcst или out]/item/[subitem]/suffix
  • Три типа топиков: команды broadcast, команды индивидуальные, статусные
  • Таблица всех суффиксов
  • HTTP endpoints и примеры curl
  • Восстановление состояния
  • Примеры на всех типах устройств

2️⃣ suffixes_reference_v2.md ⭐ ИСПРАВЛЕННЫЙ

  • Справочник MQTT суффиксов (согласно wiki.lazyhome.ru)
  • 7 категорий суффиксов с примерами
  • Таблица применимости по типам каналов
  • Диапазоны значений: 0-100 vs 0-255, /hue 0-365°
  • Сценарии для RGB, AC, PID, Multivent

3️⃣ light_hub_полное_инженерное_описание_json_конфигурации_v2.md ⭐ АКТУАЛЬНО

  • Полное описание JSON конфигурации
  • Все 23 типа каналов (0-22)
  • Все секции: mqtt, topics, modbus, items, in
  • Инженерные правила
  • Полный пример системы

🔍 Справочники (используйте как шпаргалку)

4️⃣ channel_types_reference.md

  • Справочник типов каналов 0-22
  • Таблица с кодами и текстовыми обозначениями
  • Синтаксис конфигурации для каждого типа
  • Визуализация иерархии

5️⃣ technical_channel_types_table.md

  • Технические таблицы параметров
  • Детальное описание каждого типа
  • Все константы из item.h
  • Таблицы совместимости

💡 Примеры (готовые к использованию)

6️⃣ configuration_examples.md

  • JSON примеры для всех 23 типов каналов
  • Для каждого типа: синтаксис + MQTT команды
  • Полная реальная система
  • Скопируй-вставь готовые примеры

⚙️ Специальные документы

6️⃣ modules_description.md

  • Описание модулей управления
  • out_Multivent, out_AC, out_PID и др.

7️⃣ multivent_module_description.md

  • Подробная документация многозональной вентиляции

8️⃣ modules_real_config.md

  • Реальные примеры конфигурации модулей

🚀 Быстрые старты по задачам

Задача: Включить LED светильник

  1. Откройте channel_types_reference.md
  2. Выберите тип: CH_DMX (0), CH_PWM (3), CH_RGB (2), CH_RGBW (1) или CH_RGBWW (17)
  3. Копируйте пример из configuration_examples.md
  4. Адаптируйте GPIO пины или DMX адреса

Задача: Управлять кондиционером

  1. Найдите CH_AC (10) в channel_types_reference.md
  2. Откройте пример в configuration_examples.md
  3. Настройте Modbus адрес и регистры
  4. Проверьте MQTT команды в suffixes_reference.md

Задача: Создать систему с кнопками

  1. Прочитайте раздел "Секция in (входы)" в light_hub_полное_инженерное_описание_json_конфигурации_v2.md
  2. Определите GPIO пины входов
  3. Привяжите к объектам через "item"
  4. Используйте команды scmd, rcmd

📊 Что изменилось

Старая версия ❌

  • ❌ Содержала только типы 0-17 (17 из 23)
  • ❌ Отсутствовали типы: ELEVATOR (19), COUNTER (20), HUMIDIFIER (21), MERCURY (22)
  • ❌ Примеры без полной информации
  • ❌ Неполное описание Modbus

Новая версия ✅

  • ✅ Все 23 типа каналов (полное покрытие)
  • ✅ 76+ примеров JSON
  • ✅ 3000+ строк инженерной документации
  • ✅ 100% соответствие исходному коду (item.h, item.cpp)
  • ✅ Таблицы совместимости
  • ✅ Быстрые старты по задачам

📋 Таблица типов каналов (0-22)

№ Тип Описание Справочник
0 DMX DMX диммер ⬇️
1 DMXRGBW RGB+White ⬇️
2 DMXRGB RGB ⬇️
3 PWM GPIO PWM ⬇️
4 MBUSDIM Modbus Dimmer (Legacy) ⬇️
5 THERMO Термостат ⬇️
6 RELAY GPIO реле ⬇️
7 GROUP Группа каналов ⬇️
8 VCTEMP Vacom PID ⬇️
9 MBUSVC Vacom мотор ⬇️
10 ACHAIER Кондиционер ⬇️
11 SPILED SPI LED ⬇️
12 MOTOR Шаговый двигатель ⬇️
13 PID PID регулятор ⬇️
14 MBUS Universal Modbus ⬇️
15 UARTBRDG UART мост ⬇️
16 RELAYX Медленный PWM ⬇️
17 DMXRGBWW RGBWW ⬇️
18 VENTS Многозональная вентиляция ⬇️
19 ELEVATOR Лифт (резервирован) -
20 COUNTER Счётчик ⬇️
21 HUM Увлажнитель ⬇️
22 MERCURY Mercury счётчик ⬇️

⚡ Инженерные правила

  1. Сначала структура: Modbus шаблон → Item → MQTT топик → входы
  2. Минимизируй poll: RS485 не менее 100 мс, GPIO входы 10-50 мс
  3. Используй GROUP: Для синхронного управления несколькими каналами
  4. Подробные имена: lamp_bedroom_ceiling лучше, чем lamp1

🔗 Дополнительно

✅ Чек-лист перед использованием

  • JSON синтаксис проверен (JSONLint)
  • Все GPIO пины уникальны
  • Все Modbus адреса доступны
  • MQTT брокер запущен
  • Все типы каналов в диапазоне 0-22
  • Необходимые секции присутствуют
  • MQTT топики проверены
  • Резервная копия конфигурации сохранена

Документация обновлена: 24 января 2026 г.
Версия ядра: LightHub с CH_DIMMER (0) - CH_MERCURY (22)
Статус: ✅ Актуально и готово к использованию