pikvm/docs/flashing_os.md

Flashing the OS image

!!! warning "Micro-SD Card Requirements" * Minimum 16 Gb * Class 10 is strongly recommended

Download the image

Download the appropriate SD card image. Select it based on the board, platform, and the video capture device you are using:

• PiKVM V4
  • PiKVM V4 Mini _{- sha1}
  • PiKVM V4 Plus _{- sha1}
• PiKVM V3
  • PiKVM V3 HAT BOX Image (Raspberry Pi 4) OLED/FAN preactivated _{- sha1}
  • PiKVM V3 HAT DIY Assembly (Raspberry Pi 4) _{- sha1}
• DIY - Raspberry Pi 4, V2 platform:
  • For HDMI-CSI bridge _{- sha1}
  • For HDMI-USB dongle _{- sha1}
• DIY - Raspberry Pi Zero 2 W, V2 platform:
  • For HDMI-CSI bridge _{- sha1}
• DIY - Raspberry Pi Zero W (legacy), V2 platform:
  • For HDMI-CSI bridge _{- sha1}

Pre-compiled images are only available for the Raspberry Pi 4 and Zero (2) W. For all other cases, you will need to build the operating system yourself. But don't worry, it's very simple.

Flash the image

!!! tip Ignore request to format your sd card, this step is not nessessary. Choose the most suitable method for you

Using Linux CLI

Decompress and flash the image. Be careful when choosing the device path, it may be different on your OS:

# xz --decompress v2-hdmi-rpi4-latest.img.xz
# dd if=v2-hdmi-rpi4-latest.img of=/dev/mmcblkX

You can also use dd_rescue or ddrescue.

!!! warning "Check the advanced settings (CTRL+SHIFT+X), make sure they are blank or the flash will fail"

Using RPi Imager (Linux, MacOS and Windows)

1. Download and install the latest version of RPi Imager.

2. Run RPi Imager:

   

3. Press CHOOSE OS and select Use custom image at bottom of the list:

   

4. After clicking on this item, select the image file (.img.xz), then click CHOOSE STORAGE:

   

5. Insert the memory card into the card reader. Choose the card reader from this list. Be careful and choose the right device:

   

6. After choosing the memory card, press the WRITE button. Confirm the operation when you are asked about it:

   

7. Wait for the process to finish. Get yourself a coffee or do some stretching :)

   !!! tip The process may hang at 99% for a long time, this is okay, just wait for it to complete

   

8. Remove the memory card after successful completion:

   

   !!! tip If an error occurs during flashing or booting PiKVM, repeat the process.

!!! warning "If you encounter errors after flashing, reflash or use a different SD card."

When you have completed these steps, please move to the First Steps doc.