Difference between revisions of "HwgMonitor"

From HSYCO
Jump to navigation Jump to search
(Created page with "The HWGMONITOR I/O Server supports the following monitoring devices from [http://www.hw-group.com HW group]: * STE * Poseidon * Damocles. Category:I/O Server == HSYCO Co...")
 
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
The HWGMONITOR I/O Server supports the following monitoring devices from [http://www.hw-group.com HW group]:
 
The HWGMONITOR I/O Server supports the following monitoring devices from [http://www.hw-group.com HW group]:
 +
 +
* Damocles
 +
* Poseidon
 
* STE
 
* STE
−
* Poseidon
+
* WLD.
−
* Damocles.
+
 
  
 
[[Category:I/O Server]]
 
[[Category:I/O Server]]
Line 20: Line 23:
 
=== Options ===
 
=== Options ===
  
−
There are no available configuration options for the HWGMONITOR I/O Server.
+
{| class="wikitable"
 +
!ID
 +
!Default
 +
!Values
 +
!Description
 +
|-
 +
 
 +
|pollinterval
 +
|1000
 +
|n ≥ 0
 +
|the data polling interval, in milliseconds
 +
|-
 +
|}
  
 
==Monitoring Devices Configuration ==
 
==Monitoring Devices Configuration ==
Line 27: Line 42:
  
 
All HWg monitoring devices allow you to assign custom names to each sensor connected to a device.
 
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.
 
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.
 
You should configure these names, using the configuration interface of the device.
  
Line 36: Line 49:
 
== Datapoints ==
 
== Datapoints ==
  
−
The data points associated to the input pins are named “i1” to “i8”.
+
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.
−
 
 
−
The data points associated to the output pins are named “o1” to “o8”.
 
−
 
 
−
The I/O Server generates asynchronous events based on the status of the I/O Controller's input and output pins. The output data points can be written to control the output pins.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 49: Line 58:
 
|-
 
|-
  
−
|rowspan="2" |i<n>
+
|model
−
|0
+
|<model_id>
 
|R
 
|R
−
|input <n> is low
+
|the device model, as returned in the <model> tag of the XML response
 +
 
 
|-
 
|-
−
|1
+
|<sensor_name>
 +
|<value>
 
|R
 
|R
−
|input <n> is high
+
|the value returned for input <sensor_name>, as returned in the <value> tag of the XML response
 +
 
 
|-
 
|-
 +
|<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)
  
−
|rowspan="4" |o<n>
+
|-
−
|rowspan="2" |0
+
|<sensor_name>.units
 +
|<units>
 
|R
 
|R
−
|output <n> is low
+
|the units string returned for input <sensor_name>, as returned in the <units> tag of the XML response
 +
 
 
|-
 
|-
 +
|read
 +
|all
 
|W
 
|W
−
|set output <n> to off
+
|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" |1
 
−
|R
 
−
|output <n> is high
 
 
|-
 
|-
 +
|rowspan="2" |<output_id>
 +
|0
 
|W
 
|W
−
|set output N to on
+
|set output <output_id> to off
 +
|-
 +
|1
 +
|W
 +
|set output <output_id> to on
 +
 
 
|}
 
|}
 +
 +
 +
{{note|Please note that while the assigned sensor name is used to identify sensors, the outputs are identified by their IDs, not the names.}}
 +
 +
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.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.
+
*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.
+
*support for the HWg Damocles line of products, with input lines counters
  
 
=== 2.8.0 ===
 
=== 2.8.0 ===
−
* Initial support.
+
*initial support
  
 
----
 
----

Latest revision as of 11:33, 24 October 2014

The HWGMONITOR I/O Server supports the following monitoring devices from HW group:

  • Damocles
  • Poseidon
  • STE
  • WLD.

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
<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


Please note that while the assigned sensor name is used to identify sensors, the outputs are identified by their IDs, not the names.


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.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.

Retrieved from "http://wiki.hsyco.com/3.5.0/index.php?title=HwgMonitor&oldid=5262"