Skip to content

docs/readme connection diagram #49

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.

Sign up for GitHub

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

Merged
simonvanlierde merged 2 commits into from
Oct 13, 2026
Merged

docs/readme connection diagram #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e33ef1
docs(readme): add a diagram of how the Pi connects to Relab
simonvanlierde Oct 13, 2026
41440ef
docs(readme): link the full camera diagram in the platform docs
simonvanlierde Oct 13, 2026
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,26 @@ The plugin runs a lightweight FastAPI server on a Raspberry Pi that:

Supported hardware is Raspberry Pi 5/4 with Camera Module 3/v2 on Raspberry Pi OS 64-bit.

## How It Connects

```mermaid
flowchart LR
app["Relab app<br/>(phone or browser)"]
backend["Relab backend"]
subgraph station["Raspberry Pi"]
plugin["This plugin"]
camera["Camera module"]
end

plugin == "outbound WebSocket relay<br/>(opened by the Pi)" ==> backend
app -- "capture and preview requests" --> backend
backend -. "forwarded over the relay" .-> plugin
plugin --- camera
plugin -- "captures uploaded" --> backend
```

The Pi always opens the connection, so the relay needs no open port on the Pi's network. To pair, the Pi shows a short code on its `/setup` page, and you enter that code in the Relab app. After that, the backend sends capture and preview requests down the relay, and the Pi only runs the routes it allows. The [platform docs](https://docs.r9lab.io/architecture/rpi-cam/) have the full diagram, with LAN direct mode, preview streaming and the pairing sequence. [ARCHITECTURE.md](ARCHITECTURE.md) covers the plugin's internals.

## Supported Modes

| Mode | Purpose |
Expand Down
Loading