mirror of
https://github.com/legop3/MultiRoombaRover.git
synced 2026-11-17 04:02:21 -05:00
installer / updates
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Rover hardware configuration notes
|
||||
|
||||
This document records hardware-specific requirements while the roverd rework is in progress. Media profiles and shared audio routing are implemented. The standalone bootstrap remains unfinished; current installation uses a checkout. Configuration selections are recorded below.
|
||||
This document records hardware-specific requirements while the roverd rework is in progress. Media profiles and shared audio routing are implemented. The standalone bootstrap creates the managed checkout and invokes the shared installer. Configuration selections are recorded below.
|
||||
|
||||
## Universal configuration requirements
|
||||
|
||||
@@ -16,7 +16,7 @@ Roverd configuration selects one physical input device and one physical output d
|
||||
|
||||
The microphone streamer uses the selected input. TTS, horn, and forwarded audio share the selected output while retaining simultaneous playback and separate volume controls. Profiles use the generated logical devices supplied through their environment; they do not each hardcode or independently select physical audio hardware. Use ALSA conversion where supported instead of requiring all devices to accept the existing HAT playback format.
|
||||
|
||||
AIY setup enables its hardware and uses this same routing system. The bootstrap still asks only for rover name and server address. Audio routing is implemented; the standalone bootstrap remains planned.
|
||||
AIY setup enables its hardware and uses this same routing system. The bootstrap still asks only for rover name and server address. Audio routing and the standalone bootstrap are implemented; hardware verification remains pending.
|
||||
|
||||
## Historical AIY Voice HAT setup
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# Rover installation and updates
|
||||
|
||||
Download `rover/bootstrap.sh` from the repository onto a Debian-based rover, then run `sudo bash bootstrap.sh`. No preexisting checkout is required. Enter the rover name and full server address, for example `ws://server:8080/rover` or `wss://example.org/rover`.
|
||||
|
||||
Bootstrap installs prerequisites, clones into `/opt/roverd`, invokes `rover/install_roverd.sh`, and starts the root roverd service. The checkout is root-owned and dedicated to installation and updates; keep development changes elsewhere. Rerunning bootstrap preserves an existing configuration rather than replacing its identity with the prompt answers.
|
||||
|
||||
The shared installer selects AMD64, ARM64, or ARMv6/ARMv7 for a 32-bit ARM OS. A Pi Zero 2 W uses ARM64 on a 64-bit OS and ARMv7 on a 32-bit OS. Binaries come from `dist/` in the repository; no release publishing or on-rover compilation is required.
|
||||
|
||||
Fleet Management configures the remaining settings. Media and native GPIO start disabled. Profiles are already in the checkout; selecting one causes its inline setup to run on roverd startup. See [media profiles](rover-media-profiles.md) and [AIY hardware settings](rover-hardware-config.md).
|
||||
|
||||
## Updates
|
||||
|
||||
The management update action launches `roverd-self-update` as an independent transient systemd service. It fast-forwards the registered checkout, invokes the same installer, and restarts only roverd. A modified/diverged checkout can make Git refuse the update; it is not forcibly reset.
|
||||
|
||||
The installer preserves `/etc/roverd.json`, `/etc/roverd/profiles/`, and `/var/lib/roverd/`. Replacing the installed executable and updater uses rename so running processes retain their existing executable/script. Update progress and the last result are atomically written to `/var/lib/roverd/update-status.json`, forwarded through management, and shown in Fleet Management after reconnecting. This reports completion of installation/service restart, not camera or audio health.
|
||||
|
||||
For detailed command output use `journalctl -u roverd-self-update`; for daemon startup use `journalctl -u roverd`. Failed update jobs report failure and release the old daemon's pending management action if it is still running. There is no rollback system. If installation fails after changing files, fix the reported error and rerun the installer/update.
|
||||
|
||||
## Deployment checks still required
|
||||
|
||||
On a fresh rover, run bootstrap and confirm management connects with the supplied identity. Select the hardware profiles and verify their output. Trigger an update and confirm progress, reconnection, final status, and preservation of JSON/custom profiles. Confirm a failed update reports its error and allows another management action. These host/systemd/network flows have not been executed on the development machine.
|
||||
@@ -72,7 +72,7 @@ Record acknowledgement errors, reconnect hello contents, relevant journal/server
|
||||
|
||||
## Pending stages
|
||||
|
||||
YAML media catalogs, child supervision, shared ALSA routing, and Fleet Management profile controls are implemented. Browser/live verification of configuration, operational state, media, and audio remains pending. Standalone bootstrap and the replacement update workflow are the next implementation stage.
|
||||
YAML media catalogs, child supervision, shared ALSA routing, and Fleet Management profile controls are implemented. Browser/live verification of configuration, operational state, media, and audio remains pending. Standalone bootstrap and shared self-update are implemented; host verification remains pending. See [installation and updates](roverd-installation.md). Update status is included as `updateStatus` in hello and sent as `{type: "updateStatus", status: {state, message, timestamp}}` when it changes.
|
||||
|
||||
Apply-field targets the currently management-connected fleet. It clones each rover’s own configuration, replaces an existing field, and sends the complete object for rover-side validation. Inspect individual results for failures. Missing fields and changed connections are reported; offline changes are not queued. Paths traverse object fields, not array elements. Array-valued fields can be replaced as a whole.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Roverd rework plan and implementation tracker
|
||||
|
||||
Status: implementation authorized on 2026-11-16; repository/build, internal GPIO, JSON/management, Fleet UI, rover state, media profiles/supervision, and shared audio routing implemented; deployment verification, standalone bootstrap, and update redesign remain pending.
|
||||
Status: implementation authorized on 2026-11-16; repository/build, internal GPIO, JSON/management, Fleet UI, rover state, media profiles/supervision, and shared audio routing implemented; standalone bootstrap and shared self-update are also implemented; final cleanup/hardware audit and deployment verification remain pending.
|
||||
|
||||
This is the persistent plan and progress record for the roverd rework. Update it as implementation proceeds, recording completed work, decisions, verification evidence, and remaining work. Keep unfinished work unchecked; distinguish implemented behavior from runtime-verified behavior.
|
||||
|
||||
@@ -177,8 +177,8 @@ The order below is a working sequence, not a requirement to leave incompatible i
|
||||
- [x] Implement per-rover schema editor and complete-object saves (browser/live verification pending).
|
||||
- [x] Implement apply-one-field-to-all-connected-rovers with individual results (browser/live verification pending).
|
||||
- [x] Add profile editing/selection, media output/status, reboot, and update UI. (Live verification pending.)
|
||||
- [ ] Implement standalone bootstrap with only name/address input and automatic OS architecture selection.
|
||||
- [ ] Implement shared checkout installation and self-update with reconnect-visible results.
|
||||
- [x] Implement standalone bootstrap with only name/address input and automatic OS architecture selection. (Host verification pending.)
|
||||
- [x] Implement shared checkout installation and self-update with reconnect-visible results. (Host verification pending.)
|
||||
- [ ] Remove obsolete services, configuration files, scripts, build distinctions, and documentation.
|
||||
- [ ] Update user/contributor documentation, including profile variables, setup expectations, building, installation, and updates.
|
||||
- [ ] Perform focused available verification and record results below.
|
||||
@@ -285,3 +285,14 @@ Verification for this stage:
|
||||
- Added real CLI inspection for catalogs and generated ALSA configuration, without setup execution or hardware access.
|
||||
- Verification: all four architecture builds passed; six profiles loaded through the actual daemon and all setup/run commands passed Bash syntax checks; current sample config validation and ALSA config rendering passed; installer/TTS shell syntax and server JS syntax passed. Focused frontend lint passed including the final status-display changes. No camera/audio streaming, setup commands, host installation, or browser/server processes were run here.
|
||||
- Next: verify the remaining frontend check, then standalone bootstrap and update flow. Actual device formats, concurrent playback/gains, child cleanup and network recovery still require the documented rover-side checks.
|
||||
|
||||
|
||||
### Standalone bootstrap and shared updates (2026-11-16)
|
||||
|
||||
- Added `rover/bootstrap.sh`: prompts only for name/server WebSocket address, installs prerequisites, clones into `/opt/roverd`, invokes the shared installer, and starts roverd. Existing configuration is preserved on rerun.
|
||||
- Installer selects committed architecture binaries from OS architecture (and ARM generation for 32-bit ARM), writes initial identity only on first installation, and preserves custom profiles/data. Running binary and updater replacement use atomic rename.
|
||||
- Replaced rebooting updater with an independent systemd job using fast-forward Git pull and the same installer, followed by service restart. No releases, forced reset, migrations, or rollback machinery.
|
||||
- Latest update progress/result is persisted atomically, sent over management, cached in server memory, and displayed in Fleet Management including after reconnect. Detailed command output stays in the systemd journal.
|
||||
- Added `docs/roverd-installation.md` and updated README instructions.
|
||||
- Verification: all four committed architecture binaries rebuilt successfully; shell syntax, server syntax, focused UI lint, and diff whitespace checks passed. No installation, apt operation, host reboot/restart, or live server/browser was run on the development machine.
|
||||
- Required rover checks: fresh bootstrap identity/connectivity; successful update and reconnect-visible status; failure reporting and retry; preservation of settings/custom profiles/data. Hardware/audio checks and final universal-hardware audit remain open.
|
||||
|
||||
Reference in New Issue
Block a user