Files
PhotonVision/docs/source/docs/quick-start/quick-install.md
Gold856 1798b67dd3 Recommend Raspberry Pi Imager over Balena Etcher (#1858)
## Description

Balena Etcher has historically had issues like bootlooping. Recommend
Raspberry Pi Imager instead and warn about using Balena Etcher.
Closes #1856.

## Meta

Merge checklist:
- [x] Pull Request title is [short, imperative
summary](https://cbea.ms/git-commit/) of proposed changes
- [x] The description documents the _what_ and _why_
- [ ] If this PR changes behavior or adds a feature, user documentation
is updated
- [ ] If this PR touches photon-serde, all messages have been
regenerated and hashes have not changed unexpectedly
- [ ] If this PR touches configuration, this is backwards compatible
with settings back to v2024.3.1
- [ ] If this PR addresses a bug, a regression test for it is added
2025-04-08 12:48:18 -07:00

2.3 KiB
Raw Blame History

Quick Install

Install the latest image of photonvision for your coprocessor

  • For the supported coprocessors
    • RPI 3,4,5
    • Orange Pi 5
    • Limelight

For installing on non-supported devices {ref}see. <docs/advanced-installation/sw_install/index:Software Installation>

Download the latest preconfigured image of photonvision for your coprocessor

Coprocessor Image filename Jar
OrangePi 5 photonvision-{version}-linuxarm64_orangepi5.img.xz photonvision-{version}-linuxarm64.jar
Raspberry Pi 3, 4, 5 photonvision-{version}-linuxarm64_RaspberryPi.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

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} Balena Etcher can also be used, but historically has had issues such as bootlooping (the system will repeatedly boot and restart) when imaging your device. Use at your own risk. :::

Limelights have a different installation processes. Simply connect the limelight to your computer using the proper usb cable. Select the compute module. If it doesnt show up after 30s try using another USB port, initialization may take a while. If prompted, install the recommended missing drivers. Select the image, and flash.

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.

:::{note} Limelight 2, 2+, and 3 will need a custom hardware config file for lighting to work. Currently only limelight 2 and 2+ files are available. :::