Quick Installation Guide
For the following supported coprocessors
For installing on non-supported devices see here.
Download the latest preconfigured image of photonvision for your coprocessor
Coprocessor |
Image filename |
Jar |
|---|---|---|
Raspberry Pi 3, 4, 5 |
photonvision-{version}-linuxarm64_RaspberryPi.img.xz |
photonvision-{version}-linuxarm64.jar |
OrangePi 5 |
photonvision-{version}-linuxarm64_orangepi5.img.xz |
photonvision-{version}-linuxarm64.jar |
OrangePi 5B |
photonvision-{version}-linuxarm64_orangepi5b.img.xz |
photonvision-{version}-linuxarm64.jar |
OrangePi 5 Pro |
photonvision-{version}-linuxarm64_orangepi5pro.img.xz |
photonvision-{version}-linuxarm64.jar |
Limelight 2 |
photonvision-{version}-linuxarm64_limelight2.img.xz |
photonvision-{version}-linuxarm64.jar |
Limelight 3 |
photonvision-{version}-linuxarm64_limelight3.img.xz |
photonvision-{version}-linuxarm64.jar |
Limelight 3G |
photonvision-{version}-linuxarm64_limelight3G.img.xz |
photonvision-{version}-linuxarm64.jar |
Limelight 4 |
photonvision-{version}-linuxarm64_limelight4.img.xz |
photonvision-{version}-linuxarm64.jar |
Rubik Pi 3 |
photonvision-{version}-linuxarm64_rubikpi3.tar.xz |
photonvision-{version}-linuxarm64.jar |
Unless otherwise noted in release notes or if updating from the prior years version, to update PhotonVision after the initial installation, use the offline update option in the settings page with the downloaded jar file from the latest release.
Raspberry Pi and Orange Pi Installation
Use the Raspberry Pi Imager to flash the image onto the coprocessors microSD card. Select the downloaded .img.xz file, select your microSD card, and flash.
Warning
Avoid using Raspberry Pi Imager version 2.0.2 or later. Those versions fail to write the image to an SD card. Versions 2.0.0 and earlier write images successfully. GitHub issue 1489 was created for this problem.
Warning
Balena Etcher has been recommended in the past, but should no longer be used due to instability and lack of ongoing support from developers.
Limelight Installation
In order to flash your Limelight you should follow the instructions on the Limelight documentation for the relevant version. Make sure to replace the Limelight OS image with the relevant PhotonVision image.
Limelight Version |
Limelight Documentation |
PhotonVision Image |
|
|---|---|---|---|
2 |
photonvision-{version}-linuxarm64_limelight2.img.xz |
||
3 |
photonvision-{version}-linuxarm64_limelight3.img.xz |
||
3G |
photonvision-{version}-linuxarm64_limelight3g.img.xz |
||
4 |
photonvision-{version}-linuxarm64_limelight4.img.xz |
Note
Limelight models will need a custom hardware config file for LEDs or other hardware features to work.
Rubik Pi 3 Installation
Warning
The Qualcomm Launcher caches files. If you flash multiple times, you may need to clear the cache by navigating to your temp directory, and deleting the qualcomm-launcher folder.
To flash the Rubik Pi 3 coprocessor, it’s necessary to use the Qualcomm Launcher. Upload a custom image by selecting the Custom option in the launcher. If this is your first time flashing this board, ensure you check the USB firmware option. Choose the downloaded PhotonVision .tar.xz file and follow the prompts to complete the installation. It is recommended to skip the Configure Login process, as PhotonVision will handle the necessary settings.
Alternative Flashing Method (advanced users only)
Follow the specific steps listed below from the Rubik Pi 3 Docs.
Step 1 should be completed once per computer. Step 2 and Step 3 should be completed once per Rubik Pi 3.
After completing these steps, unzip your downloaded PhotonVision image to a folder. Navigate to that folder in your terminal or command prompt. After putting your Rubik Pi 3 into EDL mode, run the command below to flash PhotonVision. There is no need to complete any further steps from the Rubik Pi 3 documentation after running this command.
qdl --storage ufs prog_firehose_ddr.elf rawprogram*.xml patch*.xml
QDL.exe prog_firehose_ddr.elf rawprogram0.xml rawprogram1.xml rawprogram2.xml rawprogram3.xml rawprogram4.xml rawprogram5.xml rawprogram6.xml patch1.xml patch2.xml patch3.xml patch4.xml patch5.xml patch6.xml
qdl prog_firehose_ddr.elf rawprogram*.xml patch*.xml