Skip to content

Документация idryer-protocol

Синхронизирована с кодом в src/. Основная аудитория — разработчик устройства, интегрирующий свой продукт в облако iDryer на базе этой библиотеки (свой контроллер и/или свой сетевой модуль). Потребительская прошивка «iDryer Link» — отдельный продукт; её сборка и железо не дублируются здесь.

Расхождения, незавершённые цепочки, вопросы к контракту: protocol-gaps-and-followups.md. Сверка сводной таблицы CSV с каноном: all-in-one-protocol-NOTES.md.

Старт для разработчика продукта

  1. 00-developer/01-your-product-in-idryer-cloud.md — задача, траектории, что взять из examples/.
  2. Далее по разделам через файлы 00-for-product-developers.md в каждой папке ниже — они связывают этот обзор с детальными спецификациями.

Структура по разделам

Разработчик продукта → детальная спека

Раздел Вход для разработчика Спецификация
UART 02-uart/00-for-product-developers.md 01-uart.md, 02-binary-format.md, 03-integration-guide.md
MQTT 03-mqtt/00-for-product-developers.md 01-mqtt.md
HTTP портала 04-cloud/00-for-product-developers.md 01-portal-http-claiming.md
Потоки 10-flows/00-for-product-developers.md 01-basic-flows.md, 07-profile-mode.md
Опции 09-features/00-for-product-developers.md RFID, WS, см. таблицу внутри

Источники правды в коде

  • UART: src/uart/uart_protocol.h, src/uart/uart_bridge.cpp
  • MQTT: src/mqtt/idryer_topics.h, src/mqtt/mqtt_client.cpp (подключение, LWT), src/cloud/telemetry_publisher.cpp, src/cloud/command_handler.cpp
  • Home Assistant (отдельно от топиков idryer/…): src/mqtt/ha_mqtt_client.*, src/cloud/ha_publisher.*

Расширенная документация портала

Матрица claiming, unlink, security design — репозиторий iDryer Portal (docs/development/). HTTP-контракт для прошивки свёрнут в 04-cloud/01-portal-http-claiming.md и сверен с backend.

Сводная таблица CSV

Файл all-in-one-protocol.csv — обзор «в одном месте»; построчные отличия от Markdown/кода — all-in-one-protocol-NOTES.md. Общий реестр задач и неточностей (включая код вне CSV) — protocol-gaps-and-followups.md. Перед релизом сверяйте CSV с Markdown и uart_protocol.h.