User's manual

v0.8
User's manual page 2/25
ndice
1. Introduction..................................................................................................................3
2. Hardware description...................................................................................................3
2.1. Connection blocks...........................................................................................................4
2.2. Serial port (RS-232)........................................................................................................5
4. Web server.....................................................................................................................6
5. Command server.........................................................................................................10
5.1 Authentication................................................................................................................ 10
5.2 Variable set..................................................................................................................... 10
5.2 Status............................................................................................................................... 11
5.3 eep connection ali!e.....................................................................................................12
5.3 Reboot............................................................................................................................. 12
6. Event server................................................................................................................12
7. I.!EC responses......................................................................................................13
". #eria$ server................................................................................................................13
%. &actor' de(au$ts..........................................................................................................14
10. Con(i)uration too$....................................................................................................15
10.1 "ar#$are %eatures........................................................................................................15
10.2 &nternal !ariables.........................................................................................................1'
10.3 (o)ical Controller........................................................................................................1*
11. *ec+nica$ speci(ications...........................................................................................25
User's manual page 3/25
1. Introduction
IO.XEC is a device that captures electrical signals, and transmits this information
through a C!/I! connection, in an Ethernet net"or#. It implements the follo"ing C!
applications$
%e& server 'port 80(
Event server 'port 8)00(
Command server 'port 8)0*(
+erial',+)-)(.Ethernet &ridge 'port /01*(
2. Hardware description
Ports:
Ethernet
+erial ',+)-)(
Inputs:
8 general purpose digital inputs 'several configurations are possi&le(
* fast digital input, designed for incremental encoders
* analogue temperature input 'the recommended sensor is 23-4(
* analog input '0.*05(
Outputs:
- rela6 digital outputs
4 open collector digital outputs
* analog output '0.*05(
User's manual page 4/25
2.1. Connection blocks
he connection &loc#s are accessi&le after opening the device's enclosure.
Bloco de terminais CON1
B
l
o
c
o

d
e

t
e
r
m
i
n
a
i
s

C
O
N
2
!o"er suppl6
7igital outputs
1 2
GND 12Vdc
CON 1
3 4 5 6 7
NOCMNC
OUT0
NOCMNC
OUT1
NOCMNC
OUT2
O
U
T
3
O
U
T
4
O
U
T
5
O
U
T
6
O
U
T
7
C
O
M

O
U
T
! 10 11 12 13 14 15 16 17
CON 1
User's manual page 5/25
7igital inputs
2.2. Serial port (S!2"2#
,8** ,+)-)'79/(
) 4
: -
4 )
1 1! 20 21 22
C
O
M

