Difference between revisions of "Iono"
(→3.7.0) |
|||
(19 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | Iono is a general-purpose, professional input/output module based on a standard Arduino microcontroller. | + | [http://www.sferalabs.cc/iono/ Iono] is a general-purpose, professional input/output module based on a standard Arduino microcontroller. |
− | This driver provides support for iono Ethernet employing the HTTP API provided by the [ | + | [[File:Iono_ethernet.png|200px|thumb|iono Ethernet]] |
+ | |||
+ | This driver provides support for iono Ethernet employing the HTTP API provided by the [https://github.com/sfera-labs/iono/wiki/IonoWeb IonoWeb library]. | ||
+ | |||
+ | The default sketch installed in iono Ethernet exposes this API. | ||
[[Category:I/O Server]] | [[Category:I/O Server]] | ||
Line 7: | Line 11: | ||
== HSYCO Configuration == | == HSYCO Configuration == | ||
Add a IONO I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters: | Add a IONO I/O Server in the [[Settings#I/O Servers|I/O Servers section of the Settings]] and set its parameters: | ||
+ | |||
+ | {{note|Note that the IONO I/O Server doesn't count in the I/O servers license total, so you don't need an extra I/O Server license to use IONO with HSYCO.}} | ||
+ | |||
+ | === Communication === | ||
+ | *'''IP Address''': the IP address assigned to iono; | ||
+ | *'''Port''': the TCP port (defaults to 80) | ||
=== High Availability === | === High Availability === | ||
− | |||
*'''Shutdown when inactive''': defaults to true. | *'''Shutdown when inactive''': defaults to true. | ||
Line 23: | Line 32: | ||
|rowspan="2"|startupevents | |rowspan="2"|startupevents | ||
− | |rowspan="2"| | + | |rowspan="2"|true |
|true | |true | ||
|generate IO events also during the driver’s start-up phase | |generate IO events also during the driver’s start-up phase | ||
Line 31: | Line 40: | ||
|- | |- | ||
+ | |||
+ | |rowspan="2"|pollinterval | ||
+ | |rowspan="2"|0 | ||
+ | |0 | ||
+ | |the driver will use the push notifications sent by iono to monitor its changes | ||
+ | |- | ||
+ | |int > 0 | ||
+ | |the driver will poll iono's state with the specified time interval (in seconds). Push notifications won't be enabled | ||
+ | |||
+ | |- | ||
+ | |||
+ | |input1 | ||
+ | |rowspan="4"|digital | ||
+ | |rowspan="2"|digital | ||
+ | |rowspan="2"|the specified multi-mode input will be read as digital signal (DI<n>) | ||
+ | |- | ||
+ | |input2 | ||
+ | |- | ||
+ | |input3 | ||
+ | |voltage | ||
+ | |the specified multi-mode input will be read as analog voltage (AV<n>) | ||
+ | |- | ||
+ | |input4 | ||
+ | |current | ||
+ | |the specified multi-mode input will be read as analog current (AI<n>) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |stabletime | ||
+ | |100 | ||
+ | |int > 0 | ||
+ | |number of milliseconds an input must be stable before a push notification is sent by iono to HSYCO | ||
+ | |||
+ | |- | ||
+ | |||
+ | |minvariation | ||
+ | |0.1 | ||
+ | |float > 0 | ||
+ | |minimun value variation (for analog inputs) to trigger an event | ||
+ | |||
+ | |- | ||
+ | |||
+ | |subscribehost | ||
+ | | | ||
+ | |<host_name> | ||
+ | |hostname or IP address to be used by iono to send push notifications. Leave blank to let the driver discover the local address | ||
|} | |} | ||
== Datapoints == | == Datapoints == | ||
+ | |||
+ | For inputs 1 to 4, depending on the 'input1' ... 'input4' options, only the corresponding datapoint will be created, i.e. di<n> (if digital), av<n> (if voltage) or ai<n> (if curent). | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 54: | Line 111: | ||
|- | |- | ||
+ | |||
+ | |rowspan="4" |do<n> | ||
+ | |rowspan="2" |0 | ||
+ | |R | ||
+ | |relay <n> (digital output) is off | ||
+ | |- | ||
+ | |W | ||
+ | |switch off relay <n> | ||
+ | |- | ||
+ | |rowspan="2" |1 | ||
+ | |R | ||
+ | |relay <n> (digital output) is on | ||
+ | |- | ||
+ | |W | ||
+ | |switch on relay <n> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |rowspan="2" |di<n> | ||
+ | |0 | ||
+ | |R | ||
+ | |digital input <n> is low | ||
+ | |- | ||
+ | |1 | ||
+ | |R | ||
+ | |digital input <n> is high | ||
+ | |||
+ | |- | ||
+ | |||
+ | |av<n> | ||
+ | |<val> | ||
+ | |R | ||
+ | |analog input <n> is reading a voltage equal to <val> (in Volts) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |ai<n> | ||
+ | |<val> | ||
+ | |R | ||
+ | |analog input <n> is reading a current equal to <val> (in mA) | ||
+ | |||
+ | |- | ||
+ | |||
+ | |ao1 | ||
+ | |<val> | ||
+ | |W | ||
+ | |set the analog output to <val> Volts | ||
|} | |} | ||
Line 59: | Line 163: | ||
== User Interface == | == User Interface == | ||
+ | To control a digital output (DO1 ... DO6), add a [[button]] or a [[buttonicon]] object to your project page and set its address field to the corresponding datapoint: | ||
+ | |||
+ | [[File:Iono_UI_Buttonicon.png|500px|border]] | ||
== Release Notes == | == Release Notes == | ||
+ | |||
+ | === 3.7.0 === | ||
+ | *the IONO I/O Server is now "free". Using it doesn't decrease the number of available I/O servers | ||
+ | *"minvariation" option now also applies to polling mode | ||
+ | *bug fix for I/O Server port option | ||
=== 3.5.0 === | === 3.5.0 === | ||
Line 68: | Line 180: | ||
− | ''iono is a registered | + | ''iono is a registered trademark of Sfera Labs Srl'' |
Latest revision as of 18:41, 22 February 2019
Iono is a general-purpose, professional input/output module based on a standard Arduino microcontroller.
This driver provides support for iono Ethernet employing the HTTP API provided by the IonoWeb library.
The default sketch installed in iono Ethernet exposes this API.
Contents
HSYCO Configuration
Add a IONO I/O Server in the I/O Servers section of the Settings and set its parameters:
Communication
- IP Address: the IP address assigned to iono;
- Port: the TCP port (defaults to 80)
High Availability
- Shutdown when inactive: defaults to true.
Options
ID | Default | Values | Description |
---|---|---|---|
startupevents | true | true | generate IO events also during the driver’s start-up phase |
false | start generating events only after HSYCO is aligned with the current status of the system | ||
pollinterval | 0 | 0 | the driver will use the push notifications sent by iono to monitor its changes |
int > 0 | the driver will poll iono's state with the specified time interval (in seconds). Push notifications won't be enabled | ||
input1 | digital | digital | the specified multi-mode input will be read as digital signal (DI<n>) |
input2 | |||
input3 | voltage | the specified multi-mode input will be read as analog voltage (AV<n>) | |
input4 | current | the specified multi-mode input will be read as analog current (AI<n>) | |
stabletime | 100 | int > 0 | number of milliseconds an input must be stable before a push notification is sent by iono to HSYCO |
minvariation | 0.1 | float > 0 | minimun value variation (for analog inputs) to trigger an event |
subscribehost | <host_name> | hostname or IP address to be used by iono to send push notifications. Leave blank to let the driver discover the local address |
Datapoints
For inputs 1 to 4, depending on the 'input1' ... 'input4' options, only the corresponding datapoint will be created, i.e. di<n> (if digital), av<n> (if voltage) or ai<n> (if curent).
ID | Value | R/W | Description |
---|---|---|---|
connection | online | R | connection established |
offline | R | HSYCO can't connect to the device | |
do<n> | 0 | R | relay <n> (digital output) is off |
W | switch off relay <n> | ||
1 | R | relay <n> (digital output) is on | |
W | switch on relay <n> | ||
di<n> | 0 | R | digital input <n> is low |
1 | R | digital input <n> is high | |
av<n> | <val> | R | analog input <n> is reading a voltage equal to <val> (in Volts) |
ai<n> | <val> | R | analog input <n> is reading a current equal to <val> (in mA) |
ao1 | <val> | W | set the analog output to <val> Volts |
User Interface
To control a digital output (DO1 ... DO6), add a button or a buttonicon object to your project page and set its address field to the corresponding datapoint:
Release Notes
3.7.0
- the IONO I/O Server is now "free". Using it doesn't decrease the number of available I/O servers
- "minvariation" option now also applies to polling mode
- bug fix for I/O Server port option
3.5.0
- initial release
iono is a registered trademark of Sfera Labs Srl