mirror of
https://github.com/legop3/MultiRoombaRover.git
synced 2026-09-15 17:12:59 -04:00
88 lines
5.1 KiB
Markdown
88 lines
5.1 KiB
Markdown
# Multi Roomba Rover
|
||
|
||
a remake of my RoombaRover project with a decentralized and embedded approach
|
||
supports multiple roombas
|
||
|
||
on each roomba:
|
||
- a raspberry pi zero 2 w
|
||
- a raspberry pi camera
|
||
- roomba's serial port hooked up to the built in serial port on the raspberry pi
|
||
|
||
pi provisioning:
|
||
- enable serial port
|
||
- disable wifi powersave
|
||
- disable bluetooth
|
||
|
||
## Repo layout
|
||
|
||
- `pi/roverd`: tiny Go daemon that bridges the Create 2 serial port, BRC pin, and the control server via WebSockets.
|
||
- `server`: Node.js process that terminates rover sockets, relays commands to/from the Socket.IO UI, and serves `public/`.
|
||
- `pi/bin` / `pi/systemd`: helper scripts + systemd units for the rover (roverd itself plus the SRT video publisher that streams camera feeds to the server).
|
||
- `docs/pi-deployment.md`: per-rover build + install instructions (cross-compiling on Fedora 43, deploying roverd + mediaMTX).
|
||
|
||
## Quick start
|
||
|
||
```bash
|
||
# build the Pi agent (armv7)
|
||
cd pi/roverd
|
||
mkdir -p ../../dist
|
||
make pi-build
|
||
|
||
# start the server + UI
|
||
cd ../../server
|
||
npm install
|
||
npm run start
|
||
```
|
||
|
||
Need a fake rover or multi-rover testing without hardware? Use the dummy build:
|
||
|
||
```bash
|
||
cd pi/roverd
|
||
mkdir -p ../../dist
|
||
make dummy
|
||
./../../dist/roverd-dummy -config ./roverd.sample.yaml
|
||
```
|
||
|
||
The dummy binary connects to the Node server, emits simulated sensor frames, and logs every command it receives, so you can spin up as many virtual rovers as you’d like on your dev machine.
|
||
|
||
## Admin config & authentication
|
||
|
||
Before running the Node server, copy `server/config.example.yaml` to `server/config.yaml` and customize the admin records (password hashes, Discord IDs, lockdown permission). Those credentials are used by the driver UI’s login panel—only admins can toggle locks/modes, and lockdown admins retain access when the system enters lockdown mode. The spectator page (future) can set `role:set` to `spectator`, and the server enforces all permissions server-side so client tweaks can’t grant extra control.
|
||
|
||
Deploy a rover by copying the repo + `dist/roverd` to the Pi and running the helper (it installs roverd plus the SRT video publisher service):
|
||
|
||
```bash
|
||
cd ~/MultiRoombaRover
|
||
sudo ./pi/install_roverd.sh
|
||
```
|
||
|
||
Then point each rover's `/etc/roverd.yaml` at `ws://<server>:8080/rover`, set `name` to the rover’s ID, and (optionally) override `media.publishUrl` if your control server isn’t `192.168.0.86`. The video publisher service (`video-publisher.service`) captures the Pi camera with `rpicam-vid`/`libcamera-vid`, pipes the raw H264 into the stock FFmpeg binary, and publishes via SRT to the server’s mediaMTX instance at `srt://<server>:9000?streamid=#!::r=<name>,m=publish`. The installer now just pulls `libcamera-apps` + `ffmpeg` from apt (no custom build). Use the “Restart Camera” button if you enable media management so roverd can bounce the publisher service remotely.
|
||
Heads-up: the BRC pulser now uses libgpiod; make sure the `roverd` service account is in the `gpio` group (or otherwise allowed to access `/dev/gpiochip*`) and set `brc.gpioChip` if your hardware exposes a different chip name.
|
||
|
||
## Fedora server deployment
|
||
|
||
Run the installer from inside the `server/` directory after cloning the repo onto your Fedora 43 Server box:
|
||
|
||
```bash
|
||
cd ~/MultiRoombaRover/server
|
||
sudo ./install_server.sh
|
||
```
|
||
|
||
The script must be executed via `sudo` from the user that owns the repo. It will:
|
||
|
||
- install Node.js/npm plus curl/tar
|
||
- run `npm install --production`
|
||
- copy `config.example.yaml` to `config.yaml` if needed (edit the file afterwards for admins + `media.whepBaseUrl`)
|
||
- download mediaMTX v1.15.3 and drop it into `/usr/local/bin`
|
||
- write `/etc/mediamtx/mediamtx.yml` from `server/mediamtx/mediamtx.yml` (SRT ingest on :9000, wildcard `rover-*` paths, auth webhook at `/mediamtx/auth`)
|
||
- create + enable `mediamtx.service` and `multirover.service`, both running as your repo user and pointing at the clone directly
|
||
|
||
Publishing rovers lives on a trusted network, so the shipped config (tracked at `server/mediamtx/mediamtx.yml`) skips HTTP auth for SRT ingest and whitelists any path that matches `rover-*`. The installer overwrites `/etc/mediamtx/mediamtx.yml` every time you run it—if you need to tweak ports or add TURN servers, edit the template in the repo and rerun `install_server.sh` so every box stays in sync automatically.
|
||
|
||
Once finished, update `server/config.yaml` with your admin passwords and `media.whepBaseUrl` (`http://192.168.0.86:8889/whep`). Restart `multirover.service` whenever you edit the config. To pull updates later, just `git pull`, re-run `npm install --production` inside `server/`, and restart the service—no need to rerun the installer.
|
||
|
||
### Video handshake + diagnostics
|
||
|
||
- Every `video:request` returns `{ url, token }`. The browser posts the SDP offer to `url` and includes `Authorization: Bearer <token>`. mediaMTX forwards the token to `/mediamtx/auth`, which checks the socket’s permissions and either returns 200 or 401—no query parameters are involved anymore.
|
||
- To see what mediaMTX is ingesting from the Pis, run `npm run check:media` (or `node scripts/checkMedia.js`). It hits `/v3/paths/list` and prints each rover’s `ready` state and byte counters so you can instantly spot publish issues.
|