API - Список соединений — различия между версиями
(не показаны 3 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
+ | <languages/> | ||
+ | <translate> | ||
+ | <!--T:1--> | ||
Для получения списка всех соединений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/connections'''. | Для получения списка всех соединений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/connections'''. | ||
+ | <!--T:2--> | ||
Для получения информации о конкретном соединений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/connections/1'''. Здесь 1 - это ID нужного соединения. | Для получения информации о конкретном соединений необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/connections/1'''. Здесь 1 - это ID нужного соединения. | ||
+ | <!--T:3--> | ||
В заголовках запроса ноебходимо передать API key. Например: | В заголовках запроса ноебходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 8: | Строка 13: | ||
</pre> | </pre> | ||
+ | <!--T:4--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Строка 16: | Строка 22: | ||
+ | <!--T:5--> | ||
Пример запроса списка соединений: | Пример запроса списка соединений: | ||
+ | <!--T:6--> | ||
'''URL''': http://192.168.1.1/api/connections<br> | '''URL''': http://192.168.1.1/api/connections<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 29: | Строка 38: | ||
</pre> | </pre> | ||
+ | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 69: | Строка 79: | ||
+ | <!--T:9--> | ||
Пример запроса информации об соединений номер 2: | Пример запроса информации об соединений номер 2: | ||
+ | <!--T:10--> | ||
'''URL''': http://192.168.1.1/api/connections/2<br> | '''URL''': http://192.168.1.1/api/connections/2<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 82: | Строка 95: | ||
</pre> | </pre> | ||
+ | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 104: | Строка 118: | ||
+ | <!--T:13--> | ||
Атрибуты соединения: | Атрибуты соединения: | ||
+ | <!--T:14--> | ||
<table> | <table> | ||
<tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор соединения</td></tr> | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор соединения</td></tr> | ||
Строка 123: | Строка 139: | ||
+ | <!--T:15--> | ||
Идентификаторы типа устройства:<br> | Идентификаторы типа устройства:<br> | ||
0 = Delta DVP<br> | 0 = Delta DVP<br> | ||
Строка 133: | Строка 150: | ||
+ | <!--T:16--> | ||
Идентификаторы протокола обмена:<br> | Идентификаторы протокола обмена:<br> | ||
0 = ModBus ASCII<br> | 0 = ModBus ASCII<br> | ||
− | 1 = ModBus RTU | + | 1 = ModBus RTU<br> |
2 = ModBus TCP<br> | 2 = ModBus TCP<br> | ||
3 = Siemens PPI<br> | 3 = Siemens PPI<br> | ||
Строка 141: | Строка 159: | ||
5 = Allen Bradley DF1<br> | 5 = Allen Bradley DF1<br> | ||
6 = Internal WebHMI Registers<br> | 6 = Internal WebHMI Registers<br> | ||
+ | </translate> |
Текущая версия на 09:09, 13 апреля 2018
Для получения списка всех соединений необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/connections.
Для получения информации о конкретном соединений необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/connections/1. Здесь 1 - это ID нужного соединения.
В заголовках запроса ноебходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка соединений:
URL: http://192.168.1.1/api/connections
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "1", "title": "Внутренние регистры", "addr": "", "baudrate": "9600", "parity": "e", "stopbit": "1", "bitscount": "8", "model": "3", "protocol": "4", "timeout": "100", "timeout2": "", "device": "/dev/rs485", "disabled": "0", "mode": "0" }, { "id": "2", "title": "S7 200", "addr": "2", "baudrate": "9600", "parity": "e", "stopbit": "1", "bitscount": "8", "model": "1", "protocol": "3", "timeout": "200", "timeout2": "", "device": "/dev/rs485", "disabled": "1", "mode": "0" } ]
Пример запроса информации об соединений номер 2:
URL: http://192.168.1.1/api/connections/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "2", "title": "S7 200", "addr": "2", "baudrate": "9600", "parity": "e", "stopbit": "1", "bitscount": "8", "model": "1", "protocol": "3", "timeout": "200", "timeout2": "", "device": "/dev/rs485", "disabled": "1", "mode": "0" }
Атрибуты соединения:
id | int | Уникальный идентификатор соединения |
title | string | Название соединенеия |
addr | string | Адрес устройства на шине или сетевой адрес для TCP соединения |
baudrate | int | Скорость обмена данными для последовательных соединений |
parity | string | Контроль четности для последовательных соединений. e = Even, o = Odd, n = None |
stopbit | int | Количество стоповых битов для последовательных соединений |
model | int | Идентификатор типа устройства |
protocol | int | Идентификатор протокола обмена |
timeout | int | Максимальное время ожидания ответа на запрос от устройства |
device | string | Системное имя адаптера для последовательных соединений |
disabled | int | 0 = соединение активно, 1 = соединение отключено |
mode | int | 0 = норальный режим работе. 1 = режим Virtual UART |
Идентификаторы типа устройства:
0 = Delta DVP
1 = Siemens Simatic S7 200
2 = Generic ModBus
3 = Internal WebHMI Registers
4 = Generic Owen
5 = Generic DF1
Идентификаторы протокола обмена:
0 = ModBus ASCII
1 = ModBus RTU
2 = ModBus TCP
3 = Siemens PPI
4 = Owen
5 = Allen Bradley DF1
6 = Internal WebHMI Registers