Контроллеры
| IP | Порт | Диапазон | Тип | Статус |
|---|
Включить PTL
Массовые операции
Чтение PTL
Назначение адресов (Assign IDs)
Режим назначения Modbus-адресов PTL устройствам. Контроллер последовательно назначает адреса в указанном диапазоне.
Проверка доступности
Информация об устройстве
События (WebSocket)
История событий (Redis Stream)
Выполняемые задачи
Задачи поступают от WMS через API (POST /scenarios/tasks). Здесь отображается их прогресс.
Демо-программы
Анимации для тестирования оборудования. Запущенная программа появится в списке выполняемых задач, где её можно остановить.
Журнал задач
Топ модулей (активации)
| Контроллер:Адрес | Включений |
|---|
Кнопки
| Контроллер:Адрес:Кнопка | Нажатий |
|---|
Цвета
Нагрузка по контроллерам
Активность по часам
Активность по дням
| Дата | Команд |
|---|
Доступные метрики
| Метрика | Тип | Описание |
|---|---|---|
| ptl_controller_online | gauge | Контроллер онлайн (1) / оффлайн (0) |
| ptl_units_active | gauge | Активных PTL на контроллере |
| ptl_controllers_total | gauge | Всего контроллеров |
| ptl_button_events_total | counter | Нажатий кнопок |
| ptl_bus_queue_length | gauge | Очередь команд на шине |
| ptl_poll_cycle_duration_seconds | histogram | Время цикла опроса |
| ptl_reconcile_cycle_duration_seconds | histogram | Время цикла reconcile |
| modbus_requests_total | counter | Modbus-запросов по операциям |
| modbus_request_duration_seconds | histogram | Время Modbus-запросов |
| api_requests_total | counter | HTTP-запросов по method/path/status |
Полный вывод
Примеры запросов PromQL
| Запрос | Описание |
|---|---|
| ptl_controller_online | Статус контроллеров |
| rate(api_requests_total[5m]) | RPS по эндпоинтам |
| rate(modbus_requests_total[5m]) | Modbus RPS |
| histogram_quantile(0.95, rate(modbus_request_duration_seconds_bucket[5m])) | p95 Modbus latency |
| rate(ptl_button_events_total[5m]) | Частота нажатий кнопок |
| ptl_bus_queue_length | Длина очереди шины |
Параметры
Контроллеры
| IP | Порт | Адреса PTL | Тип |
|---|
Добавить контроллер
Webhooks
Глобальные webhooks срабатывают для событий на любом контроллере. Для настройки webhooks отдельного контроллера нажмите кнопку WH в таблице контроллеров выше.
Типы событий: button, task_confirmed, task_completed, task_timeout, task_cancelled, controller_offline, controller_online. Пустой список = все события.
Импорт / Экспорт
Конфигурация (JSON)
HTTP API
HTTP API для управления PTL-индикаторами. Базовый адрес:
http://<адрес>:8000.
Тело запросов и ответов — application/json (кроме /_ping и /metrics).
Полная машинночитаемая спецификация — OpenAPI 3.0 (/openapi.yaml). Интерфейс не требует пароля: доступ ограничивайте сетью объекта.
Общие соглашения
- Цвета задаются именами (
Red,Green,Blue,Yellow, …); «погасить» — режим без цвета либоactive: false. - У индикатора два состояния: желаемое (что запросил клиент) и фактическое (что применено к железу). Синхронный запрос ждёт применения не дольше
apply_timeoutсекунд; фактическое состояние читается через/ptls. - Число на дисплее — 0–9999, суб-позиция — 0–99.
- Ошибки возвращаются как
{"detail": "…"}с кодами 400 / 404 / 500.
Методы и адреса
Служебные
| Метод | Путь | Описание |
|---|---|---|
| GET | /_ping | Проверка доступности → текст pong |
| GET | /version | Версия продукта, вшитая при сборке |
| GET | /metrics | Метрики в формате Prometheus |
| GET | /check | Сводная диагностика сервиса и подключений |
Контроллеры
| Метод | Путь | Описание |
|---|---|---|
| GET | /alive | Сетевая доступность контроллеров (ping) |
| GET | /controllers | Список контроллеров со статусом online/offline |
| PUT | /controllers/{ip} | Обновить контроллер |
| DELETE | /controllers/{ip} | Удалить контроллер |
| GET | /controllers/{ip}/health | Здоровье контроллера |
| GET | /controllers/{ip}/units/{unit}/health | Здоровье одного unit'а |
| GET | /devices/{ip}/{unit}/info | Расширенная информация об устройстве (v2) |
| POST | /assign_ids | Запуск/остановка назначения ID модулей |
| GET | /assign_ids/status | Статус назначения ID |
| POST | /reboot | Перезагрузить устройства по IP |
PTL-индикаторы
| Метод | Путь | Описание |
|---|---|---|
| POST | /ptls | Прочитать фактическое состояние индикаторов |
| POST | /bulk/ptls | Прочитать состояние с нескольких контроллеров |
| POST | /turn_on | Включить индикаторы контроллера |
| POST | /turn_off | Выключить индикаторы контроллера |
| GET | /clear | Погасить все индикаторы контроллера (?ip=) |
| POST | /bulk/turn_on | Включить на нескольких контроллерах |
| POST | /bulk/turn_off | Выключить на нескольких контроллерах |
| POST | /bulk/clear | Погасить на нескольких контроллерах |
| POST | /apply | Применить декларативный снапшот (с sequence) |
Сценарии
| Метод | Путь | Описание |
|---|---|---|
| GET | /scenarios/tasks | Список активных задач |
| POST | /scenarios/tasks | Запустить задачу |
| GET | /scenarios/tasks/history | История задач |
| GET | /scenarios/tasks/{id} | Статус задачи |
| DELETE | /scenarios/tasks/{id} | Отменить задачу |
| GET | /scenarios/presets | Список пресетов |
| POST | /scenarios/presets | Создать пресет |
| GET | /scenarios/presets/{id} | Получить пресет |
| PUT | /scenarios/presets/{id} | Обновить пресет |
| DELETE | /scenarios/presets/{id} | Удалить пресет |
| POST | /scenarios/presets/{id}/run | Запустить пресет |
Демо
| Метод | Путь | Описание |
|---|---|---|
| GET | /scenarios/demo/programs | Список доступных демо-программ |
| POST | /scenarios/demo/run | Запустить демо-программу ({"program":"running_light"}) |
| DELETE | /scenarios/demo/{runID} | Остановить демо-программу |
| POST | /press | Симулировать нажатие кнопок (только demo) |
Конфигурация
| Метод | Путь | Описание |
|---|---|---|
| GET | /config | Текущая конфигурация сервиса |
| PUT | /config | Изменить конфигурацию (частично) и сохранить |
| POST | /config/import | Импортировать конфигурацию целиком |
| POST | /_restart | Перезапустить сервис |
События и аналитика
| Метод | Путь | Описание |
|---|---|---|
| GET | /events | Последние события (журнал Redis Stream) |
| GET | /stats | Аналитика (активации, нажатия, цвета и т.д.) |
| DELETE | /stats | Сбросить аналитику |
В реальном времени
| Метод | Путь | Описание |
|---|---|---|
| WS | /ws/events | WebSocket с трансляцией событий |
Примеры запросов
curl http://localhost:8000/controllers
curl -X POST http://localhost:8000/ptls \
-H 'Content-Type: application/json' \
-d '{"ip": "192.168.0.100", "ptl_ids": [1]}'
curl -X POST http://localhost:8000/turn_on \
-H 'Content-Type: application/json' \
-d '{"controller_ip": "192.168.0.100", "commands": [{"unit": 1, "number": 5, "sub": 1, "color": "Green"}]}'
curl "http://localhost:8000/clear?ip=192.168.0.100"
/apply):curl -X POST http://localhost:8000/apply \
-H 'Content-Type: application/json' \
-d '{"controllers": [{"controller_ip": "192.168.0.100", "sequence": 1, "units": [{"unit": 1, "active": true, "number": 5, "color": "Green"}]}]}'
POST /ptls:[
{
"unit": 1,
"controller": "192.168.0.100",
"state": "Activated",
"color": "Green",
"number": 5,
"sub": 1,
"fun_hold_counter": 0,
"btn_led_pressed": false,
"btn_fun_pressed": false,
"btn_min_pressed": false,
"btn_arrows_pressed": false
}
]
WebSocket /ws/events
После подключения сервер присылает события по мере их появления: нажатия кнопок, подтверждения и завершения задач, изменения здоровья unit'ов. Сообщения от клиента игнорируются.
var ws = new WebSocket('ws://' + location.host + '/ws/events');
ws.onmessage = function (e) {
var event = JSON.parse(e.data);
console.log(event);
};