Skip to content
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
4bb9bf7
build for rubik
samfreund Oct 8, 2025
4e344d0
fake url for testing
samfreund Oct 8, 2025
73bbcb1
oops should be raw
samfreund Oct 9, 2025
a87a48d
oh boy: moment of truth
samfreund Oct 10, 2025
39d6174
switch to alt script for testing
samfreund Oct 10, 2025
a0c14c1
rerun CI
samfreund Oct 10, 2025
5504d76
set script path
samfreund Oct 10, 2025
a50e322
update script URL
samfreund Oct 10, 2025
8f5a58a
don't run on PRs
samfreund Oct 10, 2025
5b1686e
more logging in armrunner.sh
samfreund Oct 10, 2025
3357455
REVERT PRIOR TO MERGE
samfreund Oct 10, 2025
97cd224
comprehensive debugging
samfreund Oct 10, 2025
7a24567
reset URLs
samfreund Oct 10, 2025
6b0b7cf
bump image version
samfreund Oct 10, 2025
eb764b9
Discard changes to scripts/armrunner.sh
samfreund Oct 11, 2025
e925c44
Merge branch 'main' into build-rubik-image
samfreund Oct 11, 2025
6821a4d
REVERT BEFORE MERGE
samfreund Oct 12, 2025
dab898e
document flashing process
samfreund Oct 12, 2025
c9e78bc
Revert "REVERT BEFORE MERGE"
samfreund Oct 12, 2025
6500330
bump image version
samfreund Oct 12, 2025
75f9608
[docs] link to install instructions
samfreund Oct 12, 2025
fcc8308
test image build
samfreund Oct 12, 2025
25fadbb
fix docs links
samfreund Oct 12, 2025
4d1715f
remove testing bypass
samfreund Oct 12, 2025
1920cf9
add warning about user and pw
samfreund Oct 13, 2025
1d98660
warn about caching
samfreund Oct 13, 2025
af67d07
document ssh creds
samfreund Oct 13, 2025
ac2f53b
bump image version
samfreund Oct 13, 2025
4e87696
add LL4 to quick-install
samfreund Oct 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ concurrency:
cancel-in-progress: true

env:
IMAGE_VERSION: v2025.0.4
IMAGE_VERSION: v2026.0.2

jobs:

Expand Down Expand Up @@ -517,8 +517,34 @@ jobs:
with:
name: image-${{ matrix.image_suffix }}
path: photonvision*.xz
build-rubik-image:
needs: [build-package]

if: ${{ github.event_name != 'pull_request' }}

runs-on: ubuntu-24.04
name: "Build image - Rubik Pi 3"

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/download-artifact@v4
with:
name: jar-LinuxArm64
- name: Generate image
run: |
wget https://raw.githubusercontent.com/PhotonVision/photon-image-modifier/refs/tags/$IMAGE_VERSION/mount_rubikpi3.sh
chmod +x mount_rubikpi3.sh
./mount_rubikpi3.sh https://github.com/PhotonVision/photon-image-modifier/releases/download/$IMAGE_VERSION/photonvision_rubikpi3.tar.xz /tmp/build/scripts/armrunner.sh
- uses: actions/upload-artifact@v4
name: Upload image
with:
name: image-rubikpi3
path: photonvision*.xz
release:
needs: [build-photonlib-vendorjson, build-package, build-image, combine]
needs: [build-photonlib-vendorjson, build-package, build-image, build-rubik-image, combine]
runs-on: ubuntu-22.04
steps:
# Download all fat JARs
Expand Down
26 changes: 17 additions & 9 deletions docs/source/docs/quick-start/quick-install.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Quick Install
# Quick Installation Guide

## Install the latest image of photonvision for your coprocessor

- For the supported coprocessors
- RPi 3,4,5
- Orange Pi 5, 5B, 5 Pro
- Limelight 2, 2+, 3, 3G
- For the following supported coprocessors
- {ref}`Raspberry Pi 3,4,5 <docs/quick-start/quick-install:Raspberry Pi and Orange Pi Installation>`
- {ref}`Orange Pi 5, 5B, 5 Pro <docs/quick-start/quick-install:Raspberry Pi and Orange Pi Installation>`
- {ref}`Limelight 2, 2+, 3, 3G <docs/quick-start/quick-install:LimeLight Installation>`
- {ref}`Rubik Pi 3 <docs/quick-start/quick-install:Rubik Pi 3 Installation>`

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

Expand All @@ -20,17 +19,26 @@ For installing on non-supported devices {ref}`see here. <docs/advanced-installat
| 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 |
| 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](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.

:::{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 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.
## LimeLight Installation

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.
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.

:::{note}
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.
:::

## Rubik Pi 3 Installation

To flash the Rubik Pi 3 coprocessor, it's necessary to use the [Qualcomm 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.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.
Loading