Skip to content

Add OPi NVME install docs #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/source/docs/advanced-installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ You only need to install PhotonVision on the coprocessor/device that is being us

sw_install/index
prerelease-software
orangepi-nvme
```
67 changes: 67 additions & 0 deletions docs/source/docs/advanced-installation/orangepi-nvme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Orange Pi NVME SSD

_Time to complete: 5 minutes_

MicroSD cards are not the best storage solution for the environments FRC robots face.
In particular, they are not secured to the orange pi very well.
Teams have had the microSD card pop out during competition, disabling their vision processor.

The Orange Pi supports an M.2 SSD that can be secured with a screw.
The two supported drive sizes are _2230_ and _2242_.
The mounting hole is 3.5 mm in diameter, so an M3 or #4 bolt will fit well.
You can also use a standard PCB standoff secured with a nut through the PCB hole.

:::{note}

Installing PhotonVision onto an SSD requires a bootable image installed on your Orange Pi.

Follow the {ref}`Quick-Start <docs/quick-start/quick-install:Quick Install>` instructions for installing the latest PhotonVision image onto your Orange Pi before continuing.

:::

:::{note}

You will need access to your Orange Pi's console.
You can access the console directly by plugging in a keyboard to a USB port and connecting the Orange Pi to an external monitor through its HDMI port, or via SSH (default username is `pi`, default password is `raspberry`):

```
ssh [email protected]
```

:::

## Installing PhotonVision on an SSD

The following instructions are taken from the `ubuntu-rockchip` [wiki](https://github.com/Joshua-Riek/ubuntu-rockchip/wiki/Ubuntu-24.04-LTS#install-u-boot-to-the-spi-flash).

### 0. Install the SSD into your Orange Pi

Install the NVME SSD into the M.2 slot on the bottom of the Orange Pi.
Secure with a nut and bolt or standoff.

Reboot the Orange Pi after installing.

### 1. Install U-Boot to the SPI Flash

Booting directly from a USB or NVMe requires flashing U-Boot to the SPI, simply enter the below command:

```
pi@photonvision:~$ sudo u-boot-install-mtd
```

### 2. Install PhotonVision onto an NVMe from Linux

This will copy the installation of PhotonVision from the SD card to the SSD.
```
pi@photonvision:~$ sudo ubuntu-rockchip-install /dev/nvme0n1
```

### 3. Shutdown
```
pi@photonvision:~$ sudo shutdown -h now
```

### 4. Remove SD card and turn on

Remove the microSD card from the Orange Pi, then power it back on.
It helps to connect the orange pi to a display during boot to verify the boot sequence.
Loading