refactoring codebase
This commit is contained in:
66
arduino_code/Test/README.md
Normal file
66
arduino_code/Test/README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# MQTT Топики для управления двигателем
|
||||
|
||||
## Общая информация
|
||||
Система использует MQTT протокол для обмена данными между ESP32 и центральным сервером. Все топики разделены на два типа:
|
||||
- **Управление** (`motor/control/...`) - для отправки команд
|
||||
- **Обратная связь** (`motor/feedback/...`) - для получения статуса
|
||||
|
||||
## Управление
|
||||
|
||||
### 1. Команды управления
|
||||
- **`motor/control/command`**
|
||||
- Возможные значения: `start`, `stop`
|
||||
- Описание: Запуск или остановка двигателя
|
||||
|
||||
### 2. RPM (обороты в минуту)
|
||||
- **`motor/control/rpm`**
|
||||
- Тип данных: Целое число
|
||||
- Описание: Установка целевого значения оборотов в минуту
|
||||
|
||||
### 3. Шаги в секунду
|
||||
- **`motor/control/step_per_sec`**
|
||||
- Тип данных: Целое число
|
||||
- Описание: Установка целевого значения шагов в секунду
|
||||
|
||||
### 4. Состояние драйвера
|
||||
- **`motor/control/driver`**
|
||||
- Возможные значения: `turnon`, `turnoff`
|
||||
- Описание: Включение или выключение драйвера двигателя
|
||||
|
||||
### 5. Сброс общего количества шагов
|
||||
- **`motor/control/totalsteps/reset`**
|
||||
- Тип данных: Нет полезной нагрузки
|
||||
- Описание: Сброс общего счетчика шагов
|
||||
|
||||
## Обратная связь
|
||||
|
||||
### 1. RPM (обороты в минуту)
|
||||
- **`motor/feedback/rpm`**
|
||||
- Тип данных: Целое число
|
||||
- Описание: Текущее значение оборотов в минуту
|
||||
|
||||
### 2. Шаги в секунду
|
||||
- **`motor/feedback/step_per_seconds`**
|
||||
- Тип данных: Целое число
|
||||
- Описание: Текущее значение шагов в секунду
|
||||
|
||||
### 3. Общее количество шагов
|
||||
- **`motor/feedback/totalsteps`**
|
||||
- Тип данных: Целое число
|
||||
- Описание: Общее количество выполненных шагов
|
||||
|
||||
### 4. Состояние драйвера
|
||||
- **`motor/feedback/driver`**
|
||||
- Возможные значения: `on`, `off`
|
||||
- Описание: Состояние драйвера (включен/выключен)
|
||||
|
||||
### 5. Состояние работы двигателя
|
||||
- **`motor/feedback/is_run`**
|
||||
- Возможные значения: `run`, `stop`
|
||||
- Описание: Состояние двигателя (работает/стоит)
|
||||
|
||||
## Примечания
|
||||
- Все числовые значения передаются в строковом формате
|
||||
- Для управления драйвером используется логический уровень: LOW = включен, HIGH = выключен
|
||||
- Обратная связь отправляется с интервалом не менее 200 мс
|
||||
- Система автоматически обрабатывает плавный разгон/торможение при изменении скорости
|
||||
Reference in New Issue
Block a user