Difference between revisions of "ArtecoOC"

From HSYCO
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 26: Line 26:
 
|-
 
|-
  
−
|rowspan="2"|startupevents
+
|connectorid
−
|rowspan="2"|false
+
|
−
|true
+
|N
−
|generate IO events also during the driver’s start-up phase
+
|the connector ID, configured in the Arteco Next platform. This parameter is mandatory; the I/O Server will not start without a valid ID.
−
|-
 
−
|false
 
−
|start generating events only after HSYCO is aligned with the current status of the system
 
−
|-
 
−
 
 
−
|rowspan="2"|inputdiscovery
 
−
|rowspan="2"|false
 
−
|true
 
−
|automatically creates the list of all inputs in the systemtopo.txt file. Should be enabled to allow the automatic update of (button) objects’ states
 
−
|-
 
−
|false
 
−
|auto-detect for input devices is disabled
 
−
|-
 
−
 
 
−
|rowspan="2"|outputdiscovery
 
−
|rowspan="2"|false
 
−
|true
 
−
|automatically creates the list of all outputs in the systemtopo.txt file. Should be enabled to allow the automatic update of (button) objects’ states
 
−
|-
 
−
|false
 
−
|auto-detect for output devices is disabled
 
−
|-
 
−
 
 
−
|inputs
 
−
|8
 
−
|0 ... 8
 
−
|use input pins from 0 to the specified value
 
−
|-
 
−
 
 
−
|outputs
 
−
|8
 
−
|0 ... 8
 
−
|use output pins from 0 to  the specified value
 
 
|-
 
|-
  
Line 68: Line 35:
  
 
== Datapoints ==
 
== Datapoints ==
−
 
−
The data points associated to the input pins are named “i0” to “i7”. The data points associated to the output pins are named “o0” to “o7”.
 
−
 
−
The I/O Server generates asynchronous events based on the status of the Arteco module’s input and output pins. The output data points can be written to control the output pins.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 87: Line 50:
 
|offline
 
|offline
 
|R
 
|R
−
|HSYCO can't connect to the panel
+
|HSYCO can't connect to the Arteco Open Connector server
 
|-
 
|-
  
−
|rowspan="2" |i<n>
+
|event
−
|0
+
|value
−
|R
+
|W
−
|input <n> is low
+
|send an event notification
−
|-
 
−
|1
 
−
|R
 
−
|input <n> is high
 
 
|-
 
|-
  
−
|rowspan="7" |o<n>
+
|rowspan="4" |io.&lt;s&gt;.&lt;p&gt;
 
|rowspan="2" |0
 
|rowspan="2" |0
 
|R
 
|R
−
|output <n> is low
+
|pin &lt;p&gt; of server &lt;s&gt; successfully set to 0
 
|-
 
|-
 
|W
 
|W
−
|set output <n> to off
+
|set pin &lt;p&gt; of server &lt;s&gt; to 0
 
|-
 
|-
  
 
|rowspan="2" |1
 
|rowspan="2" |1
 
|R
 
|R
−
|output <n> is high
+
|pin pin &lt;p&gt; of server &lt;s&gt; successfully set to 1
 
|-
 
|-
 
|W
 
|W
−
|set output <n> to on
+
|set pin &lt;p&gt; of server &lt;s&gt; to 1
−
|-
 
−
 
 
−
|flip
 
−
|W
 
−
|invert the status of output <n>
 
−
|-
 
−
 
 
−
|blink
 
−
|W
 
−
|continuously blink output <n>
 
−
|-
 
−
 
 
−
|pulse
 
−
|W
 
−
|set output <n> to on, then off after 1 sec.
 
 
|-
 
|-
  
 
|}
 
|}
  
−
== User Interface ==
+
You can send simple events, with only a text description, by writing a plain text message to the event datapoint, for example:
−
 
 
−
When using the default settings of the Arteco I/O Server, all output pins are available in the Project Editor and can be easily associated to any control button of the Web interface.
 
  
−
You can also set the ''inputdiscovery'' option in order to associate control buttons to the module’s inputs: the control buttons will show the input status, and have no effect when pressed.
+
<pre>
 +
init : io connector.event = "this is the description of an event sent to Open Connector wevery time the events code is updated"
 +
</pre>
  
 +
You can also sent any custom XML section data compatibile with the Open Connector protocol specification, by simply passing the full XML string of all relevant sections in the value, including empty sections, after the plain text description. For example, the following function cound be used to send an event with custom XML data:
  
−
[[File:IO Servers Arteco Project Editor.png]]
+
<pre>
 +
function OCURLEventDataBlock(text, icon, label, datablock, url) {
 +
ioSet('connector.event', text + '<cameras />' + datablock +
 +
'<io /><web><web-device id="10"><icon id="' + icon + '" /><label>' + label + '</label><target><url>' +
 +
url + '</url></target></web-device></web>');
 +
}
 +
</pre>
  
 
== Release Notes ==
 
== Release Notes ==
−
=== 3.3.0 ===
+
=== 3.5.1 ===
 
*initial release
 
*initial release
  

Latest revision as of 13:53, 25 January 2016

The ARTECOOC I/O Server can be used to interface HSYCO and the Arteco Next platform using the Arteco Open Connector SDK protocol.

The current release of the I/O Server has been tested with the Arteco Open Connector protocol V6. It automatically handles connection and authentication to the OC server, and offers simple commands to send events and control output devices.

HSYCO Configuration

Add an ARTECOOC 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 Arteco Open Connector server
  • IP Port: TCP/IP port to use, leave blank to use default port 80
  • User: username
  • Password: password.

High Availability

  • Shutdown when inactive: defaults to false.

Options

ID Default Values Description
connectorid N the connector ID, configured in the Arteco Next platform. This parameter is mandatory; the I/O Server will not start without a valid ID.

Datapoints

ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the Arteco Open Connector server
event value W send an event notification
io.<s>.<p> 0 R pin <p> of server <s> successfully set to 0
W set pin <p> of server <s> to 0
1 R pin pin <p> of server <s> successfully set to 1
W set pin <p> of server <s> to 1

You can send simple events, with only a text description, by writing a plain text message to the event datapoint, for example: 

init : io connector.event = "this is the description of an event sent to Open Connector wevery time the events code is updated"

You can also sent any custom XML section data compatibile with the Open Connector protocol specification, by simply passing the full XML string of all relevant sections in the value, including empty sections, after the plain text description. For example, the following function cound be used to send an event with custom XML data: 

function OCURLEventDataBlock(text, icon, label, datablock, url) {
	ioSet('connector.event', text + '<cameras />' + datablock +
		'<io /><web><web-device id="10"><icon id="' + icon + '" /><label>' + label + '</label><target><url>' +
		url + '</url></target></web-device></web>');
}

Release Notes

3.5.1

  • initial release


ARTECO is a registered trademark of Arteco Srl.

Retrieved from "http://wiki.hsyco.com/3.5.1/index.php?title=ArtecoOC&oldid=6253"