Installing and Updating

First installation

1. Download the zip of the latest version available at the top of the Releases section, under the Code tab
2. Unpack the zip to a temporary location
3. Write the .img file to your SD card, for example with Win32DiskImager (on Windows)
4. Insert the SC card into your Pi

Thats it.

Updating your installation

Note: Don't remove the USB stick during the whole flash process until system is up in normal mode again!

Two methods are available:

1. Manually flash the full image, erasing your existing configuration. Not the best solution ...
2. Upgrade via USB stick, the recommended way to preserve your general system setup

Upgrade via USB stick

1. Place the downloaded zip on a USB stick (must be fat32, ext3, or ext4 formatted and min 2GB) As alternate you can place the unpacked .img and the .md5 file on the stick to save time for unpacking on the stick)
2. Power off your system
3. Plug in your stick
4. Power on
5. During startup the USB stick which is containing your zip (or .img and the .md5) will be detected
6. If flash file is a zip it will be unpacked to the USB stick
7. Now the system is preparing the flash mode and backing up default config files After finish it will reboot into flash mode
8. The system starts now to flash the sd card
9. After successfull flash the config.txt and crankshaft_env.sh will be restored to preserve display is working again if custom settings are needed for your display
10. System is rebooting again in normal mode
11. During first boot some intial setups are done including resizing your sdcard
12. After initial setup your backup is restored from USB stick
13. Now all is done and your system will boot normal with the new software version
14. The USB stick is not longer needed and can be removed

Some notes:

The system will flash every version different from current installed - there is no lock for up and downgrading. But if you switch back to older versions there is no guarantee that all will work fine.

Special info (what will be backed up during flash):

• /boot/config.txt
• /boot/crankshaft/crankshaft_env.sh
• /boot/crankshaft/gpio2kbd.cfg
• /boot/crankshaft/startup.py
• /boot/crankshaft/startup.sh
• /boot/crankshaft/triggerhappy.conf
• /boot/crankshaft/brightness
• /boot/crankshaft/brightness-night
• /boot/crankshaft/volume
• /boot/crankshaft/capvolume
• /boot/crankshaft/openauto.ini
• /boot/crankshaft/wallpaper.png
• /boot/crankshaft/wallpaper-night.png
• /boot/crankshaft/wallpaper-devmode.png
• /boot/crankshaft/wallpaper-devmode-night.png
• /etc/timezone
• /etc/X11/xorg.conf.d/99-calibration.conf
• /etc/pulse/client.conf

Flash same version again

If you have any reason to flash again same version (possible caused by demaged system) you can place a file called FORCE_FLASH on same stick like the zip (or .img and the .md5).

The flash mode will now ignore the version check and flash it.