diff --git a/docs_sp/settings/firehose.md b/docs_sp/settings/firehose.md new file mode 100644 index 0000000000..c98bce6511 --- /dev/null +++ b/docs_sp/settings/firehose.md @@ -0,0 +1,33 @@ +--- +title: Firehose +--- + +# Firehose + +Firehose Mode allows your device to upload the maximum amount of training data to comma's servers, helping improve openpilot's autonomous driving models. + +!!! info "First Fork with Official Support" + sunnypilot is the first and currently only major fork to receive official Firehose Mode support, after comma.ai merged it into their backend infrastructure. + +## How It Works + +When Firehose Mode is enabled, the system randomly samples a portion of your drives rather than uploading everything. It queues approximately 10 segments at a time for transmission, whether openpilot is actively engaged or not. Both engaged and disengaged driving data contributes to simulator training. + +No special driving behavior is needed. Normal driving patterns work fine. + +## Requirements + +- **Compatible branch**: You must be running one of the following branches: + - `staging`, `dev`, or `master` + - `staging-tici`, `master-tici` + - `release-tizi` or `release-tici` +- **Weekly connectivity**: Connect to Wi-Fi with a reliable USB-C power adapter at minimum once per week. +- **Supported vehicle**: Only vehicles officially supported in [upstream openpilot](https://github.com/commaai/opendbc/blob/master/docs/CARS.md) qualify for model training data collection. + +## Optional: Mobile Upload + +Devices with hotspot access or unlimited data plans can upload data while driving, removing the need for weekly Wi-Fi sessions. + +## Learn More + +For the latest information, see the [Firehose Mode announcement](https://community.sunnypilot.ai/t/firehose-mode-now-supported-on-sunnypilot/385) on the sunnypilot community forum. diff --git a/docs_sp/settings/index.md b/docs_sp/settings/index.md index e77aeb5989..350e9a5a61 100644 --- a/docs_sp/settings/index.md +++ b/docs_sp/settings/index.md @@ -4,58 +4,22 @@ title: Settings # Settings -Complete reference for every configurable option in sunnypilot. Each section corresponds to a settings panel on your device. +Complete reference for every configurable option in sunnypilot. The panels below are listed in the same order they appear on your device's settings sidebar. -## Cruise Control - -| Section | Description | -|---------|-------------| -| [Cruise Control](cruise.md) | ACC behavior, following distance, and cruise button logic | -| [Speed Limit](speed-limit.md) | Speed limit source, offset, and assist configuration | - -## Steering - -| Section | Description | -|---------|-------------| -| [Steering](steering.md) | Lateral control mode and steering parameters | -| [MADS](mads.md) | Modular Assistive Driving System toggle and behavior | -| [Lane Change](lane-change.md) | Automatic lane change settings and safety thresholds | -| [Torque](torque.md) | Torque-based lateral control tuning | - -## Display & Visuals - -| Section | Description | -|---------|-------------| -| [Display](display.md) | Onroad display layout and elements | -| [Visuals & HUD](visuals.md) | HUD overlays and visual customization | - -## Models & AI - -| Section | Description | -|---------|-------------| -| [Models & AI](models.md) | Driving model and AI configuration | - -## Device & System - -| Section | Description | -|---------|-------------| -| [Device](device.md) | Device-level settings (screen, storage, power) | -| [Software](software.md) | Update channel and branch management | -| [Developer](developer.md) | Developer and debug options | - -## Connected Services - -| Section | Description | -|---------|-------------| +| Panel | Description | +|-------|-------------| +| [Device](device.md) | Device-level settings (screen, storage, power, calibration) | +| [Network](network.md) | Wi-Fi connection management | | [sunnylink](sunnylink.md) | Cloud backend integration, backup/restore, sponsor status | +| [Toggles](toggles.md) | Core openpilot toggles (enable, experimental mode, LDW, etc.) | +| [Software](software.md) | Update channel and branch management | +| [Models](models.md) | Driving model selection, download, and AI configuration | +| [Steering](steering.md) | Lateral control mode, MADS, lane change, and torque tuning | +| [Cruise](cruise.md) | ACC behavior, following distance, cruise button logic, speed limit assist | +| [Visuals](visuals.md) | HUD overlays and visual customization | +| [Display](display.md) | Onroad display brightness and layout | +| [OSM](osm.md) | OpenStreetMap data and map features | | [Trips](trips.md) | Drive statistics and trip history | -| [OSM Maps](osm.md) | OpenStreetMap data and map features | - -## Vehicle-Specific - -| Section | Description | -|---------|-------------| -| [Tesla](vehicle/tesla.md) | Tesla-specific overrides | -| [Toyota](vehicle/toyota.md) | Toyota-specific overrides | -| [Hyundai](vehicle/hyundai.md) | Hyundai-specific overrides | -| [Subaru](vehicle/subaru.md) | Subaru-specific overrides | +| [Vehicle](vehicle/tesla.md) | Vehicle-specific overrides (Tesla, Toyota, Hyundai, Subaru) | +| [Firehose](firehose.md) | Training data upload for comma's driving models | +| [Developer](developer.md) | Developer and debug options | diff --git a/docs_sp/settings/network.md b/docs_sp/settings/network.md new file mode 100644 index 0000000000..99453715ca --- /dev/null +++ b/docs_sp/settings/network.md @@ -0,0 +1,17 @@ +--- +title: Network +--- + +# Network + +Manage Wi-Fi connections on your comma device. + +## Wi-Fi + +The Network panel provides a Wi-Fi scanner that lists available networks. Tap a network to connect, or use the **Scan** button to refresh the list. + +### Usage Notes + +- A stable Wi-Fi connection is required for software updates and route uploads. +- For Firehose Mode, connect to Wi-Fi with a reliable USB-C power adapter at least once per week. +- Hotspot and tethered connections also work for uploads while driving if your data plan allows it. diff --git a/docs_sp/settings/toggles.md b/docs_sp/settings/toggles.md new file mode 100644 index 0000000000..6b5af88316 --- /dev/null +++ b/docs_sp/settings/toggles.md @@ -0,0 +1,21 @@ +--- +title: Toggles +--- + +# Toggles + +Core openpilot toggles inherited from upstream. These control fundamental driving assist behavior. + +## Available Toggles + +| Toggle | Description | +|--------|-------------| +| Enable openpilot | Enable or disable the openpilot driving assist system | +| Experimental Mode | Use the neural network for longitudinal control on city streets (alpha quality) | +| Disengage on Accelerator Pedal | Disengage openpilot when the gas pedal is pressed | +| Enable Lane Departure Warnings | Receive alerts when the vehicle drifts out of the detected lane without a turn signal | +| Record and Upload Driver Camera | Upload driver-facing camera data for improved driver monitoring models | +| Use 24h Format for Clock | Display the onroad clock in 24-hour format | + +!!! note + These are upstream openpilot toggles. sunnypilot-specific toggles and customizations are found in the dedicated settings panels (Steering, Cruise, Visuals, etc.). diff --git a/zensical.toml b/zensical.toml index 0e137b9d3f..02957e70c1 100644 --- a/zensical.toml +++ b/zensical.toml @@ -54,39 +54,34 @@ nav = [ ]}, { "Settings" = [ "settings/index.md", - { "Cruise Control" = [ - { "Cruise Control" = "settings/cruise.md" }, - { "Speed Limit" = "settings/speed-limit.md" }, - ]}, + { "Device" = "settings/device.md" }, + { "Network" = "settings/network.md" }, + { "sunnylink" = "settings/sunnylink.md" }, + { "Toggles" = "settings/toggles.md" }, + { "Software" = "settings/software.md" }, + { "Models" = "settings/models.md" }, { "Steering" = [ { "Steering" = "settings/steering.md" }, { "MADS" = "settings/mads.md" }, { "Lane Change" = "settings/lane-change.md" }, { "Torque" = "settings/torque.md" }, ]}, - { "Display & Visuals" = [ - { "Display" = "settings/display.md" }, - { "Visuals & HUD" = "settings/visuals.md" }, + { "Cruise" = [ + { "Cruise" = "settings/cruise.md" }, + { "Speed Limit" = "settings/speed-limit.md" }, ]}, - { "Models & AI" = [ - { "Models & AI" = "settings/models.md" }, - ]}, - { "Device & System" = [ - { "Device" = "settings/device.md" }, - { "Software" = "settings/software.md" }, - { "Developer" = "settings/developer.md" }, - ]}, - { "Connected Services" = [ - { "sunnylink" = "settings/sunnylink.md" }, - { "Trips" = "settings/trips.md" }, - { "OSM Maps" = "settings/osm.md" }, - ]}, - { "Vehicle-Specific" = [ + { "Visuals" = "settings/visuals.md" }, + { "Display" = "settings/display.md" }, + { "OSM" = "settings/osm.md" }, + { "Trips" = "settings/trips.md" }, + { "Vehicle" = [ { "Tesla" = "settings/vehicle/tesla.md" }, { "Toyota" = "settings/vehicle/toyota.md" }, { "Hyundai" = "settings/vehicle/hyundai.md" }, { "Subaru" = "settings/vehicle/subaru.md" }, ]}, + { "Firehose" = "settings/firehose.md" }, + { "Developer" = "settings/developer.md" }, ]}, { "How-To Guides" = [ "how-to/index.md", @@ -123,8 +118,6 @@ features = [ "content.tabs.link", "navigation.tabs", "navigation.tabs.sticky", - "navigation.sections", - "navigation.expand", "navigation.indexes", "navigation.path", "navigation.instant", @@ -148,16 +141,16 @@ toggle.name = "Switch to light mode" [[project.theme.palette]] media = "(prefers-color-scheme: light)" scheme = "default" -primary = "deep purple" -accent = "teal" +primary = "#594AE2" +accent = "#594AE2" toggle.icon = "material/brightness-7" toggle.name = "Switch to dark mode" [[project.theme.palette]] media = "(prefers-color-scheme: dark)" scheme = "slate" -primary = "deep purple" -accent = "teal" +primary = "#594AE2" +accent = "#594AE2" toggle.icon = "material/brightness-4" toggle.name = "Switch to system preference"