API - Список соединений — различия между версиями
Материал из WebHMI Wiki
Строка 67: | Строка 67: | ||
Атрибуты соединения: | Атрибуты соединения: | ||
<table> | <table> | ||
− | <tr><td>id</td><td>int</td><td>Уникальный идентификатор соединения</td></tr> | + | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор соединения</td></tr> |
− | <tr><td>title</td><td>string</td><td>Название соединенеия</td></tr> | + | <tr><td>'''title'''</td><td>string</td><td>Название соединенеия</td></tr> |
− | <tr><td>addr</td><td>string</td><td>Адрес устройства на шине или сетевой адрес для TCP соединения</td></tr> | + | <tr><td>'''addr'''</td><td>string</td><td>Адрес устройства на шине или сетевой адрес для TCP соединения</td></tr> |
− | <tr><td>baudrate</td><td>int</td><td>Скорость обмена данными для последовательных соединений</td></tr> | + | <tr><td>'''baudrate'''</td><td>int</td><td>Скорость обмена данными для последовательных соединений</td></tr> |
− | <tr><td>parity</td><td>string</td><td>Контроль четности для последовательных соединений. e = Even, o = Odd, n = None</td></tr> | + | <tr><td>'''parity'''</td><td>string</td><td>Контроль четности для последовательных соединений. e = Even, o = Odd, n = None</td></tr> |
− | <tr><td>stopbit</td><td>int</td><td>Количество стоповых битов для последовательных соединений</td></tr> | + | <tr><td>'''stopbit'''</td><td>int</td><td>Количество стоповых битов для последовательных соединений</td></tr> |
− | <tr><td>model</td><td>int</td><td>Идентификатор типа устройства</td></tr> | + | <tr><td>'''model'''</td><td>int</td><td>Идентификатор типа устройства</td></tr> |
− | <tr><td>protocol</td><td>int</td><td>Идентификатор протокола обмена</td></tr> | + | <tr><td>'''protocol'''</td><td>int</td><td>Идентификатор протокола обмена</td></tr> |
− | <tr><td>timeout</td><td>int</td><td>Максимальное время ожидания ответа на запрос от устройства</td></tr> | + | <tr><td>'''timeout'''</td><td>int</td><td>Максимальное время ожидания ответа на запрос от устройства</td></tr> |
− | <tr><td>device</td><td>string</td><td>Системное имя адаптера для последовательных соединений</td></tr> | + | <tr><td>'''device'''</td><td>string</td><td>Системное имя адаптера для последовательных соединений</td></tr> |
− | <tr><td>disabled</td><td>int</td><td>0 = соединение активно, 1 = соединение отключено</td></tr> | + | <tr><td>'''disabled'''</td><td>int</td><td>0 = соединение активно, 1 = соединение отключено</td></tr> |
− | <tr><td>mode</td><td>int</td><td>0 = норальный режим работе. 1 = режим Virtual UART</td></tr> | + | <tr><td>'''mode'''</td><td>int</td><td>0 = норальный режим работе. 1 = режим Virtual UART</td></tr> |
</table> | </table> |
Версия 13:07, 17 января 2015
Для получения списка всех соединений необходимо выполнить 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://scada.kuzmuk.com:8080/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" } ]
Атрибуты соединения:
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 |