API - Получение текущих значений регистров — различия между версиями
(Новая страница: «Для получения текущих значений всех регистров необходимо выполнить GET-запрос на URL вида '…») |
|||
(не показано 8 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
+ | <languages/> | ||
+ | <translate> | ||
+ | <!--T:1--> | ||
Для получения текущих значений всех регистров необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/register-values'''. | Для получения текущих значений всех регистров необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/register-values'''. | ||
+ | <!--T:2--> | ||
В заголовках запроса необходимо передать API key. Например: | В заголовках запроса необходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 6: | Строка 10: | ||
</pre> | </pre> | ||
− | + | <!--T:3--> | |
+ | В заголовках запроса необходимо передать идентификаторы (ID) соединений. Будут возвращены значения регистров только из тех соединений, ID который указаны в заголовке X-WH-CONNS. ID нужно разделять запятой, без пробелов. Это позволяет запрашивать не все регистры, а только часть. | ||
+ | |||
+ | |||
+ | '''Начиная с прошивки версии 3.3 вместо заголовка X-WH-CONNS следует использовать заголовок X-WH-CONNECTIONS.''' | ||
+ | |||
+ | <!--T:4--> | ||
+ | Например: | ||
+ | <pre> | ||
+ | X-WH-CONNS: 1,2 | ||
+ | </pre> | ||
+ | В данном примере будут возвращены значения регистров из соединений c ID=1 и ID=2. | ||
+ | |||
+ | <!--T:5--> | ||
+ | В заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживается работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Accept: application/json | Accept: application/json | ||
Строка 14: | Строка 32: | ||
+ | <!--T:6--> | ||
Пример запроса текущих значений: | Пример запроса текущих значений: | ||
+ | <!--T:7--> | ||
'''URL''': http://192.168.1.1/api/register-values<br> | '''URL''': http://192.168.1.1/api/register-values<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:8--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 25: | Строка 46: | ||
Accept-Encoding: gzip, deflate, sdch | Accept-Encoding: gzip, deflate, sdch | ||
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 | X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 | ||
+ | X-WH-CONNS: 1,2 | ||
</pre> | </pre> | ||
+ | <!--T:9--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 80: | Строка 103: | ||
<Br> | <Br> | ||
Формат возвращаемых данных следующий:<br> | Формат возвращаемых данных следующий:<br> | ||
− | Возвращаетмя объект, где названием свойств | + | Возвращаетмя объект, где названием свойств являются ID регистров. А самими свойствами являются еще одни объекты. <br> |
У каждого объекта есть три свойства: r, v, s.<br><br> | У каждого объекта есть три свойства: r, v, s.<br><br> | ||
− | '''r''' - это ID регистра. Например, 10 <br> | + | '''r''' - это ID регистра. Например, 10<br> |
'''v''' - это значение регистра в текущий момент времении или "-1" если значение не получилось прочитать.<br> | '''v''' - это значение регистра в текущий момент времении или "-1" если значение не получилось прочитать.<br> | ||
'''s''' - это состояние (state) регистра, которое соответствовало ему в указанный момент времени. Unknown = u, Disabled = d, Normal = n, Warning = w, Alert = a, Incorrect = i.<br> | '''s''' - это состояние (state) регистра, которое соответствовало ему в указанный момент времени. Unknown = u, Disabled = d, Normal = n, Warning = w, Alert = a, Incorrect = i.<br> | ||
+ | </translate> |
Текущая версия на 11:49, 3 декабря 2018
Для получения текущих значений всех регистров необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/register-values.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
В заголовках запроса необходимо передать идентификаторы (ID) соединений. Будут возвращены значения регистров только из тех соединений, ID который указаны в заголовке X-WH-CONNS. ID нужно разделять запятой, без пробелов. Это позволяет запрашивать не все регистры, а только часть.
Начиная с прошивки версии 3.3 вместо заголовка X-WH-CONNS следует использовать заголовок X-WH-CONNECTIONS.
Например:
X-WH-CONNS: 1,2
В данном примере будут возвращены значения регистров из соединений c ID=1 и ID=2.
В заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживается работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса текущих значений:
URL: http://192.168.1.1/api/register-values
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 X-WH-CONNS: 1,2
Пример ответа:
{ "1": { "r": "1", "v": "-1", "s": "i" }, "2": { "r": "2", "v": "-1", "s": "i" }, "3": { "r": "3", "v": "-1", "s": "i" }, "4": { "r": "4", "v": "1422600498", "s": "u" }, "5": { "r": "5", "v": "1422600498", "s": "u" }, "6": { "r": "6", "v": "-1", "s": "i" }, "7": { "r": "7", "v": "-1", "s": "i" }, "8": { "r": "8", "v": "18", "s": "u" }, "9": { "r": "9", "v": "0", "s": "u" } }
Формат возвращаемых данных следующий:
Возвращаетмя объект, где названием свойств являются ID регистров. А самими свойствами являются еще одни объекты.
У каждого объекта есть три свойства: r, v, s.
r - это ID регистра. Например, 10
v - это значение регистра в текущий момент времении или "-1" если значение не получилось прочитать.
s - это состояние (state) регистра, которое соответствовало ему в указанный момент времени. Unknown = u, Disabled = d, Normal = n, Warning = w, Alert = a, Incorrect = i.