API - Список регистров
Материал из WebHMI Wiki
Версия от 07:51, 19 января 2015; Alexander.kuzmuk (обсуждение | вклад) (Новая страница: «Для получения списка всех регистров необходимо выполнить GET-запрос на URL вида '''http://192.168.1.…»)
Для получения списка всех регистров необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/registers.
Для получения информации о конкретном регистре необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/registers/1. Здесь 1 - это ID нужного регистра.
В заголовках запроса ноебходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка регистров:
URL: http://192.168.1.1/api/registers
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[
{
"id": "1",
"plcid": "2",
"title": "Идет упаковка",
"addr": "M1.0",
"modbusAddr": "",
"type": "0",
"dictid": "0",
"value_format": "0",
"multiplicator": "",
"shift": "",
"save_to_log": "0",
"measureUnits": "",
"has_normal": "0",
"normal_regid": "0",
"normal_regid2": "0",
"normal_dynamic_value": "0",
"normal_binary_value": "",
"normal_binary_text": "",
"normal_color": "#33d356",
"normal_min_regid": "-1",
"normal_min_delta": "",
"normal_max_regid": "-1",
"normal_max_delta": "",
"normal_min_val": "",
"normal_max_val": "",
"has_disabled": "0",
"disabled_regid": "0",
"disabled_regid2": "0",
"disabled_dynamic_value": "0",
"disabled_binary_value": "",
"disabled_binary_text": "",
"disabled_color": "#cccccc",
"disabled_min_regid": "-1",
"disabled_min_delta": "",
"disabled_max_regid": "-1",
"disabled_max_delta": "",
"disabled_min_val": "",
"disabled_max_val": "",
"has_warning": "0",
"warning_regid": "0",
"warning_regid2": "0",
"warning_dynamic_value": "0",
"warning_binary_value": "",
"warning_binary_text": "",
"warning_color": "#f0b417",
"warning_min_regid": "-1",
"warning_min_delta": "",
"warning_max_regid": "-1",
"warning_max_delta": "",
"warning_min_val": "",
"warning_max_val": "",
"has_alert": "0",
"alert_regid": "0",
"alert_regid2": "0",
"alert_dynamic_value": "0",
"alert_binary_value": "",
"alert_binary_text": "",
"alert_color": "#ee434d",
"alert_min_regid": "-1",
"alert_min_delta": "",
"alert_max_regid": "-1",
"alert_max_delta": "",
"alert_min_val": "",
"alert_max_val": "",
"timeformat": "Y-m-d H:i:s",
"log_tolerance": "",
"precision_digits": "",
"min_log_interval": "",
"max_log_interval": "",
"max_graph_interval": "",
"max_allowed_value": "",
"min_allowed_value": "",
"rw_mode": "",
"min_reasonable_value": "",
"max_reasonable_value": "",
"save_graph_data": "0",
"graph_interval": "1",
"graph_color": "#ff0000",
"disabled": "0",
"nocloud": ""
},
{
"id": "2",
"plcid": "2",
"title": "Рецепт",
"addr": "VW100",
"modbusAddr": "",
"type": "2",
"dictid": "1",
"value_format": "0",
"multiplicator": "",
"shift": "",
"save_to_log": "0",
"measureUnits": "",
"has_normal": "0",
"normal_regid": "0",
"normal_regid2": "0",
"normal_dynamic_value": "0",
"normal_binary_value": "",
"normal_binary_text": "",
"normal_color": "#32d355",
"normal_min_regid": "-1",
"normal_min_delta": "",
"normal_max_regid": "-1",
"normal_max_delta": "",
"normal_min_val": "",
"normal_max_val": "",
"has_disabled": "0",
"disabled_regid": "0",
"disabled_regid2": "0",
"disabled_dynamic_value": "0",
"disabled_binary_value": "",
"disabled_binary_text": "",
"disabled_color": "#cccccc",
"disabled_min_regid": "-1",
"disabled_min_delta": "",
"disabled_max_regid": "-1",
"disabled_max_delta": "",
"disabled_min_val": "",
"disabled_max_val": "",
"has_warning": "0",
"warning_regid": "0",
"warning_regid2": "0",
"warning_dynamic_value": "0",
"warning_binary_value": "",
"warning_binary_text": "",
"warning_color": "#f0b416",
"warning_min_regid": "-1",
"warning_min_delta": "",
"warning_max_regid": "-1",
"warning_max_delta": "",
"warning_min_val": "",
"warning_max_val": "",
"has_alert": "0",
"alert_regid": "0",
"alert_regid2": "0",
"alert_dynamic_value": "0",
"alert_binary_value": "",
"alert_binary_text": "",
"alert_color": "#ee434d",
"alert_min_regid": "-1",
"alert_min_delta": "",
"alert_max_regid": "-1",
"alert_max_delta": "",
"alert_min_val": "",
"alert_max_val": "",
"timeformat": "Y-m-d H:i:s",
"log_tolerance": "",
"precision_digits": "",
"min_log_interval": "",
"max_log_interval": "",
"max_graph_interval": "",
"max_allowed_value": "",
"min_allowed_value": "",
"rw_mode": "",
"min_reasonable_value": "",
"max_reasonable_value": "",
"save_graph_data": "0",
"graph_interval": "1",
"graph_color": "#ff0000",
"disabled": "0",
"nocloud": ""
},
{
"id": "3",
"plcid": "2",
"title": "Счетчик упаковок",
"addr": "С1",
"modbusAddr": "",
"type": "3",
"dictid": "0",
"value_format": "0",
"multiplicator": "",
"shift": "",
"save_to_log": "0",
"measureUnits": "",
"has_normal": "0",
"normal_regid": "0",
"normal_regid2": "0",
"normal_dynamic_value": "0",
"normal_binary_value": "",
"normal_binary_text": "",
"normal_color": "#33d356",
"normal_min_regid": "-1",
"normal_min_delta": "",
"normal_max_regid": "-1",
"normal_max_delta": "",
"normal_min_val": "",
"normal_max_val": "",
"has_disabled": "0",
"disabled_regid": "0",
"disabled_regid2": "0",
"disabled_dynamic_value": "0",
"disabled_binary_value": "",
"disabled_binary_text": "",
"disabled_color": "#cccccc",
"disabled_min_regid": "-1",
"disabled_min_delta": "",
"disabled_max_regid": "-1",
"disabled_max_delta": "",
"disabled_min_val": "",
"disabled_max_val": "",
"has_warning": "0",
"warning_regid": "0",
"warning_regid2": "0",
"warning_dynamic_value": "0",
"warning_binary_value": "",
"warning_binary_text": "",
"warning_color": "#f0b417",
"warning_min_regid": "-1",
"warning_min_delta": "",
"warning_max_regid": "-1",
"warning_max_delta": "",
"warning_min_val": "",
"warning_max_val": "",
"has_alert": "0",
"alert_regid": "0",
"alert_regid2": "0",
"alert_dynamic_value": "0",
"alert_binary_value": "",
"alert_binary_text": "",
"alert_color": "#ee434d",
"alert_min_regid": "-1",
"alert_min_delta": "",
"alert_max_regid": "-1",
"alert_max_delta": "",
"alert_min_val": "",
"alert_max_val": "",
"timeformat": "Y-m-d H:i:s",
"log_tolerance": "",
"precision_digits": "",
"min_log_interval": "",
"max_log_interval": "",
"max_graph_interval": "",
"max_allowed_value": "",
"min_allowed_value": "",
"rw_mode": "",
"min_reasonable_value": "",
"max_reasonable_value": "",
"save_graph_data": "0",
"graph_interval": "1",
"graph_color": "#ff0000",
"disabled": "0",
"nocloud": ""
}
]
Пример запроса информации о регистре номер 2:
URL: http://192.168.1.1/api/registers/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{
"id": "2",
"plcid": "2",
"title": "Рецепт",
"addr": "VW100",
"modbusAddr": "",
"type": "2",
"dictid": "1",
"value_format": "0",
"multiplicator": "",
"shift": "",
"save_to_log": "0",
"measureUnits": "",
"has_normal": "0",
"normal_regid": "0",
"normal_regid2": "0",
"normal_dynamic_value": "0",
"normal_binary_value": "",
"normal_binary_text": "",
"normal_color": "#32d355",
"normal_min_regid": "-1",
"normal_min_delta": "",
"normal_max_regid": "-1",
"normal_max_delta": "",
"normal_min_val": "",
"normal_max_val": "",
"has_disabled": "0",
"disabled_regid": "0",
"disabled_regid2": "0",
"disabled_dynamic_value": "0",
"disabled_binary_value": "",
"disabled_binary_text": "",
"disabled_color": "#cccccc",
"disabled_min_regid": "-1",
"disabled_min_delta": "",
"disabled_max_regid": "-1",
"disabled_max_delta": "",
"disabled_min_val": "",
"disabled_max_val": "",
"has_warning": "0",
"warning_regid": "0",
"warning_regid2": "0",
"warning_dynamic_value": "0",
"warning_binary_value": "",
"warning_binary_text": "",
"warning_color": "#f0b416",
"warning_min_regid": "-1",
"warning_min_delta": "",
"warning_max_regid": "-1",
"warning_max_delta": "",
"warning_min_val": "",
"warning_max_val": "",
"has_alert": "0",
"alert_regid": "0",
"alert_regid2": "0",
"alert_dynamic_value": "0",
"alert_binary_value": "",
"alert_binary_text": "",
"alert_color": "#ee434d",
"alert_min_regid": "-1",
"alert_min_delta": "",
"alert_max_regid": "-1",
"alert_max_delta": "",
"alert_min_val": "",
"alert_max_val": "",
"timeformat": "Y-m-d H:i:s",
"log_tolerance": "",
"precision_digits": "",
"min_log_interval": "",
"max_log_interval": "",
"max_graph_interval": "",
"max_allowed_value": "",
"min_allowed_value": "",
"rw_mode": "",
"min_reasonable_value": "",
"max_reasonable_value": "",
"save_graph_data": "0",
"graph_interval": "1",
"graph_color": "#ff0000",
"disabled": "0",
"nocloud": ""
}
Атрибуты регистров:
| 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 = Bit
1 = Byte
2 = Word
3 = Double Word
4 = Unix Time
Идентификаторы форматов хранения данных:
0 = Unsigned, Integer
1 = Signed, Integer
2 = Unsigned, Fixed Point Float (0 ... +1)
3 = Signed, Fixed Point Float (-1 ... +1)
4 = Two's complement
5 = Signed, Floating Point, 32 Bits, IEEE 754
6 = Signed, Floating Point, 24 Bits
7 = Signed, Floating Point, 32 Bits, IEEE 754, Reverse Word Order
