Flashing the OS image¶
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:
- V3 HAT (Patron, Kickstarter, Pre-Assembled and future editions)
- DIY - Raspberry Pi 4, v2 platform:
- DIY - Raspberry Pi Zero 2 W, v2 platform:
- DIY - Raspberry Pi Zero W (legacy), v2 platform:
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¶
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
Check the advanced settings (CTRL+SHIFT+X), make sure they are blank or the flash will fail
Using RPi Imager (Linux, MacOS and Windows)¶
Download and install the latest version of RPi Imager.
Run RPi Imager:
Press CHOOSE OS and select Use custom image at bottom of the list:
After clicking on this item, select the image file (
.img.xz), then click CHOOSE STORAGE:
Insert the memory card into the card reader. Choose the card reader from this list. Be careful and choose the right device:
After choosing the memory card, press the WRITE button. Confirm the operation when you are asked about it:
Wait for the process to finish. Get yourself a coffee or do some stretching :)
The process may hang at 99% for a long time, this is okay, just wait for it to complete
Remove the memory card after successful completion:
If an error occurs during flashing or booting PiKVM, repeat the process.
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.