IOT-GATE-RPI4 I/O Configuration

From Compulab Mediawiki
Jump to: navigation, search

Overview

This article provides instructions for iotg-rpi4-config utility. It's a command-line interactive tool for configuring IOT-GATE-RPI4 peripherals and Industrial I/O modules.
The utility is part of IOT-GATE-RPI4 OS Configuration Layer.

Running utility

Admolition note.png IOT-GATE-RPI4 configuration settings made by iotg-rpi4-config are propagated into config.txt file and require a reboot to take effect.

Please run the iotg-rpi4-config with root permissions:

pi@raspberrypi:~$ sudo iotg-rpi4-config

Navigation

Use the Up and Down arrow keys to move through menu options, Enter to move in and Esc to move out.
Use Space to select/deselect configuration option.
Use Tab to jump between menu body and control buttons (e.g. Select, Back etc.)

Main Menu

Main menu provides access to main options:

┌─────────────┤ IOTG-RPi4 Configuration Tool (iotg-rpi4-config) ├──────────────┐
│                                                                              │
│         1 Peripherals                Peripheral devices options              │
│         2 Industrial I/O modules     Industrial I/O modules options          │
│         3 Save Changes and Exit      Apply changes and exit                  │
│         4 Discard Changes and Exit   Exit discarding changes                 │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Configure Peripheral devices

IOT-GATE-RPI4 features an optional on-board Trusted Platform Module which can be enabled/disabled via this menu.

Admolition note.png TPM is mutually exclusive with I/O slot D
┌─────────────────────┤ Configure IOTG-RPI4 Peripherals ├──────────────────────┐
│                                                                              │
│    [*] TPM  Enable/Disable Trusted Platform Module                           │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Industrial I/O Modules Options

┌──────────────────────┤ Industrial I/O Modules Options ├──────────────────────┐
│                                                                              │
│     I1 Show                   Show Industrial I/O Modules Configuration      │
│     I2 Configure              Configure Industrial I/O Modules Settings      │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Configure Industrial I/O Modules

For each industrial slot user is allowed to choose one of following configuration option:

  • Keep (default) - try to preserve a slot configuration currently stored in the config.txt Should be used to avoid unnecessary explicit configuration
  • Detect - detect a currently plugged industrial I/O module type and store in the config.txt. Used if I/O module has been installed, but hasn't been configured yet
  • CAN - configure CAN interface on a slot regardless of a a currently plugged module type.
  • RS232 - configure RS232 interface on a slot regardless of a currently plugged module type
  • RS485 - configure RS485 interface on a slot regardless of a currently plugged module type
  • IO - configure Digital I/O module on a slot regardless of a currently plugged module type. Affects a neighbor slot as well because Digital I/O module takes two slots
  • Empty - disable any slot configuration in the config.txt regardless of a currently plugged module type.
  • Deactivate - detect a currently plugged industrial I/O module type and store in the config.txt as a commented line (best efforts). May be used for example to

Specific I/O module type options (CAN, RS232, RS485, IO, Empty) are usually used when different I/O module (or no one) is currently installed, but user wants to replace it with different one.

┌──────────────────────────┤ Industrial I/O Slot A ├───────────────────────────┐
│                                                                              │
│    ( ) Keep        Keep current module configuration unchanged               │
│    ( ) Detect      Detect currently plugged module type: [Empty]             │
│    (*) CAN         Configure CAN interface                                   │
│    ( ) RS232       Configure RS232 interface                                 │
│    ( ) RS485       Configure RS485 interface                                 │
│    ( ) IO          Configure Digital I/O - dual slot                         │
│    ( ) Empty       Skip module type configuration                            │
│    ( ) Deactivate  Detect currently plugged module type but leave inactive   │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
Admolition note.png iotg-rpi4-config utility makes best efforts to apply user defined configuration. But result is not guaranteed because not any user configuration is applicable

User defined configuration can be shown in a corresponding menu.

Show Industrial I/O Modules

┌────────────────┤ Show Industrial I/O Modules Configuration ├─────────────────┐
│                                                                              │
│     D1 Show User Configured        Show user defined configuration           │
│     D2 Show Detected               Show currently detected configuration     │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Detected modules

This option displays industrial I/O slots and detected I/O modules

┌──────┤ Industrial I/O modules detected ├───────┐
│                                                │
│         Slot A:                [Empty]         │
│                                                │
│         Slot B:                [Empty]         │
│                                                │
│         Slot C:                [IO]            │
│                                                │
│         Slot D:                [IO]            │
│                                                │
│                                                │
│                     <Ok>                       │
│                                                │
└────────────────────────────────────────────────┘

User defined configuration

This option displays user defined configuration for industrial I/O slots and underlying modules

┌──────────┤ Industrial I/O modules: user defined configuration ├──────────────┐
│                                                                              │
│     Slot A: [CAN] - Configure CAN interface                                  │
│                                                                              │
│     Slot B: [Keep] - Keep current module configuration unchanged             │
│                                                                              │
│     Slot C: [Detect] - Detect currently plugged module type                  │
│                                                                              │
│     Slot D: [Detect] - Detect currently plugged module type                  │
│                                                                              │
│                                                                              │
│                                    <Ok>                                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Save Changes

It's strongly recommended to review user defined configuration for I/O modules before applying a new configuration.

┌──────────────────────────────────────────────────────────┐
│                                                          │
│ Would you like to apply changes and exit?                │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│                                                          │
│               <Save & Exit>          <Back>              │
│                                                          │
└──────────────────────────────────────────────────────────┘

Please note, all changes require a reboot to take effect.

┌────────────────────────────────────────────────────────────────────┐
│                                                                    │
│         NOTE: ANY CHANGES WILL TAKE EFFECT ONLY AFTER REBOOT.      │
│                                                                    │
│         Would you like to reboot now?                              │
│                                                                    │
│                                                                    │
│                  <Yes>                     <No>                    │
│                                                                    │
└────────────────────────────────────────────────────────────────────┘