rov-autonomy/widgets/README.md

39 lines
1.5 KiB
Markdown

# Argonaut 3 — Cockpit DIY Widgets
## How to install a widget
1. Open Cockpit in your browser
2. Enter edit mode (pencil icon, top right)
3. Click **Add Widget** at the bottom of the screen
4. Scroll right to find the `</>` DIY widget — drag it onto the view
5. Click the **gear icon** on the widget to open the editor
6. Click **Import** and select the `.html` file for the widget you want
7. The widget will load immediately
## Widget index
| File | Widget | Notes |
|---|---|---|
| w0_data_lake_inspector.html | Data Lake Inspector | Diagnostic — shows all data lake variables. Not production. |
| w1_system_health_indicator.html | System Health Indicator | Traffic light GREEN/AMBER/RED. Reads rov_failsafe from data lake. |
| w2_mission_status.html | Mission Status | Progress bar + state. Reads rov_mission_state and rov_mission_progress. |
| w3_abort_button.html | Abort Button | Confirm dialog → POST /abort to FastAPI. Edit FASTAPI_HOST before use. |
| w4_mission_setup_button.html | Mission Setup Button | Opens setup page in new tab. Edit SETUP_URL before use. |
| w5_battery_return_budget.html | Return Budget | Headroom warning. Reads SYS_STATUS/battery_remaining (native) + rov_return_budget. |
## Config values to edit before field use
In `w3_abort_button.html`:
```
const FASTAPI_HOST = 'http://blueos.local:8081';
```
In `w4_mission_setup_button.html`:
```
const SETUP_URL = 'http://blueos.local:8081/setup';
```
Both values are correct for real hardware. For dev VM, use the VM's Tailscale IP instead of `blueos.local`.