Сервис управления световыми колоннами

Всего маяков
--
Реле доступны
--
Реле недоступны
--

Маяки

РелеIDНазваниеЗонаЦветаСинхр.
Загрузка...

Реле

СтатусIPПингМаяковПоследний ответ
Загрузка...

Управление маяком

Текущее состояние

Выберите маяк

Настроенные реле и маяки

Загрузка...

Добавить реле

Добавить маяк

Пинг реле

Редактировать конфигурацию (JSON)

Прямое редактирование массива реле. Изменения применяются сразу и сохраняются в config.json.

История состояний

ВремяПоколениеЦвета
Выберите маяк

Ошибки (Redis Stream)

Последние ошибки из потока lighthouse_fails

Нажмите «Обновить» чтобы загрузить

Prometheus-метрики

Метрики доступны по адресу /metrics в формате Prometheus.

Реле

МетрикаТипМеткиОписание
relay_requests_totalcounterip, operation, statusКоличество HTTP-запросов к реле. status: ok / error
relay_request_duration_secondshistogramip, operationВремя выполнения запроса к реле
relay_onlinegaugeipДоступность реле: 1 = онлайн, 0 = офлайн
relay_ping_msgaugeipПинг реле в миллисекундах
relays_totalgauge--Количество сконфигурированных реле
lighthouses_totalgauge--Количество сконфигурированных маяков

API

МетрикаТипМеткиОписание
api_requests_totalcountermethod, path, statusКоличество HTTP-запросов к API

Примеры запросов Prometheus

Ошибки реле за 5 минут:
rate(relay_requests_total{status="error"}[5m])
Офлайн реле:
relay_online == 0
RPS по эндпоинтам:
sum by (path) (rate(api_requests_total[5m]))
Реле с пингом > 100ms:
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/statusWebSocket с трансляцией статуса

Примеры запросов

Список всех маяков:
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);
};

Сервис управления световыми колоннами (маяками)

Версия 3.0 Регистрация ПО Свидетельство о государственной регистрации программы для ЭВМ № 2025687159 Правообладатель ИП Краснов Владимир Андреевич (ИНН 781422796858) Документы Отказ от ответственностиЛицензионное соглашение Email support@whsoft.ru Сайт whsoft.ru