mirror of
https://github.com/anklimov/lighthub
synced 2026-10-28 11:15:00 +00:00
andry
b90325bfef
Cross-checked all channel types, suffixes, commands, JSON config formats, HTTP/MQTT API examples and driver docs with the actual code; fixed the discrepancies (channel numbers 0..23, real command set, real suffix handling, CAN 50 kbit/s, DRY/Freeze sprinkler semantics, AC subitems, multivent zones, Mercury/Motor/Counter configs, etc.)
Документация LightHub
Мастер-индекс документации репозитория. Язык файла указан в колонке «Я» (RU/EN). Сверка с кодом выполнена на дату 2026-10-02 (v4.5.2+); эталоном служит исходный код, за ним — снапшот официальной Wiki.
core/ — протокол, конфигурация, команды
| Файл | Я | Описание |
|---|---|---|
| light_hub_полное_инженерное_описание_json_конфигурации_v2.md | RU | Полное описание JSON-конфигурации: секции, 24 типа каналов (0-23), примеры |
| channel_types_reference.md | RU | Справочник типов каналов: коды, форматы настройки, команды, доступность по целям |
| technical_channel_types_table.md | RU | Техническая таблица типов каналов (формат item.h, суффиксы, матрица) |
| suffixes_reference.md | RU | Справочник MQTT-суффиксов и команд, таблицы по типам каналов |
| mqtt_api_reference.md | RU | Полный справочник MQTT: топики, команды, HTTP API, $command/$stats, homie |
| mqtt_quick_reference.md | RU | Быстрая шпаргалка по MQTT и HTTP |
| configuration_examples.md | RU | Примеры JSON-конфигураций по всем типам каналов |
| modules_real_config.md | RU | Реальные конфигурации по драйверам |
| modules_description.md | RU | Описание драйверов (out_, in_) с параметрами getConfig() |
| cli_interface.md | RU | CLI-интерфейс (USB-сериал) |
| web_ui.md | RU | Web-интерфейс и HTTP API настройки |
| config_file_workflow.md | RU | Как контроллер загружает/сохраняет файл конфигурации |
| button_presses.md | RU | Двойные/тройные/длительные нажатия, несколько кнопок на одном входе |
| rotary_encoder.md | RU | Rotary encoder (T:32): профили, примеры |
| analog_inputs_and_map.md | RU | Аналоговые входы, преобразования map |
| command_signature.md | RU | Криптоподпись команд (SHA256, protected pins) |
| ota.md | RU | OTA-обновление прошивки по воздуху |
integrations/ — внешние системы
| Файл | Я | Описание |
|---|---|---|
| can_lightspot.md | RU | CAN-шина, lightspot, протокол datagram, шлюз |
| modbus_setup.md | RU | Настройка Modbus (v2), режим шлюза IP-Modbus |
| 1wire_sensors.md | RU | Подключение 1-wire датчиков |
| homeassistant.md | RU | Интеграция с Home Assistant |
| openhab.md | RU | Интеграция с OpenHAB |
| work_remotely.md | RU | Работа дистанционно (cloud-брокеры) |
modules/ — функциональные модули
| Файл | Я | Описание |
|---|---|---|
| multivent_module_description.md | RU | Многозональная вентиляция/кондиционирование (CH 18) |
| Sprinkler_module.md | RU | Контроллер полива (CH 23): состояния, команды, FA |
| Sprinkler_HomeAssistant.md | RU | HA-дашборд для поливального модуля |
hardware/ — железо
| Файл | Я | Описание |
|---|---|---|
| hardware_platforms.md | RU | LightHub на разных платах/чипах |
| pins_io.md | RU | Карта входов/выходов платы LightHub (rev 2.0 / 2.2) |
| mac_address.md | RU | MAC-адрес контроллера: генерация, замена |
| flashing.md | RU | Заливка прошивки, список целей |
reference/ — справочные материалы
- dokuwiki-2026-10-02/ — замороженный снапшот официальной Wiki (источник истины уровня 2)
- config_samples/ — эталонные JSON-конфигурации
- images/ — иллюстрации
Прочее
- ../CHANGELOG.md (EN) — история изменений
- ../../README.md (EN) — общий README проекта