Маяки
| Реле | ID | Название | Зона | Цвета | Синхр. |
|---|---|---|---|---|---|
| Загрузка... | |||||
Реле
| Статус | IP | Пинг | Маяков | Последний ответ |
|---|---|---|---|---|
| Загрузка... | ||||
Управление маяком
Текущее состояние
Настроенные реле и маяки
Добавить реле
Добавить маяк
Пинг реле
Редактировать конфигурацию (JSON)
Прямое редактирование массива реле. Изменения применяются сразу и сохраняются в config.json.
История состояний
| Время | Поколение | Цвета |
|---|---|---|
| Выберите маяк | ||
Ошибки (Redis Stream)
Последние ошибки из потока lighthouse_fails
Prometheus-метрики
Метрики доступны по адресу /metrics в формате Prometheus.
Реле
| Метрика | Тип | Метки | Описание |
|---|---|---|---|
| relay_requests_total | counter | ip, operation, status | Количество HTTP-запросов к реле. status: ok / error |
| relay_request_duration_seconds | histogram | ip, operation | Время выполнения запроса к реле |
| relay_online | gauge | ip | Доступность реле: 1 = онлайн, 0 = офлайн |
| relay_ping_ms | gauge | ip | Пинг реле в миллисекундах |
| relays_total | gauge | -- | Количество сконфигурированных реле |
| lighthouses_total | gauge | -- | Количество сконфигурированных маяков |
API
| Метрика | Тип | Метки | Описание |
|---|---|---|---|
| api_requests_total | counter | method, path, status | Количество HTTP-запросов к API |
Примеры запросов Prometheus
rate(relay_requests_total{status="error"}[5m])
relay_online == 0
sum by (path) (rate(api_requests_total[5m]))
relay_ping_ms > 100
Настройка Prometheus
prometheus.yml:scrape_configs:
- job_name: 'lighthouse-api'
scrape_interval: 15s
static_configs:
- targets: ['localhost:8010']
Демо-программы
Запустите одну из встроенных анимаций для проверки светоколонн. Одновременно может работать только одна программа.
HTTP API
HTTP API для управления световыми колоннами. Базовый адрес:
http://<адрес>:8010.
Тело запросов и ответов — application/json (кроме /metrics).
Полная машинночитаемая спецификация — OpenAPI 3.0 (/openapi.yaml). Интерфейс не требует пароля: доступ ограничивайте сетью объекта.
Общие соглашения
- Цвета задаются именами из конфигурации маяка (
red,green, …), значение —true/false. - У маяка два состояния: желаемое (что запросил клиент) и фактическое (что реально применено к реле). Клиент задаёт желаемое состояние, фоновый процесс применяет его к реле и сохраняет фактическое. Синхронный запрос ждёт применения не дольше времени
apply_timeout(в секундах); если реле не ответило, возвращается код 504, а желаемое состояние сохраняется и будет применено позже. - Ошибки возвращаются как
{"error": "…"}с кодами 400 / 404 / 422 / 500 / 504.
Методы и адреса
Служебные
| Метод | Путь | Описание |
|---|---|---|
| GET | /_ping | Проверка доступности → {"pong":"pong"} |
| GET | /health | Статус Redis и реле |
| GET | /metrics | Метрики в формате Prometheus |
| GET | /fails | Последние 50 записей потока ошибок |
Светоколонны
| Метод | Путь | Описание |
|---|---|---|
| GET | /lighthouses | Список всех маяков с желаемым и фактическим состоянием |
| GET | /lighthouses/{id} | Подробности одного маяка |
| PUT | /lighthouses/{id}/state | Задать состояние цветов |
| DELETE | /lighthouses/{id}/state | Выключить все цвета маяка |
| GET | /lighthouses/{id}/history | Последние 100 применений (журнал Redis) |
| PUT | /lighthouses/state | Включить/выключить все маяки сразу |
| DELETE | /lighthouses/state | Выключить все маяки |
Реле
| Метод | Путь | Описание |
|---|---|---|
| GET | /relays | Список реле с состоянием и временем отклика |
| GET | /relays/{ip}/ping | Проверка отклика одного реле |
Демо
| Метод | Путь | Описание |
|---|---|---|
| GET | /demo/programs | Список доступных демо-программ |
| GET | /demo/running | Статус запущенных программ |
| POST | /demo/run | Запустить программу ({"program":"wave"}) |
| DELETE | /demo/{runID} | Остановить запущенную программу |
Конфигурация
| Метод | Путь | Описание |
|---|---|---|
| GET | /config | Текущая конфигурация реле (без паролей) |
| POST | /config | Применить конфигурацию (массив реле) |
В реальном времени
| Метод | Путь | Описание |
|---|---|---|
| WS | /ws/status | WebSocket с трансляцией статуса |
Примеры запросов
curl http://localhost:8010/lighthouses
mezz-aisle-1:curl -X PUT http://localhost:8010/lighthouses/mezz-aisle-1/state \
-H 'Content-Type: application/json' \
-d '{"colors": {"red": true, "green": false}}'
curl -X PUT http://localhost:8010/lighthouses/mezz-aisle-1/state \
-H 'Content-Type: application/json' \
-d '{"on": true}'
curl -X DELETE http://localhost:8010/lighthouses/mezz-aisle-1/state
curl -X POST http://localhost:8010/demo/run \
-H 'Content-Type: application/json' \
-d '{"program": "wave"}'
PUT /lighthouses/{id}/state:{
"desired": { "colors": {"red": true, "green": false}, "generation": 12 },
"applied": { "colors": {"red": true, "green": false}, "generation": 12 },
"synced": true
}
WebSocket /ws/status
После подключения сервер сразу присылает снимок состояния (массив объектов LighthouseInfo),
а далее — новый снимок при каждом изменении желаемого или фактического состояния. Сообщения от клиента игнорируются.
var ws = new WebSocket('ws://' + location.host + '/ws/status');
ws.onmessage = function (e) {
var lighthouses = JSON.parse(e.data); // массив LighthouseInfo
console.log(lighthouses);
};