Перейти к содержанию

AWDC — Документация

Документация контроллера AWDC (Automatic Wash Dosing Controller). Структурирована по четырём аудиториям.

👤 Для пользователя / оператора — user/

Оператор автомойки или конечный пользователь. Что значат сигналы HMI, как реагировать на аварии, базовое использование Web UI.

🔧 Для администратора / установщика — admin/

IT-специалист, который ставит и настраивает устройство. Setup-flow, сеть, интеграции, OTA, backup, factory-reset.

🔌 Для интегратора (REST API) — api/

Разработчик стороннего софта, интегрирующегося через REST API.

🛠 Для разработчика проекта — dev/

Контрибьютор в код AWDC. Архитектура, ADR, NVS, EEPROM, devops, дайджесты.

Quick start (cheat sheet)

  1. Подключиться к AP awdc-<MAC4>_Setup (пароль 12345678).
  2. Зайти на http://192.168.4.1/ или http://awdc-<MAC4>.local/, login admin/admin123.
  3. Сменить пароли в Системе, настроить STA WiFi → admin/network/wifi-setup.md.
  4. Настроить пропорции дозаторов (вкладка «Дозаторы» в Web UI или локально кнопками — см. dev/hmi.md).
  5. (Опционально) Подключить уведомления: MaxBot / Telegram / SMTP.

Структура исходников проекта

Папка Что
src/ Прошивка ESP32 (Arduino + ESP-IDF + FreeRTOS)
include/ Заголовки + config.h со всеми константами
web-ui/ Web SPA: Vite + TypeScript + Alpine.js + Tabler
data/ Gzipped Web-UI артефакты (генерируется при сборке)
partitions_ota.csv Раскладка Flash
platformio.ini Сборка
tools/ Build scripts (build_ui, manifest, artifacts, release.sh)
project-context/ Текущие task spec'и (internal planning, не идёт в docs site)