Skip to main content
How Can We Help?
< Back

go-modules

The GOcontroll Moduline modular controllers can be configured with up to eight modules that add extra input, output or communication functionality. The firmware on these modules is managed with the go-modules tool, which is installed on the controller by default.

To use the command line interface, a wired ethernet and/or Wi-Fi connection is mandatory.

Command:

go-modules

Typical output:

go-modules 3.2.0 main menu in a terminal, listing the actions scan, update, overwrite and check, with scan highlighted and the hint navigate, Enter select, Esc quit

The menu offers four actions: scan, update, overwrite and check. Use the arrow keys to move, Enter to select and Esc to close the tool. In a submenu, Esc or the left arrow takes you back one step.

Note: while go-modules runs it stops the nodered, go-simulink and go-hardware-driver services, because it needs exclusive access to the SPI bus. It starts them again when it exits.

Scan

Scan reports the modules that are installed in the controller.

go-modules scan result table listing slot 1 with a 6 Channel Output module on software 2.2.0, slot 2 with a 6 Channel Input module on 2.0.3 and slot 4 with a 10 Channel Output module on 1.0.0; the Update column is empty because every module runs the latest firmware

Every row shows the slot, the module type, the hardware version and the installed software version. The Update column stays empty while a module runs the newest firmware that is present on the controller.

go-modules scan result table where slot 1 runs software 2.1.0 and the Update column shows an arrow to 2.2.0, indicating newer firmware is available locally for that module

When a newer version is available, the Update column shows the version that update will install.

Check

Check downloads the latest module firmware from the GOcontroll cloud to the controller, and verifies every file against the checksum that is published with it.

go-modules check result listing the latest firmware per module and hardware version from the GOcontroll cloud, each line ending in up to date, with the manifest date in the header

The list shows the newest version per module type and hardware version. up to date means the file is already on the controller, so nothing is downloaded.

Add the verbose option to also show the release date and the changelog of every version:

go-modules check --verbose
go-modules check output with the verbose option, showing for each module the latest firmware version plus its release date and changelog entry

Update

Update installs newer firmware on the modules. It only uses firmware that is already on the controller, so run check first. Update can NOT install an older version.

go-modules update submenu offering the choices all and one, with the hint that left arrow or Esc goes back

You can update every module at once, or pick a single module.

go-modules module selection list showing slot 1 6 Channel Output module version 6 software 2.2.0, slot 2 6 Channel Input module version 6 software 2.0.3, and slot 4 10 Channel Output module version 5 software 1.0.0

Note: all starts the upload to every module in parallel, over the same SPI bus. Updating one slot at a time keeps the process easier to follow and easier to trace when a module fails.

go-modules update 1
go-modules uploading firmware to slot 1, showing the line updating slot 1 from 20-20-2-6-2-1-0 to 20-20-2-6-2-2-0 and a progress bar with a counter and the message Uploading firmware to slot 1

When the upload has finished, the tool reports the result:

go-modules update result screen with the message Successfully updated slot 1 to 20-20-2-6-2-2-0

Overwrite

Overwrite installs the firmware version that you select yourself. Use it when you need to install an older version, for example to roll a module back.

go-modules overwrite screen asking which slot to overwrite, listing the modules in slots 1, 2 and 4 with their type and firmware version

Only firmware files that match the hardware version of the selected module are offered.

go-modules overwrite screen asking which firmware file to upload, offering the matching file for the selected module; only firmware whose hardware identifier matches the module is listed

Running go-modules from a script

Every action is also available as a command. The tool then performs that one action and exits, so it can be used from a script or a service.

go-modules scan
go-modules scan run as a single command, printing the module table and exiting immediately without the interactive back hint

Command reference

  • go-modules – starts the interactive menu.
  • go-modules scan – lists the modules that are installed in the controller.
  • go-modules check – downloads the latest firmware from the GOcontroll cloud. It runs without module hardware, so it also works on a controller with empty slots.
  • go-modules check --verbose – same, and also shows the release date and changelog. -v is accepted as well.
  • go-modules update all – updates every module.
  • go-modules update <slot> – updates the module in one slot.
  • go-modules overwrite <slot> <firmware> – installs a specific firmware file, for example go-modules overwrite 1 20-20-2-6-2-2-0.srec.

The tool reports its result with an exit code:

  • 0 – the action finished, or the menu was closed.
  • 1 – check could not reach the firmware manifest.
  • 255 – the controller is not supported, or an unknown command was given.

Note: go-modules has no help option. An unknown argument, including --help, prints the usage text as an error and exits with code 255. It does so only after it has stopped the nodered, go-simulink and go-hardware-driver services and rescanned the modules, so it is not a harmless command to try.

Also see identify to check which modules and firmware versions a controller reports, and systemd services to manage the services that go-modules stops while it runs.