Skip to content

Ваш продукт в облаке iDryer

Документ для разработчика устройства: вы подключаете idryer-protocol в свой проект (свой контроллер, свой сетевой модуль или оба) и выводите продукт в готовую инфраструктуру iDryer — портал, API, MQTT. Свой портал и свой брокер под эту задачу не пишутся: нужно соблюсти контракт ниже.

Логику сушки, датчиков, меню на MCU — вы реализуете сами. Библиотека закрывает UART, HTTP claiming, MQTT и связанные потоки на стороне ESP32 (и парсинг в UartBridge).

Что не входит в задачу

  • Реализация backend портала, своего MQTT-брокера вместо инфраструктуры iDryer.
  • Замена портала для обычных пользователей.

Локальный доступ без облака (опционально): WebSocket на модуле — 02-ws-local-access.md.

Откуда брать код и спецификацию

Артефакт Назначение
Этот каталог docs/ Норматив: UART, MQTT, HTTP, потоки — читает разработчик продукта
examples/ в корне библиотеки Старт: мост ESP32↔MCU, standalone ESP32, ориентир контроллера
README библиотеки Установка lib_deps, минимальные примеры кода

Референсная потребительская прошивка «iDryer Link» (железо, меню, platformio.ini, staging, скрипты) — отдельный репозиторий/продукт. Полезен как образец флагов IDRYER_API_BASE, пинов и сборки; не является обязательной зависимостью для интеграции через библиотеку. См. гайд репозитория Link (если вы в monorepo idryer-link) или репозиторий Link отдельно.

Траектории

1. Свой контроллер (MCU), UART к мосту

Плата с RP2040/STM32 и т.д.; по UART общаетесь с готовым или своим ESP32-модулем на этой библиотеке.

Облако для MCU — «за UART».

2. Свой сетевой модуль (ESP32 + эта библиотека)

lib_deps =
  https://github.com/pavluchenkor/idryer-protocol.git

Дальше: examples/uart_esp32_bridge/README.md, examples/esp32_standalone/README.md.

Облако и claiming: 00-for-product-developers.md, 00-for-product-developers.md, 00-for-product-developers.md.

Меняете плату и продуктовые детали, оставляя idryer-protocol как зависимость — см. репозиторий Link и его docs/guide/README.md.

Порядок чтения по темам

Тема Раздел docs
Кадры UART, CRC, виды сообщений 02-uart/
Топики, JSON, пароль MQTT 03-mqtt/
Provision, PIN, claim 04-cloud/
Сквозные потоки (config, claiming) 10-flows/
RFID, локальный WS, профиль 09-features/, 10-flows/07-profile-mode.md

Портал как источник правды (расширение)

Поведение API и матрица состояний Link в БД подробно в репозитории iDryer Portal (docs/development/DEVICE_CLAIMING_PROTOCOL.md, LINK_CLAIM_SCENARIOS.md). Документ 01-portal-http-claiming.md свёрнут под прошивку и сверен с кодом backend.

Оглавление документации библиотеки