Instructions

Firmware installation steps

• Boot and login to the device.
• Extract the firmware archive IMAGO_FirmwareUpdate_….zip onto the filesystem.
• Install the desired firmware by running the update tool:
  • Windows: start the batch file FirmwareUpdate.cmd
  • Linux: start the shell script FirmwareUpdate.sh
• Shut down the device and reapply power to load the new firmware.

Note

For Linux, the executable flags for the shell script have to be set, or the script must be started with the shell interpreter:

unzip IMAGO_FirmwareUpdate*.zip
IMAGO_FirmwareUpdate/FirmwareUpdate.sh

Update tool

Interactive mode

If no command line arguments are given by the user, the update tool will start in interactive mode. The program will list all available hardware components with the installed firmware versions and also available firmware updates. The program then waits for user commands:

user@VisionBox:~# IMAGO_FirmwareUpdate/FirmwareUpdate.sh
IMAGO Firmware Update (Mar 21 2022)
 
Scanning for hardware...
 
Hardware component:       VisionBox LE MANS
System Identifier:        Mainboard.0
Firmware installed:       1.0.0.58 (RTCC)
Firmware available: [1] * 'LeMans.rpd': 1.0.0.66
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.0
Firmware installed:       1.0.0.18 (CL Full)
Firmware available: [2]   'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
                    [3]   'PCIe_CL_Full.rpd': 1.0.0.18 (CL Full)
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.1
Firmware installed:       1.0.0.16 (CL Dual Base)
Firmware available: [4] * 'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
                    [5]   'PCIe_CL_Full.rpd': 1.0.0.18 (CL Full)
 
New firmware versions are marked with '*'
 
Please enter a command:
 
1 ... 5: Install firmware [1] ... [5]
a      : Update components using firmware marked with *
q      : Quit
 
===>

The desired firmware can be installed by entering the label numbers for the selected component.

With the command 'a', all available firmware updates with newer versions than installed are applied automatically (marked with '*'):

===> a
 
Installing firmware update for system 'Mainboard.0'
Hardware component:   VisionBox LE MANS
Firmware version:     'LeMans.rpd': 1.0.0.66
Starting update using the file 'LeMans.rpd', do not interrupt...
 
Installing firmware update for system 'CameraLink.1'
Hardware component:   PCIe Camera Link
Firmware version:     'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
Starting update using the file 'PCIe_CL_Base.rpd', do not interrupt...
 
Please shutdown and reapply power to use the installed firmware.

Command line mode

The following command line options are available:

• -h, --help
  Show help and exit.
• -l, --list
  List installed firmware versions.
• -u, --updates
  List installed firmware versions and available updates.
• -i, --install
  Install firmware.
  If the option -s is not used, the newest available updates will be installed automatically to all comomponents. Nothing will be installed for components which are up-to-date.

Additional options:

• -s SYSTEM_ID
  Execute the command only on components which start with the specified System Identifier string (complete or partial string match). The System Identifier consists of the system type and and index. Use -l to show available System Identifiers for the hardware.
• -f FIRMWARE
  Used with -i and -s to update a component using the specified firmware file. Wihtout -f, the newest available update will be used.
• --simulate
  Simulated run, do not install any firmware.

Example: Show installed firmware versions and available updates

user@VisionBox:~# IMAGO_FirmwareUpdate/FirmwareUpdate.sh -u
IMAGO Firmware Update (Mar 21 2022)
 
Scanning for hardware...
 
Hardware component:       VisionBox LE MANS
System Identifier:        Mainboard.0
Firmware installed:       1.0.0.58 (RTCC)
Firmware available:     * 'LeMans.rpd': 1.0.0.66
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.0
Firmware installed:       1.0.0.18 (CL Full)
Firmware available:       'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
                          'PCIe_CL_Full.rpd': 1.0.0.18 (CL Full)
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.1
Firmware installed:       1.0.0.16 (CL Dual Base)
Firmware available:     * 'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
                          'PCIe_CL_Full.rpd': 1.0.0.18 (CL Full)
 
New firmware versions are marked with '*'
 
user@VisionBox:~#

Example: Show installed firmware version for the mainboard component

user@VisionBox:~# IMAGO_FirmwareUpdate/FirmwareUpdate.sh -l -s Mainboard.0
IMAGO Firmware Update (Mar 21 2022)
 
Scanning for hardware...
 
Hardware component:       VisionBox LE MANS
System Identifier:        Mainboard.0
Firmware installed:       1.0.0.58 (RTCC)
 
user@VisionBox:~#

Example: Install firmware file 'PCIe_CL_Base.rpd' on all CameraLink devices

user@VisionBox:~# IMAGO_FirmwareUpdate/FirmwareUpdate.sh -i -s CameraLink -f PCIe_CL_Base.rpd
IMAGO Firmware Update (Mar 21 2022)
 
Scanning for hardware...
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.0
Firmware installed:       1.0.0.18 (CL Full)
 
Hardware component:       PCIe Camera Link
System Identifier:        CameraLink.1
Firmware installed:       1.0.0.16 (CL Dual Base)
 
 
Installing firmware update for system 'CameraLink.0'
Hardware component:   PCIe Camera Link
Firmware version:     'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
Starting update using the file 'PCIe_CL_Base.rpd', do not interrupt...
 
Installing firmware update for system 'CameraLink.1'
Hardware component:   PCIe Camera Link
Firmware version:     'PCIe_CL_Base.rpd': 1.0.0.18 (CL Dual Base)
Starting update using the file 'PCIe_CL_Base.rpd', do not interrupt...
 
Please shutdown and reapply power to use the installed firmware.
 
user@VisionBox:~#