VisionCam XM Linux  2023-11-13
Linux backup and recovery

Linux is already installed on delivery of the VisionCam. The recovery package can be used to backup or replace the existing root filesystem over Ethernet by using Linux images (tar.gz). It's also possible to prepare a µSD card with a memory card reader.

The images provided by IMAGO have a unique version number which is part of the archive file name.

Example: deb10_vcxm_v1.3_a.tar.gz

deb10 → OS: Debian 10
vcxm → Target device: VisionCam XM
v1.3 → Image version (see page Release Notes)
a → Image configuration (see page Image configurations)

Image configurations

IMAGO provides different image configurations depending on the requirements.

Configuration Description
a Basic image
  • Debian base system
  • Additional packages: openssh-server, openssh-client, ntp, snmpd, avahi-daemon, screen, mc, htop, ...
  • Software development packages: gcc, g++, gdb, make, ...
  • Packages provided by IMAGO:
    • linux-image-*-visioncam-xm-*: customized Linux kernel
    • linux-headers-*-visioncam-xm-*: Linux kernel headers
    • u-boot-visioncam-xm: Bootloader "Das U-Boot"
    • fpga-visioncam-xm: FPGA firmware
    • imago-sdk: IMAGO Linux SDK
    • imago-snmpd-update: Linux service which updates the file /etc/snmp/snmpd.conf.local to make the device discoverable by the VIBFinder tool. The service additionally sets the host name to the device's serial number during boot.
    • vcxm-init: initialization boot script
    • imago-archive-keyring: public IMAGO APT repository deb.imago.tech for online SDK updates
eb VisionCam EB image
  • Based on image configuration a
  • Metavision packages
  • Streaming server for the VisionCam EB (compatible with HAL plugins provided by IMAGO)
  • Event-Based System Web Interface

Backup and recovery instructions

Extract the recovery package on a Windows or Linux host. The included shell scripts (*.sh) and batch files (*.cmd) are controlled interactively. Just execute the file and follow the instructions.

The backup and recovery scripts currently support the following partition layout:

Partition Mount point Filesystem Description
/dev/mmcblk0p1 /boot FAT Contains required files for booting (U-Boot, Linux kernel, FPGA firmware)
/dev/mmcblk0p2 / Ext4 Root filesystem
  • Remote_OS_Backup.cmd / Remote_OS_Backup.sh:
    Backup the filesystem of a remote device by using ssh / scp. The created Linux image (tar.gz) will be downloaded automatically. It can then be used with the install script to restore the filesystem.
  • Remote_OS_Install.cmd / Remote_OS_Install.sh:
    Install the Linux image (tar.gz) on a remote device by using using ssh / scp. The existing filesystem will be replaced completely.

Please note that the executable flags for the Linux scripts have to be set after extracting the recovery ZIP file:

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

The scripts and batch files can also be controlled using command line parameters. Use the parameter -h for help:

$ ./Remote_OS_Install.sh -h
Usage: Remote_OS_Install.sh [options] [device_address] [image_file]
OPTIONS:
-h Print this help
-o Set Ext4 journaling mode to data=ordered
(data=journal is used by default)
-y Say yes to all questions
EXAMPLE:
./Remote_OS_Install.sh 192.168.2.3 backup.tar.gz
Note
  • The Linux root partition /dev/mmcblk0p2 must have enough free disk space to store the Linux image.
  • Do not remove power during backup and recovery.
  • All existing data will be lost during image recovery.
  • Avoid using a DHCP assigned IP address as target device for the backup script or batch file. The IP address may change after reboot during the backup process and the download of the image may fail. Instead, use a fixed IP address or the mDNS hostname <serial number>.local, e.g. VCXM2306000711.local.
  • The bootloader and the FPGA firmware will automatically be updated to the version contained in the image during recovery.

µSD card preparation using a card reader

The script / batch file MAKE_SD.sh / MAKE_SD.cmd is used to prepare a µSD card by using a host with a memory card reader. The mechanism 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 VisionCam 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.