Difference between revisions of "IonoPiMax"
Jump to navigation
Jump to search
| (22 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 | + | [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 quad-core processor of the Raspberry Pi. |
[[File:Iono-pi-max-1.png|200px|thumb|Iono Pi Max]] | [[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 both a local installation of HSYCO on Iono Pi Max itself, or a remote Iono Pi Max unit connected via SSH. In both cases, 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 Max, leave blank for a local installation | ||
| + | *'''Port''': SSH port configured on Iono Pi Max (defaults to 22), leave blank for a local installation. | ||
| + | |||
| + | === Authentication === | ||
| + | *'''User''': username to access the remote Iono Pi Max via SSH, leave blank for a local installation | ||
| + | *'''Password''': password to access the remote Iono Pi Max via SSH, leave blank for a local installation. | ||
=== High Availability === | === High Availability === | ||
| Line 40: | Line 48: | ||
|10 <= n <= 30000 | |10 <= n <= 30000 | ||
|the data acquisition interval, in milliseconds | |the data acquisition interval, in milliseconds | ||
| + | |||
| + | |- | ||
| + | |||
| + | |rowspan="3"|dualsdsync | ||
| + | |rowspan="3"|false | ||
| + | |true | ||
| + | |enables the files synchronisation process that copies all HSYCO files and some operating system configuration files to the alternate SD card (SD1). Synchronisation occurs automatically once a minute. SD1 is enabled and its root file system mounted to /mnt/alt | ||
| + | |- | ||
| + | |false | ||
| + | |disables the files synchronisation process | ||
| + | |- | ||
| + | |manual | ||
| + | |doesn't change the watchdog configuration parameters | ||
|- | |- | ||
| Line 46: | Line 67: | ||
|rowspan="4"|always | |rowspan="4"|always | ||
|always | |always | ||
| − | |enables the hardware watchdog and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is set to 60 seconds while HSYCO is running, or to 1 hour when HSYCO is manually stopped (sysctl stop hsyco) and when it is starting | + | |enables the hardware watchdog and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is set to 60 seconds while HSYCO is running, or to 1 hour when HSYCO is manually stopped (sysctl stop hsyco) and when it is starting. If dualsdsync is set to true or manual, the watchdog is configured to boot from the alternate SD card if there is no heartbeat after the first reboot |
|- | |- | ||
|true | |true | ||
| − | |enables the hardware watchdog only while HSYCO is running, and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is temporarily set to 1 hour when HSYCO is starting | + | |enables the hardware watchdog only while HSYCO is running, and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is temporarily set to 1 hour when HSYCO is starting. If dualsdsync is set to true or manual, the watchdog is configured to boot from the alternate SD card |
|- | |- | ||
|false | |false | ||
| Line 66: | Line 87: | ||
|N > 0 | |N > 0 | ||
|the driver will command the operating system shutdown and hardware power off after N minutes of back-up battery operations during a power failure. Iono Pi Max will be turned back on when power is restored | |the driver will command the operating system shutdown and hardware power off after N minutes of back-up battery operations during a power failure. Iono Pi Max will be turned back on when power is restored | ||
| + | |||
| + | |- | ||
| + | |||
| + | |skip | ||
| + | | | ||
| + | |<list> | ||
| + | |Space or semicolon separated list of datapoints or prefixes (not including the I/O Server id). Datapoints starting with one of the keywords defined in the skip list are not polled. Skipping unused datapoints improves polling performance on both local and remote configurations | ||
|- | |- | ||
| Line 78: | Line 106: | ||
|} | |} | ||
| + | |||
| + | {{tip|The following configuration options are only used for local installations, and ignored on remote Iono Pi Max units: dualsdsync, watchdog, shutdown_minutes, quiet.}} | ||
== Datapoints == | == Datapoints == | ||
| − | The Iono Pi Max implements all data points provided by the underlying Iono Pi Max kernel module. Refer to the documentation | + | The Iono Pi Max implements all data points provided by the underlying Iono Pi Max kernel module. Refer to the documentation available at [https://github.com/sfera-labs/iono-pi-max-kernel-module Iono Pi Max Kernel Module]. |
| − | Each readable file name exposed by the kernel module under the /sys/ | + | Each readable file name exposed by the kernel module under the /sys/devices/virtual/ionopimax/ sub-directories appears as a data point with id <subdir>.<file>. For example, as the buzzer's status file is /sys/devices/virtual/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. | 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. | ||
| Line 100: | Line 130: | ||
!R/W | !R/W | ||
!Description | !Description | ||
| + | |||
| + | |- | ||
| + | |||
| + | |rowspan="2" |connection | ||
| + | |online | ||
| + | |R | ||
| + | |connection established | ||
| + | |- | ||
| + | |offline | ||
| + | |R | ||
| + | |HSYCO can't connect to the device | ||
|- | |- | ||
| Line 131: | Line 172: | ||
* -1: error while updating files (see logs) | * -1: error while updating files (see logs) | ||
* -2: alternate SD card not available or file system error | * -2: alternate SD card not available or file system error | ||
| + | |||
| + | |- | ||
| + | |||
| + | |dualsdsync.time<br>(cm duo only) | ||
| + | |<timestamp> | ||
| + | |R | ||
| + | |positive integer number representing the time in seconds since 00:00:00 UTC on 1 January 1970 of when the last synchronization run ended (with or without errors) | ||
|} | |} | ||
| + | |||
| + | {{tip|The shutdown, dualsdsync and dualsdsync.status datapoints are only available for local installations.}} | ||
== Release Notes == | == Release Notes == | ||
| Line 139: | Line 189: | ||
*dual µSD card support | *dual µSD card support | ||
*improved watchdog and UPS support | *improved watchdog and UPS support | ||
| + | *new "skip" option | ||
| + | *added support for remote Iono Pi Max units via SSH access | ||
| + | *new "connection" datapoint | ||
=== 3.7.0 === | === 3.7.0 === | ||
Latest revision as of 17:51, 13 July 2022
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 quad-core processor of the Raspberry Pi.
This driver provides support for both a local installation of HSYCO on Iono Pi Max itself, or a remote Iono Pi Max unit connected via SSH. In both cases, 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.
Contents
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.
Communication
- IP Address: the IP address assigned to Iono Pi Max, leave blank for a local installation
- Port: SSH port configured on Iono Pi Max (defaults to 22), leave blank for a local installation.
Authentication
- User: username to access the remote Iono Pi Max via SSH, leave blank for a local installation
- Password: password to access the remote Iono Pi Max via SSH, leave blank for a local installation.
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 |
| dualsdsync | false | true | enables the files synchronisation process that copies all HSYCO files and some operating system configuration files to the alternate SD card (SD1). Synchronisation occurs automatically once a minute. SD1 is enabled and its root file system mounted to /mnt/alt |
| false | disables the files synchronisation process | ||
| manual | doesn't change the watchdog configuration parameters | ||
| watchdog | always | always | enables the hardware watchdog and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is set to 60 seconds while HSYCO is running, or to 1 hour when HSYCO is manually stopped (sysctl stop hsyco) and when it is starting. If dualsdsync is set to true or manual, the watchdog is configured to boot from the alternate SD card if there is no heartbeat after the first reboot |
| true | enables the hardware watchdog only while HSYCO is running, and automatically generates the heartbeat signal (when the HSYCO main control loop is running normally, approximately every 10 seconds). The watchdog timeout is temporarily set to 1 hour when HSYCO is starting. If dualsdsync is set to true or manual, the watchdog is configured to boot from the alternate SD card | ||
| false | disables the hardware watchdog | ||
| ignore | doesn't change the watchdog configuration parameters | ||
| shutdown_minutes | 0 | 0 | no automatic shutdown after power failure |
| N > 0 | the driver will command the operating system shutdown and hardware power off after N minutes of back-up battery operations during a power failure. Iono Pi Max will be turned back on when power is restored | ||
| skip | <list> | Space or semicolon separated list of datapoints or prefixes (not including the I/O Server id). Datapoints starting with one of the keywords defined in the skip list are not polled. Skipping unused datapoints improves polling performance on both local and remote configurations | |
| quiet | false | true | enables audible alarms on power failure |
| false | disables audible alarms on power failure |
The following configuration options are only used for local installations, and ignored on remote Iono Pi Max units: dualsdsync, watchdog, shutdown_minutes, quiet.
Datapoints
The Iono Pi Max implements all data points provided by the underlying Iono Pi Max kernel module. Refer to the documentation available at Iono Pi Max Kernel Module.
Each readable file name exposed by the kernel module under the /sys/devices/virtual/ionopimax/ sub-directories appears as a data point with id <subdir>.<file>. For example, as the buzzer's status file is /sys/devices/virtual/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.
Additional datapoints
| ID | Value | R/W | Description |
|---|---|---|---|
| connection | online | R | connection established |
| offline | R | HSYCO can't connect to the device | |
| shutdown | 1 | W | initiate a power cycle |
| dualsdsync | 0 | R | manual SD synchronisation completed |
| 1 | R | manual SD synchronisation pending or in progress | |
| W | initiate SD synchronisation (only available when the dualsdsync option is set to "manual" | ||
| dualsdsync.status | N | R | status of the last SD synchronisation run:
|
| dualsdsync.time (cm duo only) |
<timestamp> | R | positive integer number representing the time in seconds since 00:00:00 UTC on 1 January 1970 of when the last synchronization run ended (with or without errors) |
The shutdown, dualsdsync and dualsdsync.status datapoints are only available for local installations.
Release Notes
3.8.0
- dual µSD card support
- improved watchdog and UPS support
- new "skip" option
- added support for remote Iono Pi Max units via SSH access
- new "connection" datapoint
3.7.0
- initial release
Iono Pi Max is a registered trademark of Sfera Labs Srl
