Доступ по протоколу HTTP в локальной сети (состояние каналов) API

Для доступа к каналам системы из сторонних систем реализовано API на базе протокола HTTP.

Функции:

1. Состояние канала.

Запрос: GET <ip адрес>:8080/?command=1&channel=<id канала> HTTP/1.1

Ответ: HTTP/1.1 200 value=<значение канала>

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

Запрос: GET <ip адрес>:8080/?command=2&channel=<id канала>&value=<значение канала> HTTP/1.1

Ответ: HTTP/1.1 200 value=<значение канала>

3. Установка порта приема сообщений внешней системы.

Запрос: GET <ip адрес>:8080/?command=3&port=<внешний порт> HTTP/1.1

Ответ: HTTP/1.1 200 value=<внешний порт>

Данная команда предназначена для информирования контроллера на какой порт внешней системы передавать данные об изменении входящих каналов(пульты, датчики,...)

Формат сообщения:

GET <ip адрес внешней системы>:<внешний порт>/?channel=<id канала>&value=<значение канала> HTTP/1.1

Ответ: ответ не требуется.

<ip адрес внешней системы> - адрес системы выполнившей установку порта приема сообщений.

4. Отключение сигнализации отсутствия соединения с центральным контроллером.

Запрос: GET <ip адрес>:8080/?command=4&led=<1 или 0> HTTP/1.1

Ответ: HTTP/1.1 200 value=<1 или 0>

Отключение сигнализации возможно использовать, когда шлюз работает в локальном режиме без центрального контроллера 1М и управляется по локальной сети сторонней системой по протоколу HTTP.

В случае ошибки:

Ответ: HTTP/1.1 404 value=<код ошибки>

Коды ошибок:

1 - неверный код команды

2 - неверный id канала

3 - неверное или отсутствует значение канала

4 - неверное значение порта для команды 3

5 - неверное значение порта для команды 4

255 - ошибка в формате запроса

Поддержка HTTP API реализована в следующем объеме:

Включение доступа к каналу по данному протоколу осуществляется в настройках канала (Личный кабинет).

ID канала, указанное в окне, следует использовать для доступа в командах.

После включения доступа необходимо загрузить конфигурацию в систему.

Определение ip адреса контроллера.

Для определения сетевого адреса контроллера можно воспользоваться любой программой сканирования сети( пример Advanced IP Scanner).

В дальнейшем мы добавим отображение адреса в мобильном приложении.