Skip to content

Commit 56002a0

Browse files
committed
document flashing process
1 parent 6821a4d commit 56002a0

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/source/docs/quick-start/quick-install.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# Quick Install
1+
# Quick Installation Guide
22

3-
## Install the latest image of photonvision for your coprocessor
4-
5-
- For the supported coprocessors
3+
- For the following supported coprocessors
64
- RPi 3,4,5
75
- Orange Pi 5, 5B, 5 Pro
86
- Limelight 2, 2+, 3, 3G
7+
- Rubik Pi 3
98

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

@@ -20,17 +19,26 @@ For installing on non-supported devices {ref}`see here. <docs/advanced-installat
2019
| Limelight 2 | photonvision-{version}-linuxarm64_limelight2.img.xz | photonvision-{version}-linuxarm64.jar |
2120
| Limelight 3 | photonvision-{version}-linuxarm64_limelight3.img.xz | photonvision-{version}-linuxarm64.jar |
2221
| Limelight 3G | photonvision-{version}-linuxarm64_limelight3G.img.xz | photonvision-{version}-linuxarm64.jar |
22+
| Rubik Pi 3 | photonvision-{version}-linuxarm64_rubikpi3.tar.xz | photonvision-{version}-linuxarm64.jar |
23+
24+
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.
25+
26+
## Raspberry Pi and Orange Pi Installation
2327

2428
Use the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) to flash the image onto the coprocessors microSD card. Select the downloaded `.img.xz` file, select your microSD card, and flash.
2529

2630
:::{warning}
2731
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.
2832
:::
2933

30-
Limelights have a different installation processes. Simply connect the limelight to your computer using the proper usb cable. Select the compute module. If it doesn’t 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.
34+
## LimeLight Installation
3135

32-
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.
36+
Limelights have a different installation processes. Simply connect the limelight to your computer using the proper usb cable. Select the compute module in the [Raspberry Pi Imager](https://www.raspberrypi.com/software/). If it doesn’t 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.
3337

3438
:::{note}
3539
Limelight 2, 2+, and 3 will need a [custom hardware config file](https://github.com/PhotonVision/photonvision/tree/main/docs/source/docs/advanced-installation/sw_install/files) for lighting to work.
3640
:::
41+
42+
## Rubik Pi 3 Installation
43+
44+
To flash the Rubik Pi 3 coprocessor, it's necessary to download the [Qualcomm:r: Launcher](https://softwarecenter.qualcomm.com/catalog/item/Qualcomm_Launcher). Upload a custom image by selecting the *Custom* option in the launcher. Choose the downloaded PhotonVision `.tar.gz` file and follow the prompts to complete the installation. It is recommended to skip the additional configuration, as PhotonVision will handle the necessary settings.

0 commit comments

Comments
 (0)