"
N
"
N
0
23 24 25 26
CON 1
"
N
1
"
N
2
"
N
3
"
N
4
"
N
5
"
N
6
"
N
7
User's manual page 6/25
$. %eb ser&er
he "e& server is availa&le "ith a standard &ro"ser. he device's status and
configuration can &e vie"ed and changed accessing the various pages. he default
username and pass"ord re;uired to login are <admin= e <>ec=, respectivel6.
?ome page
User's manual page 7/25
5aria&le status
User's manual page /25
Upload of configuration file
User's manual page !/25
@et"or# configuration
User's manual page 10/25
'. Command ser&er
he command server ma#es it possi&le to control and get status of the device. It
allo"s to activate the outputs and get the status of all the varia&les. In order to access
this service, a C! soc#et must &e created to the device, on port 8)00. he default
username and pass"ord re;uired to login, are <admin= and <>ec=, respectivel6. he
C! port num&er is 8)00. All the commands must &e terminated "ith BCD.
he varia&les "hose status can &e retrieved, and activated, are$
E>$ digital outputs >$ 0..8
9>$ internal &its >$ 0..0
C0$ high speed counter
@>$ internal numerical varia&les >$ 0..0
AO$ analog output
I>$ digital input >$ 0..0
AI0$ analog input
AI$ analog temperature input
'.1 (ut)entication
+6nta>$ 2OFI@, user,passBCD
user$ user name
pass$ pass"ord
'.2 *ariable set
All the setta&le varia&les a&ove, can &e set "ith this command.
+6nta>$ +E,var,valG,timerHBCD
var$ E>/9>/C0/@>/AO
val$ 0/*/$ E>/9>
.)*:0:8-1:8..)*:0:8-1:0$ @>/C>
0..*000$ AO
timer$ 0..////$ E>/9> 'in */*0s(
User's manual page 11/25
'.2 Status
If the +A command is issued, the status of all the varia&les is retrieved.
+6nta>$ +ABCD
he response of the command has several fields, according to the varia&le
t6pe$
GIE9HIiiiiiiii;;;;;;;;&&&&&&&& 7igital varia&les
i...$ 8 inputs
;...$ 8 outputs
&...$ 8 internal &its
i,;,&$ f$ varia&le is false 'inactive(
i,;,&$ t$ varia&le is true 'active(
i$ r$ push &utton is released
i,;,&$ J$ varia&le changed to false
i,;,&$ $ varia&le changed to true
i$ +$ push &utton "as pressed for a short time
i$ 2$ push &utton "as pressed for a long time
i$ ,$ push &utton "as pressed for a long time, and released
G@3>HI6 5alue of numerical varia&les
>$ 0..0
6$ .)*:0:8-1:8..)*:0:8-1:0
GC@0HI6 5alue of the high speed counter
6$ .)*:0:8-1:8..)*:0:8-1:0
GAI>HI6 5alue of analog inputs
>$ 0,
6$ 0..*000
GAOHI6 5alue of analog output
6$ 0..*000
User's manual page 12/25
'." +eep connection ali&e
2i#e all em&edded devices, the resources are limited. In order to save memor6,
IO.XEC onl6 #eeps connections active "hen needed. If no commands are sent
during *)0 seconds, the connection is closed. In order to #eep the soc#et alive,
a <#eep alive= command must &e issued. @ote that this command is onl6
needed if no other commands are sent for a *)0 seconds period.
+6nta>$ KABCD
'." eboot
,e&oots the device.
+6nta>$ ,E9OOBCD
,. -&ent ser&er
According to the configuration that is done 'see section *0(, IO.XEC sends information
a&out the events detected on internal varia&les and hard"are.
his server onl6 implements ) commands$ <login= 'see section 4.*( and <#a= 'see
section 4.-(. he s6nta> is the same as descri&ed &efore.
%hen an event happens, IO.XEC sends a string li#e the <stat= 'see section 4.)(
command, &ut limited to the field containing the event. Jor e>ample, if an event occurs
in an input, onl6 the GIE9H event is sent.
he C! port num&er of this service is 8)0*.
User's manual page 13/25
.. IO./-C responses
%elcomeC Connection successfull6 opened
GOKH Command successfull6 e>ecuted
GE,,H$*00 Invalid command
GE,,H$)00 Argument error$ invalid varia&le
GE,,H$-00 Argument error$ invalid value
GE,,H$:00 Argument error$ invalid num&er of arguments
GE,,H$400 2ogin error
GE,,H$800 Command not allo"ed
GE,,H$/00 2ogin not performed
0. Serial ser&er
he serial server is a transparent &ridge &et"een a C! soc#et and a serial port
',+)-)(. After a connection is esta&lished, all the &6tes received on soc#et are
dispatched through the serial port, and all the &6tes that arrive on the ,+)-) port are
for"ard to the C! connection. he C! port num&er is /01*. he &aud rate of the
serial port is selected using the configuration tool 'see section *0(.
User's manual page 14/25
1. 2actor3 de4aults
%hen IO.XEC is connected for the first time, it has the follo"ing net"or# configuration$
7?C!$ active
I! address$ *1/.)4:.*.* 'in case there is no 7?C! server(
+u&net mas#$ )44.)44.0.0 'in case there is no 7?C! server(
@et9IO+ name$ XEC
Username$ admin
!ass"ord$ >ec
o restore factor6 default parameters, locate the push.&utton on the &oard and do the
follo"ing$
turn off IO.XEC
press and hold the push.&utton
turn on the device
hold the push.&utton pressed for at least 4 seconds, during &oot.
User's manual page 15/25
15. Con4i6uration tool
he configuration tool, allo"s to$
name the various varia&les, "ith suita&le la&els. hese la&els "ill &e use to
identif6 the varia&les in the "e& server
define the t6pe of hard"are that is connected to the inputs
configure the events that are sent through the event server
define the &aud rate of the serial port
define the time Lone properties
implement some automation features
send configuration to IO.XEC
ma#e test connections to the command and event server
15.1 Hardware 4eatures
User's manual page 16/25
In this ta&, the hard"are is configured according to the application needs.
Inputs
In the inputs section, 6ou can define, for each input$
the la&el
the t6pe
standard 'a regular contact(
push.&utton
the events that are captured and sent through the event server
(nalo6
In the analog section, 6ou can define$
the la&el
the value of the analogue output on po"er up
the value variation that has to occur, in order to create an event
Counter
In this section, 6ou can define$
the la&el
the value of the counter on po"er up
the t6pe of counter
the value variation that has to occur, in order to create an event
the divider 'num&er of pulses detected to increment the counter(
7i6ital outputs
In this section, 6ou can define$
the la&el
the value of each output on po"er up
the events that are captured
User's manual page 17/25
8CP!serial brid6e
?ere 6ou can define the &aud rate of the ,+)-) port.
8ime de4initions
IO.XEC has an internal cloc# that s6nchroniLes to ntp.org time server. In order to
adMust local time settings it can &e defined$
the time Lone, in terms of hours. Jor instance, if the device is located in$
2is&on, 0$00 should &e used
!aris, *$00 should &e used
ALores, .*$00 should &e used
?elsin#i, )$00 should &e used
7a6light +aving ime '7+( start and end patterns. hese patterns have
four sections, separated &6 a dot '.(. Nou can setup the da6, month, da6
of "ee#, and hour "here the 7+ start or end ta#es place.
he s6nta> is$ BmonthD.Bda6D.Bda6 of "ee#D.BsearchD. Jor e>ample$
0:.0*.1O).)$00$ start 7+ on the second +unda6 of April, at )$00
0-.-*.1.*.)$00$ start 7+ on the last +unda6 of 3arch, at )$00
0-.-*...)$00$ start 7+ on the -*th 3arch, at )$00
*0.-*.1.*.)$00$ end 7+ on the last +unda6 of Octo&er, at )$00
User's manual page 1/25
15.2 Internal &ariables
7i6ital internal &ariables
he6 act as virtual IOs. It can &e configured$
the la&el
the value on po"er up
the events that are captured
User's manual page 1!/25
9umerical &ariables
hese varia&les have length of -)&it 'signed(. It can &e defined$
the la&el
the value on po"er up
the value variation that has to occur, in order to create an event
15." :o6ical Controller
he logical controller allo"s to implement automation functions. he device can
perform calculations logical com&inations of the various varia&les 'internal and
e>ternal(.
User's manual page 20/25
*ariables
*. 9oolean
I> 7igital input I>, >$ 0..0
E> 7igital output E>, >$ 0..0
9> Internal &it 9>, >$ 0..0

). @umerical
@> @umerical internal varia&le @>, >$ 0..0
C0 ?igh speed counter
AO Analog output '0..*000(
AI0 Analog input '0..*000(
AI emperature analog input '0../0(
+ Internal cloc#$ current second
3 Internal cloc#$ current minute
? Internal cloc#$ current hour
77 Internal cloc#$ current da6
73 Internal cloc#$ current month
7N Internal cloc#$ current 6ear
7% Internal cloc#$ current "ee# da6
2unction -*-98
his function detects an event on a digital IO or internal &it. ,eturns true "hen the
event occurs
+6nta>$ E5E@'var,event(
var$ I>/E>/9>
event$ $ varia&le turns to true
J$ varia&le turn to 4alse
+$ "hen a s)ort push occurs in a push &utton
2$ "hen a lon6 push occurs in a push &utton
,$ "hen a push &utton is released, after a long push
User's manual page 21/25
2unction IS
,eturns true if the logical value of a digital IO or internal &it e;uals the value
parameter. ,eturns false, other"ise.
+6nta>$ I+'var,value(
var$ I>/E>/9>
event$ 8: &ariable is true
J$ varia&le is 4alse
+$ during a s)ort push in a push &utton
2$ during a lon6 push in a push &utton
,$ after a push &utton is released
2unction CO;P(-
,eturns the result 'true or false( of the comparison &et"een t"o numerical varia&les,
using a comparison operator.
+6nta>$ CO3!A,E'var*,operator,var)(
var*$ @>/C0/AI0/AI/AO/+/3/?/7N/73/77/7%
var)$ @>/C0/AI0/AI/AO/+/3/?/7N/73/77/7%/>'-)&it value(
event$ D$ returns true, if var* is 6reater than var)
B$ returns true, if var* is less than var)
DI$ returns true, if var* is 6reater t)an or e<ual to var)
BI$ returns true, if var* is less t)an or e<ual to var)
CI$ returns true, if var* is di44erent var)
User's manual page 22/25
2unction S-8
If a true condition is met, assigns a value to a varia&le. his functions has - variations,
depending on the varia&les and parameters used.
+6nta> *$ +E'var(
+ets the value of the condition to var
var$ I>/E>/9>
+6nta> )$ +E'var,valueG,tmrH(
+ets var to value, if the condition is true. 7oes nothing
other"ise.
var$ I>/E>/9>
value$ 0 'false( / * 'true( / 'toggle(
tmr$ timer in */*0s. optional.
+6nta> -$ +E'var*,var)(
+ets var* "ith the value of var), if the condition is true. var) can
contain simple calculations, such as @:O*0P C0Q@*. 7oes
nothing other"ise.
var*$ @>/C0/AI0/AI/AO/+/3/?/7N/73/77/7%
var)$ @>/C0/AI0/AI/AO/+/3/?/7N/73/77/7%/>'-)&it value(
simple calculations allo"ed.
User's manual page 23/25
S3nta=
he s6nta> is ver6 simple. he automation concept is organiLed in lines, each one
divided in t"o sections 'left and right(.
he lines are e>ecuted one after the other. %hen the processor reaches the lats lien, it
Mumps to the first one. %hile the logic controller is active, this process is repeated
endlessl6.
As stated, each line has t"o sections$ left and right. On the left, the com&ination of
events and status is performed using the functions I+, E5E@ and CO3!A,E and the
follo"ing operators$
Q$ logical A@7
O$ logical O,
R$ logical XO,
'($ parenthesis to implement priorities in the evaluation
On the right a +E operation must &e defined. According to the s6nta> used, an action
is performed. +ome e>amples ar provided$
oggle E0, "hen I0 is active$
event'i0,t(Iset';0,t(
If I0 is true and I* or I) are true, activate E*. 7eactivate E* other"ise
is'i0,t(Q'is'i*,t(Ois'i),t((Iset';*(
9lin# an output ever6 second$
compare'ts,CI,ts(Iset';*,*,4(
Count the num&er of seconds that an input is active
is'i-,t(Qcompare'ts,CI,ts(Iset'n0,n0O*(
3ultiple lines can &e added to achieve the re;uired automation. he num&er of lines is
limited &6 the availa&le memor6. he configuration tool indicates ho" much memor6 is
occupied &6 the "ritten lines.
"o &loc#s can &e added. he first &loc# is e>ecuted one time, in order to initialiLe the
process. he second is iterated.
he &ehavior of the logic controller on po"er up, can &e one of the follo"ing$
7on't start$ It can &e started through the "e& page.
+tart immediatel6$ After the re&oot, as soon as possi&le
+tart after a successful time update. %aits until the @! server is availa&le and
an update to the current time is performed. It needs an Internet connection
he logic controller status is sho"n in the "e& server.
User's manual page 24/25
11. 8ec)nical speci4ications
!o"er *)5/*A
Ethernet *0/*00 &ase S *03&it/s
+erial port ',+.)-)( :800&ps / /100&ps / */)00&ps / 40100&ps /
**4)00&ps
no parit6, no flu> control
,ela6 outputs 1A/)-05ac
Open collector outputs *)5/*40mA
Inputs 4.):5dc, no polarit6
?igh speed counter input Incremental encoder
?igh speed counter po"er *0.-05dc
emperature sensor 23-4
Analog input 0.*05dc
Analog output 0.*05dc
User's manual page 25/25