Получение параметров статуса оборудования
Метод выводит статус выбранного детектора
Пример запроса:
<url_smartroad>/api/<version>/status?login=<login>&password=<password>&sensor_id=<sensor_id>
Схема данных ответа
При поступлении корректного запроса Система формирует ответное сообщение в формате JSON
.
Первый вариант ответа приходит только в том случает, если пользователь не передал с запросом временной промежуток, второй вариант ответа - при передаче начала и конца временного промежутка.
Пример ответа:
[
{
"name": "144.A4.DT1",
"sensor_id": "3a9d31ae-4d9e-469e-99af-a2dca1a333d8",
"status": {
"sensor_id": "3a9d31ae-4d9e-469e-99af-a2dca1a333d8",
"current_status_code": 1,
"current_status_list": "ACTIVE, CONNECTED, READING"
}
}
]
{
"time_zone": "Europe/Moscow",
"message_id": "b12eb929-e270-3fe3-5900-1a0dbcdb641e",
"message_data": {
"sensors": [
{
"name": "144.A4.DT1",
"statuses": [
{
"status_code": 1,
"status_list": [
"ACTIVE",
"CONNECTED",
"READING"
],
"status_duration": "0000-00-00 03:00:00",
"status_duration_percent": 100.00
}
],
"sensor_id": "3a9d31ae-4d9e-469e-99af-a2dca1a333d8"
}
],
"range_end": "2025-03-06T16:00:00+03:00",
"range_start": "2025-03-06T13:00:00+03:00"
},
"protocol_version": "1.0"
}
Схема данных Json ответа запроса status
Параметр ответа | Тип данных ответа | Описание параметра |
---|---|---|
time_zone | строка | Часовой пояс, указанный в профиле пользователя |
message_id | строка (формат: uuid) | Уникальный идентификатор сообщения |
message_data | массив | Тело сообщения |
protocol_version | строка | Версия API |
sensors | массив | Массив данных детекторов |
range_end | строка (формат: date-time) | Конец временного интервала |
range_start | строка (формат: date-time) | Начало временного интервала |
name | строка | Название детектора |
status/statuses | массив | Список данных о статусах детектора |
sensor_id | строка (формат: uuid) | Уникальный идентификатор детектора |
current_status_code | целое число | Код статуса детектора на момент отправки запроса |
current_status_list | строка | Список статусов детектора на момент отправки запроса |
status_code | целое число | Код статуса детектора за указанный временной интервал |
status_list | массив строк | Список статусов детектора за указанный временной интервал |
status_duration | строка | Продолжительность временного периода нахождения в указанном статусе |
status_duration_percent | строка | Продолжительность временного периода нахождения в указанном статусе, в процентах |
Список кодов и статусов, получаемых с детекторов
Статус/код | Описание статуса/кода |
---|---|
0 | Детектор не работает |
1 | Детектор работает |
ACTIVE | Признак включения детектора в опрос. Задаётся при конфигурировании адаптера в файле multiadapter.json , в параметре SENSORS[].active |
BLIND | Ослепление из-за образования снежного или ледяного налёта на антенне датчика, возможно заслонение датчика посторонними предметами |
BOOTLOADER_MODE | Режим загрузчика. В этом режиме детектор не отправляет объекты и PVR. |
CONNECTED | Адаптер успешно осуществил соединение с датчиком, при этом данные ещё не начали передаваться в Систему |
CONNECTING | Адаптер предпринимает попытки соединения с датчиком |
CONNECTION_ERROR | Ошибка при соединении адаптера к датчику |
DEAD_ADAPTER | От адаптера не поступают данные о ТС за определённый интервал, по умолчанию 2 минуты |
EXTENDED_MODE | Датчик работает в расширенном режиме, адаптер получает от него данные. С точки зрения пользователя этот статус аналогичен статусу ACTIVE |
HARDWARE_ERROR | Обнаружена ошибка в аппаратной части датчика, которая может негативно повлиять на корректную работу датчика |
INTERFERENCE | Обнаружены помехи на частотном канале датчика, воздействующие на детектирование объектов (как правило помехи возникают из-за сигнала другого датчика, находящегося или установленного поблизости) |
NO DATA | Статус не связан с состоянием датчика и означает отсутствие данных в БД за выбранный период |
NO_PVR | От детектора не поступают данные о ТС за определённый интервал, по умолчанию 10 минут |
RAIN | Обнаружено наличие осадков (дождя), которые могут повлиять на эффективность обнаружения объектов |
READING | Получение данных от детектора |
TIMEOUT | Истекло время подключения адаптера к датчику. Время на подключение задаётся при конфигурировании Адаптера в файле multiadapter.json , в параметре SENSORS[].timeout , по умолчанию равно 100 мс |