API - Список регистров/en
Материал из WebHMI Wiki
To get a list of all registers, you must perform a GET request on the URL like this: http://192.168.1.1/api/registers.
To obtain information about a particular register, you must perform a following GET request on a URL 'http://192.168.1.1/api/registers/1' . Here "1" is the ID of the desired register.
In the headers, it is necessary to pass API key. For example:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.
Accept: application/json Content-Type: application/json
Example of register list query:
URL: http://192.168.1.1/api/registers
Method: GET
Headers:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Response example:
[
{
"id": "1",
"plcid": "2",
"title": "Packing is in progress",
"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": "",
"delta": "0",
"delay": "0"
},
{
"id": "2",
"plcid": "2",
"title": "Recipe",
"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": "",
"delta": "0",
"delay": "0"
},
{
"id": "3",
"plcid": "2",
"title": "Packs counter",
"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": "",
"delta": "0",
"delay": "0"
}
]
Example of request for information about the register number 2:
URL: http://192.168.1.1/api/registers/2
Method: GET
Headers:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{
"id": "2",
"plcid": "2",
"title": "Recipe",
"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": "",
"delta": "0",
"delay": "0"
}
Register's attributes:
| id | int | Unique register id |
| title | string | Register name |
| plcid | string | Идентификатор соединения по которому будеи происходить работа с этим регистром The identifier of the associated connection of the register |
| addr | string | Register address |
| modbusAddr | string | Register address for embedded Modbus TCP server |
| type | int | Data type identifier (see below) |
| value_format | int | Data format identifier (see below) |
| dictid | int | Dictionary identifier |
| multiplicator | double | Multiplier for math conversations for the register value |
| shift | double | Constant for math conversions for the register value |
| save_to_log | int | 0 = don't save data to log, 1 = periodically save data to log |
| measure Units | string | Engineering units (meters, volts etc) |
| has_normal | int | 1 = register has normal state, 0 = not normal state |
| normal_regid | int | Identifier of the comparative register (for registers of a bit type) |
| normal_regid2 | int | Second comparative register identifier (for regisers of a bit type) |
| normal_dynamic_value | int | 1 = compare register value with values from comparative registers , 0 = compare register with constants |
| normal_binary_value | int | Binary value (1 or 0) which turns on normal register state |
| normal_binary_text | string | Text to display normal register state |
| normal_color | string | Normal state color |
| normal_min_regid | int | Minimal value register identifier for dynamic comparison |
| normal_min_delta | string | Delta with minimal value for dynamic comparison |
| normal_max_regid | int | Maximal value register identifier for dynamic comparison |
| normal_max_delta | string | Delta with maximal value for dynamic comparison |
| normal_min_val | double | Minimal value for standard comparison |
| normal_max_val | double | Maximal value for standard comparison |
| has_disabled | int | 1 = register has disabled state, 0 = register has no disabled state |
| disabled_regid | int | Comparative register identifier(for register of a bit type) |
| disabled_regid2 | int | Second comparative register identifier (for register of a bit type) |
| disabled_dynamic_value | int | 1 = compare register value with other register valueс, 0 = compare register value with constants |
| disabled_binary_value | int | Binary value (1 or 0) which turns on disabled register state |
| disabled_binary_text | string | Text to display disabled state |
| disabled_color | string | Disabled state color |
| disabled_min_regid | int | Minimal value register identifier for dynamic comparison |
| disabled_min_delta | string | Delta with minimal value for dynamic comparison |
| disabled_max_regid | int | Maximal value register identifier for dynamic comparison |
| disabled_max_delta | string | Delta with maximal value for dynamic comparison |
| disabled_min_val | double | Minimal value for standard comparison |
| disabled_max_val | double | Maximal value for standard comparison |
| has_warning | int | 1 = register has warning state, 0 = register has no warning state |
| warning_regid | int | Comparative register identifier (for register of a bit type) |
| warning_regid2 | int | Second comparative register identifier (for register of a bit type) |
| warning_dynamic_value | int | 1 = compare register value with other register's value, 0 = compare register value with constants |
| warning_binary_value | int | Binary value (1 or 0) which turns on warning state of the register |
| warning_binary_text | string | Text to display warning register state |
| warning_color | string | Warning state color |
| warning_min_regid | int | Minimal value register identifier for dynamic comparison |
| warning_min_delta | string | Delta with minimal value for dynamic comparison |
| warning_max_regid | int | Maximal value register identifier for dynamic comparison |
| warning_max_delta | string | Delta with maximal value for dynamic comparison |
| warning_min_val | double | Minimal value for standard comparison |
| warning_max_val | double | Maximal value for standard comparison |
| has_alert | int | 1 = register has alert state, 0 = register has no alert state |
| alert_regid | int | Comparative register identifier (for a bit type register) |
| alert_regid2 | int | Second comparative register (for a bit type register) |
| alert_dynamic_value | int | 1 = compare register value with other register's value, 0 = compare register value with constants |
| alert_binary_value | int | Binary value (1 or 0) which turns on alert state for the register |
| alert_binary_text | string | Text to display alert state |
| alert_color | string | Alert state color |
| alert_min_regid | int | Minimal value comparative register for dynamic comparison |
| alert_min_delta | string | Delta with minimal value for dynamic comparison |
| alert_max_regid | int | Maximal value comparative register for dynamic comparison |
| alert_max_delta | string | Delta with maximal value for dynamic comparison |
| alert_min_val | double | Minimal value for standard comparison |
| alert_max_val | double | Maximal value for standard comparison |
| timeformat | string | Date display format for registers of a UnixTime type |
| log_tolerance | double | Maximal change threshold when register value will be written to log |
| precision_digits | int | Number of digits after decimal point for fractional numbers |
| min_log_interval | int | Write value at least every X seconds |
| max_log_interval | int | Write value at most every X seconds |
| max_graph_interval | int | Connect points on graph curves if there is no data between them for more than X seconds |
| max_allowed_value | double | Maximal allowable value to enter for operator |
| min_allowed_value | double | Minimal allowable value to enter for operator |
| rw_mode | string | not used |
| min_reasonable_value | double | Minimal valid value. Dropping below this limit will force register value to nil. |
| max_reasonable_value | double | Maximal valid value. Raising above this limit will force register value to nil. |
| save_graph_data | int | Save date to draw grapsh. |
| graph_interval | int | time resolution for graph data. 0 = maximal resolution (assuming getting values from log), 1 = 1 minute, 2 = 2 minutes, 5 = 5 minutes, 15 = 15 minutes, 60 = 60 minutes |
| graph_color | string | Graph curve color |
| disabled | int | 0 = register is active, 1 = register is disabled |
| nocloud | int | 0 = send graph data to cloud , 1 = don't send grapsh data to cloud |
| delta | int | 0 = normal read mode, 1 = read the difference between current and previous values, 2 = same as "1" divided by time difference of these values (momentary speed) |
| delay | int | Poll rate in milliseconds. Can't be less than default value set in system settings. 0 = speed by default. |
Data type identifiers:
0 = Bit
1 = Byte
2 = Word
3 = Double Word
4 = Unix Time
Storage formats identifiers:
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
