Difference between revisions of "IonoPiMax"

From HSYCO
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[http://www.sferalabs.cc/iono-pi-max/ Iono Pi Max] is an extremely versatile industrial server with a huge variety of Input/Output lines and standard communication interfaces, all routed to the incredibly powerful quad-core processor of the Raspberry Pi.
 
[http://www.sferalabs.cc/iono-pi-max/ Iono Pi Max] is an extremely versatile industrial server with a huge variety of Input/Output lines and standard communication interfaces, all routed to the incredibly powerful quad-core processor of the Raspberry Pi.
  
−
[[File:iono_pi_module_board.png|200px|thumb|iono Pi]]
+
[[File:Iono-pi-max-1.png|200px|thumb|Iono Pi Max]]
  
−
This driver provides support for a local installation of HSYCO on Iono Pi Max itself.
+
This driver provides support for a local installation of HSYCO on Iono Pi Max itself. The Raspberry Pi OS Kernel module for Iono Pi Max must be installed. The kernel module documentation is available at [https://github.com/sfera-labs/iono-pi-max-kernel-module GitHub] and the Iono Pi Max [https://www.sferalabs.cc/files/ionopimax/doc/ionopimax-user-guide.pdf User Guide].
  
  
Line 12: Line 12:
  
 
{{note|Note that the IONO Pi Max 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 Pi Max with HSYCO.}}
 
{{note|Note that the IONO Pi Max 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 Pi Max with HSYCO.}}
−
 
−
=== Communication ===
 
−
*'''IP Address''': the IP address assigned to Iono Pi, leave blank for a local installation;
 
−
*'''Port''': TCP port configured on Iono Pi, leave blank for a local installation;
 
  
 
=== High Availability ===
 
=== High Availability ===
Line 49: Line 45:
 
== Datapoints ==
 
== Datapoints ==
  
−
{| class="wikitable"
+
The Iono Pi Max implements all data points provided by the underlying Iono Pi Max kernel module. Refer to the documentation is available at [https://github.com/sfera-labs/iono-pi-max-kernel-module GitHub].
−
!ID
 
−
!Value
 
−
!R/W
 
−
!Description
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="2" |connection
 
−
|online
 
−
|R
 
−
|connection established
 
−
|-
 
−
|offline
 
−
|R
 
−
|HSYCO can't connect to the device
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="3" |driverstate
 
−
|init
 
−
|R
 
−
|Sfera driver is initializing
 
−
|-
 
−
|quit
 
−
|R
 
−
|Sfera driver quit
 
−
|-
 
−
|running
 
−
|R
 
−
|Sfera driver is running (normal state)
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="4" |led
 
−
|rowspan="2" |0
 
−
|R
 
−
|LED L1 is off
 
−
|-
 
−
|W
 
−
|turn LED L1 off
 
−
|-
 
−
|rowspan="2" |1
 
−
|R
 
−
|LED L1 is on
 
−
|-
 
−
|W
 
−
|turn LED L1 on
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="4" |o<1-4>
 
−
|rowspan="2" |0
 
−
|R
 
−
|relay <1-4> is off
 
−
|-
 
−
|W
 
−
|switch off relay <1-4>
 
−
|-
 
−
|rowspan="2" |1
 
−
|R
 
−
|relay <1-4> is on
 
−
|-
 
−
|W
 
−
|switch on relay <1-4>
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="4" |oc<1-3>
 
−
|rowspan="2" |0
 
−
|R
 
−
|open collector output <1-3> is off (not grounded)
 
−
|-
 
−
|W
 
−
|switch off open collector output <1-3>
 
−
|-
 
−
|rowspan="2" |1
 
−
|R
 
−
|open collector output <1-3> is on (grounded)
 
−
|-
 
−
|W
 
−
|switch on open collector output <1-3>
 
−
 
 
−
|-
 
  
−
|rowspan="2" |di<1-6>
+
Each readable file name exposed by the kernel module under the /sys/class/ionopimax/ sub-directories appears as a data point with id <subdir>.<file>. For example, as the buzzer's status file is /sys/class/ionopimax/buzzer/status, the corresponding data point is "buzzer.status".
−
|0
 
−
|R
 
−
|digital input <1-6> is low
 
−
|-
 
−
|1
 
−
|R
 
−
|digital input <1-6> is high
 
−
 
 
−
|-
 
−
 
 
−
|ai<1-4>
 
−
|<val>
 
−
|R
 
−
|analog input <1-4> is reading a voltage equal to <val> (in Volts)
 
−
 
 
−
|-
 
−
 
 
−
|rowspan="2" |wiegand.<1-2>
 
−
|<val>
 
−
|R
 
−
|if option "wiegandbits" set to false. Value as an unsigned integer in base 16 (hex) read on the specified Wiegand interface (e.g. "2c646a2")
 
−
|-
 
−
|<bits>/<val>
 
−
|R
 
−
|if option "wiegandbits" set to true. Number of bits and value (hex) read on the specified Wiegand interface (e.g. "26/2c646a2")
 
−
 
 
−
|-
 
−
 
 
−
|onewire.bus.<id>
 
−
|<val>
 
−
|R
 
−
|1-Wire device <id> value
 
−
 
 
−
|}
 
  
−
== User Interface ==
+
Command files that are marked as write only in the documentation (W), are not shown as visible data points in HSYCO, but can be used in the IO events action or ioSet() methods to send a command.
  
−
To control a digital output (O1 ... O4, OC1 ... OC3, LED), add a [[button]] or a [[buttonicon]] object to your project page and set its address field to the corresponding datapoint:
+
For example, if "max" is the id assigned to the Iono Pi Max I/O Server, then:
 +
TIME : IO max.buzzer.beep = 1000
 +
will make the buzzer beep for 1 second (1000 ms).
  
−
[[File:IonoPi_UI_Button.png|500px|border]]
+
Note that "max.buzzer.beep" is not visible in the Status Browser and doesn't generate events, because it is write only, and only the "max.buzzer.status" data point will be visible, with a value of 0 if the buzzer is not active, or 1 if active.
  
 
== Release Notes ==
 
== Release Notes ==

Latest revision as of 15:41, 1 October 2020

Iono Pi Max is an extremely versatile industrial server with a huge variety of Input/Output lines and standard communication interfaces, all routed to the incredibly powerful quad-core processor of the Raspberry Pi.

Iono Pi Max

This driver provides support for a local installation of HSYCO on Iono Pi Max itself. The Raspberry Pi OS Kernel module for Iono Pi Max must be installed. The kernel module documentation is available at GitHub and the Iono Pi Max User Guide.

HSYCO Configuration

Add a IONO Pi Max I/O Server in the I/O Servers section of the Settings and set its parameters:

Note that the IONO Pi Max 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 Pi Max with HSYCO.


High Availability

  • Shutdown when inactive: defaults to false.

Options

ID Default Values Description
startupevents false 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 250 10 <= n <= 30000 the data acquisition interval, in milliseconds

Datapoints

The Iono Pi Max implements all data points provided by the underlying Iono Pi Max kernel module. Refer to the documentation is available at GitHub.

Each readable file name exposed by the kernel module under the /sys/class/ionopimax/ sub-directories appears as a data point with id <subdir>.<file>. For example, as the buzzer's status file is /sys/class/ionopimax/buzzer/status, the corresponding data point is "buzzer.status".

Command files that are marked as write only in the documentation (W), are not shown as visible data points in HSYCO, but can be used in the IO events action or ioSet() methods to send a command.

For example, if "max" is the id assigned to the Iono Pi Max I/O Server, then: 

TIME : IO max.buzzer.beep = 1000

will make the buzzer beep for 1 second (1000 ms).

Note that "max.buzzer.beep" is not visible in the Status Browser and doesn't generate events, because it is write only, and only the "max.buzzer.status" data point will be visible, with a value of 0 if the buzzer is not active, or 1 if active.

Release Notes

3.7.0

  • initial release


Iono Pi Max is a registered trademark of Sfera Labs Srl

Retrieved from "https://wiki.hsyco.com/3.7/index.php?title=IonoPiMax&oldid=9034"