Difference between revisions of "HwgMonitor"
Jump to navigation
Jump to search
| (16 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
* Damocles | * Damocles | ||
* Poseidon | * Poseidon | ||
| − | * STE | + | * STE, STE2 and STE2 R2 |
* WLD. | * WLD. | ||
| Line 23: | Line 23: | ||
=== Options === | === Options === | ||
| − | + | {| class="wikitable" | |
| + | !ID | ||
| + | !Default | ||
| + | !Values | ||
| + | !Description | ||
| + | |- | ||
| + | |||
| + | |pollinterval | ||
| + | |1000 | ||
| + | |n ≥ 0 | ||
| + | |the data polling interval, in milliseconds | ||
| + | |- | ||
| + | |} | ||
==Monitoring Devices Configuration == | ==Monitoring Devices Configuration == | ||
| Line 52: | Line 64: | ||
|- | |- | ||
| − | |<sensor_name> | + | |rowspan="3" |<sensor_name> |
|<value> | |<value> | ||
|R | |R | ||
|the value returned for input <sensor_name>, as returned in the <value> tag of the XML response | |the value returned for input <sensor_name>, as returned in the <value> tag of the XML response | ||
| + | |- | ||
| + | |0 | ||
| + | |W | ||
| + | |set digital output to off | ||
| + | |- | ||
| + | |1 | ||
| + | |W | ||
| + | |set digital output to on | ||
|- | |- | ||
| Line 68: | Line 88: | ||
|R | |R | ||
|the units string returned for input <sensor_name>, as returned in the <units> tag of the XML response | |the units string returned for input <sensor_name>, as returned in the <units> tag of the XML response | ||
| + | |||
| + | |- | ||
| + | |read | ||
| + | |all | ||
| + | |W | ||
| + | |forces the driver to poll the device to read the current status. This command could be used to occasionally refresh the status at a faster rate that the preset poll interval | ||
| + | |||
|- | |- | ||
|rowspan="2" |<output_id> | |rowspan="2" |<output_id> | ||
| Line 81: | Line 108: | ||
| − | {{note| | + | {{note|Note that outputs can now be controlled using the name-based data point, as well as the output ID.}} |
| + | |||
| + | You can retrieve the output IDs looking at the values.xml page (for example <nowiki>http://<damocles ip address>/values.xml</nowiki>). The output section should have an <ID> XML entry. | ||
| + | |||
| + | In the example below, the ID of out1 is 151: | ||
| + | |||
| + | <Entry> | ||
| + | <ID>151</ID> | ||
| + | <Name>out1</Name> | ||
| + | <NameOff>OFF</NameOff> | ||
| + | <NameOn>ON</NameOn> | ||
| + | <Mode>0</Mode> | ||
| + | <Value>1</Value> | ||
| + | <Init>0</Init> | ||
| + | <CondInputID>0</CondInputID> | ||
| + | <Trigger>0.0</Trigger> | ||
| + | </Entry> | ||
== Release Notes == | == Release Notes == | ||
| + | === 3.8.0 === | ||
| + | *adds support for STE2 R2 | ||
| + | |||
| + | === 3.6.0 === | ||
| + | *outputs can now be controlled using the name-based data point, as well as the output ID | ||
| + | |||
| + | === 3.4.0 === | ||
| + | *new poll interval option | ||
| + | *new command read=all to read the device status | ||
| + | |||
=== 3.0.1 === | === 3.0.1 === | ||
| − | * | + | *fixed a bug that could block the update of the systemtopo.txt file at start-up |
=== 2.8.4 === | === 2.8.4 === | ||
| − | * | + | *support for the HWg Damocles line of products, with input lines counters |
=== 2.8.0 === | === 2.8.0 === | ||
| − | * | + | *initial support |
---- | ---- | ||
Latest revision as of 20:14, 11 December 2020
The HWGMONITOR I/O Server supports the following monitoring devices from HW group:
- Damocles
- Poseidon
- STE, STE2 and STE2 R2
- WLD.
Contents
HSYCO Configuration
Add an HWGMONITOR I/O Server in the I/O Servers section of the Settings and set its parameters:
Communication
- IP Address: host name or IP address of the device
- IP Port: TCP/IP port to use, leave blank to use default port 80.
High Availability
- Shutdown when inactive: defaults to true (these devices accept multiple connection and could be accessed by two HSYCO servers simultaneously).
Options
| ID | Default | Values | Description |
|---|---|---|---|
| pollinterval | 1000 | n ≥ 0 | the data polling interval, in milliseconds |
Monitoring Devices Configuration
This I/O Server uses the XML format and HTTP requests to constantly poll the devices for the current status.
All HWg monitoring devices allow you to assign custom names to each sensor connected to a device. The name is important, as it is used by HSYCO as the id to retrieve the sensor’s data. You should configure these names, using the configuration interface of the device.
Refer to the device manual for detailed configuration information.
Datapoints
The I/O Server generates asynchronous events based on the status of the devices input pins. The output data points can be written to control the output pins.
| ID | Value | R/W | Description |
|---|---|---|---|
| model | <model_id> | R | the device model, as returned in the <model> tag of the XML response |
| <sensor_name> | <value> | R | the value returned for input <sensor_name>, as returned in the <value> tag of the XML response |
| 0 | W | set digital output to off | |
| 1 | W | set digital output to on | |
| <sensor_name>.cnt | <value> | R | the counter value returned for input <sensor_name>, as returned in the <cnt> tag of the XML response (for Damocles devices) |
| <sensor_name>.units | <units> | R | the units string returned for input <sensor_name>, as returned in the <units> tag of the XML response |
| read | all | W | forces the driver to poll the device to read the current status. This command could be used to occasionally refresh the status at a faster rate that the preset poll interval |
| <output_id> | 0 | W | set output <output_id> to off |
| 1 | W | set output <output_id> to on |
Note that outputs can now be controlled using the name-based data point, as well as the output ID.
You can retrieve the output IDs looking at the values.xml page (for example http://<damocles ip address>/values.xml). The output section should have an <ID> XML entry.
In the example below, the ID of out1 is 151:
<Entry> <ID>151</ID> <Name>out1</Name> <NameOff>OFF</NameOff> <NameOn>ON</NameOn> <Mode>0</Mode> <Value>1</Value> <Init>0</Init> <CondInputID>0</CondInputID> <Trigger>0.0</Trigger> </Entry>
Release Notes
3.8.0
- adds support for STE2 R2
3.6.0
- outputs can now be controlled using the name-based data point, as well as the output ID
3.4.0
- new poll interval option
- new command read=all to read the device status
3.0.1
- fixed a bug that could block the update of the systemtopo.txt file at start-up
2.8.4
- support for the HWg Damocles line of products, with input lines counters
2.8.0
- initial support
HWg is a registered trademark of HW group s.r.o.
