Recovery package

New Linux releases for the VisionSensor are provided as recovery packages. A recovery package is a ZIP file which contains the Linux image (tar.gz) and scripts for installing images and for creating backup images.

Recovery package contents
File	Description
`helpers/∗`	Files required by the installation scripts.
`html/∗`	This document, the most recent release is also available online
`∗.tar.gz`	Linux image: compressed tarball containing the root filesystem.
`∗-elbe-report.txt`	Report file generated by the ELBE build system
`∗-license.txt`	Licenses of installed packages within the Linux image
`Remote_OS_Backup.cmd`, `Remote_OS_Backup.sh`	Batch file / shell script for PC: Backup the filesystem of a remote device over Ethernet / ssh.
`Remote_OS_Install.cmd, Remote_OS_Install.sh`	Batch file / shell script for PC: Install the Linux image on a remote device over Ethernet / ssh.
`MAKE_SD.cmd, MAKE_SD.sh`	Batch file / shell script for PC: Install the Linux image on a µSD card by using a card reader.

The recovery packages and tar.gz images provided by IMAGO have a unique version number which is part of the file name.

Example:

Recovery package	:	`Linux_Recovery_deb10_vspv_v1.2_a.zip`
Image file	:	`deb10_vspv_v1.2_a.tar.gz`

`deb10`	→	OS: Debian 10
`vspv`	→	Target device: VisionSensor PV, `vspv3` is used for the VisionSensor PV3
`v1.2`	→	Image version (see page Release Notes)
`a`	→	Image configuration (see page Image configurations)

Note: New Linux releases can be found at the IMAGO Download Portal (register here).

Backup and recovery instructions

Warning

Do not remove power during backup and recovery process.
All existing data will be lost during image recovery, except for hidden files and directories under the root directory (e.g. /.my_data).

Note

The backup and recovery scripts currently support the partition layout described in section Mass storage devices. Additional devices and partitions will not be included in the backup or restored during recovery.
The Linux root partition /dev/mmcblk0p2 must have enough free disk space to store the Linux image during backup and recovery.
Avoid using a DHCP assigned IP address as target device for remote backup. The IP address may change after reboot and the download of the image may fail. Instead, use the mDNS hostname <serial number>.local, e.g. VSPV2209103853.local.
The backup process stores all file system contents including data and configuration files in the image (for example a static IP address setting).
The bootloader and the FPGA firmware will automatically be updated to the version contained in the image during recovery.
If the root filesystem is mounted in read-only mode, the scripts will remount the partition for writing.

The following sections describe provided methods for backup and recovery.

Backup and recovery scripts

Remote backup and recovery over Ethernet

First, extract the recovery package (ZIP file) on a Linux or Windows host. The package contains the Linux image and it provides backup and recovery scripts for Linux hosts (*.sh) and for Windows hosts (*.cmd).

For Linux hosts, the executable flags for the scripts must be set after extracting the ZIP file:

unzip Linux_Recovery_*.zip
cd Linux_Recovery_*
chmod +x *.sh

Remote_OS_Backup.cmd / Remote_OS_Backup.sh: Creates a backup of the filesystem by using ssh / scp. The created Linux image will be downloaded automatically. It can then be used with the install scripts to restore the filesystem.

Remote_OS_Install.cmd / Remote_OS_Install.sh: Installs a Linux image on a remote device by using using ssh / scp. The image provided with the recovery package, or images created during backup can be used.

The scripts can be controlled interactively, just execute the file and follow the instructions. They can also be controlled using command line parameters. Use the parameter -h for help:

~# ./Remote_OS_Install.sh -h
This script updates the Linux file system on a running device over Ethernet.
 
The image file (*.tar.gz) will be copied and extracted to the file system.
 
Usage: Remote_OS_Install.sh [options] [device_address] [image_file]
 
OPTIONS:
 -h     Show this help and exit
 -i     Skip checking the image for hardware compatibility
 -o     Set Ext4 journaling mode to data=ordered
        (data=journal is used by default)
 -y     Don't ask for confirmation
 
EXAMPLE:
./Remote_OS_Install.sh 192.168.2.3 backup.tar.gz

µSD card preparation using a card reader

The script / batch file MAKE_SD.sh / MAKE_SD.cmd prepares a µSD card by using a host with a memory card reader. The script creates a FAT boot partition (/dev/mmcblk0p1) and copies the image and a RAM disk containing a minimal Linux environment to the card. After starting the VisionSensor with this card, the Linux partition will be created (/dev/mmcblk0p2) and the root filesystem image gets extracted. The device will then reboot automatically into the installed system.

Warning: Make sure to enter the correct target disk and device identifier for the memory card reader. Selecting the wrong device may destroy data on other disks!

Note: The size of the first FAT partition may be larger than on delivered devices because the image has to fit on this partition.

VIBFinder 2

The VIBFinder 2 tool also supports backup and recovery. The recovery package is only required to obtain the provided Linux image for recovery.

VIBFinder 2: Backup and Recovery Wizard