even more

This commit is contained in:
Jason Wen
2026-03-12 20:28:28 -04:00
parent 1e5ad42e7a
commit 31b3776150
38 changed files with 84 additions and 115 deletions
-31
View File
@@ -1,31 +0,0 @@
# sunnypilot Documentation
Source files for [docs.sunnypilot.ai](https://docs.sunnypilot.ai).
## Local Development
### Install dependencies
```bash
uv pip install ".[docs]"
```
### Build
```bash
zensical build
```
### Serve locally
```bash
zensical serve
```
The site will be available at `http://127.0.0.1:8000`.
## Structure
- `docs_sp/` — Source markdown files
- `docs_site_sp/` — Build output (gitignored)
- `zensical.toml` — Zensical configuration
+4 -4
View File
@@ -6,7 +6,7 @@ title: Community
Get involved with sunnypilot development and connect with other users.
- **[Contributing](contributing.md)** -- How to contribute code, documentation, and translations
- **[Workflow](workflow.md)** -- Development workflow and branch strategy
- **[Reporting a Bug](reporting-a-bug.md)** -- How to file an effective bug report
- **[Community Forum](https://community.sunnypilot.ai)** -- Join the discussion
- **[Contributing](contributing.md)** - How to contribute code, documentation, and translations
- **[Workflow](workflow.md)** - Development workflow and branch strategy
- **[Reporting a Bug](reporting-a-bug.md)** - How to file an effective bug report
- **[Community Forum](https://community.sunnypilot.ai)** - Join the discussion
+2 -2
View File
@@ -6,5 +6,5 @@ title: Connected Services
Cloud and map integrations that extend sunnypilot beyond the vehicle.
- [sunnylink](sunnylink.md) -- settings backup/restore, sponsor tiers, GitHub account pairing, and remote device management
- [OSM Maps](osm-maps.md) -- OpenStreetMap data for speed limits, road names, and map-based driving features
- [sunnylink](sunnylink.md) - settings backup/restore, sponsor tiers, GitHub account pairing, and remote device management
- [OSM Maps](osm-maps.md) - OpenStreetMap data for speed limits, road names, and map-based driving features
+2 -2
View File
@@ -23,7 +23,7 @@ Integrates OpenStreetMap (OSM) data to provide speed limit information, road geo
## How to Set Up
**Settings****sunnypilot****OSM Maps**
**Settings****OSM**
1. Select your **Country**
2. If in the US, select your **State**
@@ -42,4 +42,4 @@ Integrates OpenStreetMap (OSM) data to provide speed limit information, road geo
## Settings Reference
See [OSM Maps Settings](../settings/osm.md) for all options and status information.
See [OSM Settings](../../settings/osm.md) for all options and status information.
+2 -2
View File
@@ -58,10 +58,10 @@ sunnylink maintains a persistent WebSocket connection to the backend, enabling:
## How to Configure
**Settings** > **sunnypilot** > **sunnylink**
**Settings** **sunnylink**
sunnylink requires explicit user consent before activation. On first enable, a consent dialog explains what data is collected and how it is used.
## Settings Reference
See [sunnylink Settings](../settings/sunnylink.md) for all configuration options.
See [sunnylink Settings](../../settings/sunnylink.md) for all configuration options.
@@ -43,7 +43,7 @@ Because this operates outside the vehicle manufacturer's intended cruise control
## How to Enable
**Settings****sunnypilot****Cruise Control****Alpha Longitudinal**
**Settings****Developer****sunnypilot Longitudinal Control (Alpha)**
!!! note
This toggle only appears on development branches and only for vehicles where `alphaLongitudinalAvailable` is `True`.
@@ -21,7 +21,7 @@ Customize the speed increments when you press the cruise control buttons. Instea
## How to Enable
**Settings****sunnypilot****Cruise Control****Custom ACC Increments**
**Settings****Cruise****Custom ACC Increments**
## Settings Reference
@@ -54,7 +54,7 @@ Based on these signals, DEC switches between:
## How to Enable
**Settings****sunnypilot****Cruise Control****Dynamic Experimental Control**
**Settings****Cruise****Dynamic Experimental Control**
## Settings Reference
+1 -1
View File
@@ -61,7 +61,7 @@ ICBM support varies by vehicle brand. The feature toggle only appears in setting
## How to Enable
**Settings****sunnypilot****Cruise Control****Intelligent Cruise Button Management**
**Settings****Cruise****Intelligent Cruise Button Management**
## Features Unlocked by ICBM
+7 -7
View File
@@ -6,10 +6,10 @@ title: Cruise Control
Enhancements to adaptive cruise control that give you finer control over speed management, turn handling, and speed limit compliance.
- [Intelligent Cruise Button Management](icbm.md) -- intercepts steering wheel button presses for smarter speed adjustments
- [Smart Cruise Control - Vision](scc-v.md) -- uses vision predictions to slow for curves
- [Smart Cruise Control - Map](scc-m.md) -- uses map data to anticipate speed changes
- [Custom ACC Increments](custom-acc-increments.md) -- set custom speed change amounts for short and long button presses
- [Dynamic Experimental Control](dynamic-experimental-control.md) -- automatically switches between driving modes based on conditions
- [Speed Limit Assist](speed-limit.md) -- adjusts cruise speed to match posted limits
- [Alpha Longitudinal](alpha-longitudinal.md) -- experimental longitudinal control for select vehicles
- [Intelligent Cruise Button Management](icbm.md) - intercepts steering wheel button presses for smarter speed adjustments
- [Smart Cruise Control - Vision](scc-v.md) - uses vision predictions to slow for curves
- [Smart Cruise Control - Map](scc-m.md) - uses map data to anticipate speed changes
- [Custom ACC Increments](custom-acc-increments.md) - set custom speed change amounts for short and long button presses
- [Dynamic Experimental Control](dynamic-experimental-control.md) - automatically switches between driving modes based on conditions
- [Speed Limit Assist](speed-limit.md) - adjusts cruise speed to match posted limits
- [Alpha Longitudinal](alpha-longitudinal.md) - experimental longitudinal control for select vehicles
+2 -2
View File
@@ -19,11 +19,11 @@ SCC-M uses downloaded OpenStreetMap data to anticipate road changes — curves,
!!! info "Requirements"
- [ICBM](icbm.md) must be enabled
- Vehicle must support ICBM
- [OSM Maps](osm-maps.md) must be configured and downloaded
- [OSM Maps](../connected/osm-maps.md) must be configured and downloaded
## How to Enable
**Settings****sunnypilot****Cruise Control****Smart Cruise Control — Map**
**Settings****Cruise****Smart Cruise Control — Map**
## Settings Reference
+1 -1
View File
@@ -21,7 +21,7 @@ The camera continuously monitors the road ahead. When a lead vehicle is detected
## How to Enable
**Settings****sunnypilot****Cruise Control****Smart Cruise Control — Vision**
**Settings****Cruise****Smart Cruise Control — Vision**
## Settings Reference
+3 -3
View File
@@ -22,7 +22,7 @@ Speed Limit Assist pulls speed limit data from **two sources**:
| Source | Description |
|--------|-------------|
| **Car State** | Speed limit information provided by the vehicle's built-in sensors (e.g., Traffic Sign Recognition cameras). Availability depends on the vehicle. |
| **Map Data** | Speed limits from downloaded OpenStreetMap data. Requires [OSM Maps](osm-maps.md) to be configured and downloaded. |
| **Map Data** | Speed limits from downloaded OpenStreetMap data. Requires [OSM Maps](../connected/osm-maps.md) to be configured and downloaded. |
### Speed Limit Policy
@@ -73,11 +73,11 @@ Speed Limit Assist provides visual indicators on the driving HUD:
!!! info "Requirements"
- Longitudinal control must be available, **or** [ICBM](icbm.md) must be enabled
- For map-based limits: [OSM Maps](osm-maps.md) must be configured and downloaded
- For map-based limits: [OSM Maps](../connected/osm-maps.md) must be configured and downloaded
## How to Enable
**Settings****sunnypilot****Cruise Control****Speed Limit Assist**
**Settings****Cruise****Speed Limit Assist**
## Vehicle Restrictions
+2 -2
View File
@@ -27,8 +27,8 @@ Customize the heads-up display (HUD) elements and visual overlays shown on the d
## How to Configure
**Settings** **sunnypilot** **Visuals & HUD**
**Settings****Visuals**
## Settings Reference
See [Visuals & HUD Settings](../settings/visuals.md) for all toggle options and multi-button selectors.
See [Visuals Settings](../../settings/visuals.md) for all toggle options and multi-button selectors.
+2 -2
View File
@@ -6,5 +6,5 @@ title: Display & Visuals
Customizations for the onroad driving screen, HUD overlays, and visual indicators.
- [Onroad Display](onroad-display.md) -- screen brightness, timeout, and layout controls
- [HUD & Visuals](hud-visuals.md) -- toggles for visual indicators like blind spot warnings, road names, and traffic light alerts
- [Onroad Display](onroad-display.md) - screen brightness, timeout, and layout controls
- [HUD & Visuals](hud-visuals.md) - toggles for visual indicators like blind spot warnings, road names, and traffic light alerts
+2 -2
View File
@@ -16,8 +16,8 @@ Control the screen brightness, timeout behavior, and touch interactivity while d
## How to Configure
**Settings** **sunnypilot** **Display**
**Settings****Display**
## Settings Reference
See [Display Settings](../settings/display.md) for all configuration options.
See [Display Settings](../../settings/display.md) for all configuration options.
+2 -2
View File
@@ -23,8 +23,8 @@ Advanced parameters are only visible when **Show Advanced Controls** is enabled
## How to Configure
**Settings** **sunnypilot** **Models & AI**
**Settings****Models**
## Settings Reference
See [Models & AI Settings](../settings/models.md) for all configuration options.
See [Models Settings](../settings/models.md) for all configuration options.
@@ -29,7 +29,7 @@ Automatically executes lane changes when you activate the turn signal. You can c
## How to Enable
**Settings** **sunnypilot** **Steering****Lane Change Settings**
**Settings****Steering****Customize Lane Change**
## Modes
+1 -1
View File
@@ -27,7 +27,7 @@ How long after the blinker is deactivated before lateral control re-engages. A s
## How to Configure
**Settings** > **sunnypilot** > **Steering**
**Settings** **Steering**
Look for the Blinker Pause Lateral Control toggle and its sub-settings.
+5 -5
View File
@@ -6,8 +6,8 @@ title: Steering
Lateral control features that govern how sunnypilot handles steering assistance, lane changes, and manual override behavior.
- [Modular Assistive Driving System (MADS)](mads.md) -- decouples steering from cruise control for independent lateral assist
- [Neural Network Lateral Control (NNLC)](nnlc.md) -- uses a neural network for smoother steering
- [Auto Lane Change](auto-lane-change.md) -- automated lane changes triggered by the turn signal
- [Torque Control](torque-control.md) -- torque-based steering with tunable parameters
- [Blinker Pause Lateral](blinker-pause.md) -- temporarily pauses steering assist when the turn signal is active
- [Modular Assistive Driving System (MADS)](mads.md) - decouples steering from cruise control for independent lateral assist
- [Neural Network Lateral Control (NNLC)](nnlc.md) - uses a neural network for smoother steering
- [Auto Lane Change](auto-lane-change.md) - automated lane changes triggered by the turn signal
- [Torque Control](torque-control.md) - torque-based steering with tunable parameters
- [Blinker Pause Lateral](blinker-pause.md) - temporarily pauses steering assist when the turn signal is active
+1 -1
View File
@@ -48,7 +48,7 @@ This setting controls what happens to steering assistance when the brake pedal i
## How to Enable
**Settings** **sunnypilot** **Steering** → enable **MADS**
**Settings****Steering** → enable **MADS**
Then configure the sub-settings in **MADS Settings**.
+1 -1
View File
@@ -38,7 +38,7 @@ When NNLC is enabled, the system matches your vehicle to the best available mode
## How to Enable
**Settings** **sunnypilot** **Steering****Neural Network Lateral Control**
**Settings****Steering****Neural Network Lateral Control**
!!! tip
Not all vehicles have NNLC models available. If the toggle does not appear, your vehicle may use angle-based steering which is not compatible with NNLC, or a trained model may not yet exist for your vehicle.
+1 -1
View File
@@ -26,7 +26,7 @@ Torque-based lateral control applies steering commands as torque (rotational for
## How to Enable
1. Go to **Settings** **sunnypilot** **Steering**
1. Go to **Settings****Steering**
2. Enable **Enforce Torque Control**
3. Open the **Torque Settings** sub-panel to fine-tune
+2 -2
View File
@@ -6,5 +6,5 @@ title: Getting Started
New to sunnypilot? Start here to understand what sunnypilot is and whether it works with your vehicle.
- **[What is sunnypilot?](what-is-sunnypilot.md)** -- Overview of the system, supported vehicles, and key capabilities
- **[Use sunnypilot in a car](use-sunnypilot-in-a-car.md)** -- Requirements and what to expect on your first drive
- **[What is sunnypilot?](what-is-sunnypilot.md)** - Overview of the system, supported vehicles, and key capabilities
- **[Use sunnypilot in a car](use-sunnypilot-in-a-car.md)** - Requirements and what to expect on your first drive
+2 -2
View File
@@ -6,5 +6,5 @@ title: How-To Guides
Step-by-step guides for common tasks.
- **[Share a Route](share-a-route.md)** -- How to share driving routes with others for debugging or review
- **[Preserve Local File Changes](preserve-local-changes.md)** -- Keep your local modifications across software updates
- **[Share a Route](share-a-route.md)** - How to share driving routes with others for debugging or review
- **[Preserve Local File Changes](preserve-local-changes.md)** - Keep your local modifications across software updates
+3 -3
View File
@@ -6,6 +6,6 @@ title: Safety
Read these pages before using sunnypilot. Understanding the safety model and your responsibilities as a driver is essential.
- **[Safety Information](safety.md)** -- Core safety principles and system limitations
- **[Driver Responsibility & L2 ADAS](driver-responsibility.md)** -- What Level 2 driving assistance means for you
- **[Prohibited Modifications](prohibited-modifications.md)** -- Modifications that compromise safety and are not supported
- **[Safety Information](safety.md)** - Core safety principles and system limitations
- **[Driver Responsibility & L2 ADAS](driver-responsibility.md)** - What Level 2 driving assistance means for you
- **[Prohibited Modifications](prohibited-modifications.md)** - Modifications that compromise safety and are not supported
+1 -1
View File
@@ -45,7 +45,7 @@ A row of three buttons that controls how the speed offset is calculated:
| Type | What it does |
|------|-------------|
| **None** | No offset -- cruise matches the exact speed limit |
| **None** | No offset - cruise matches the exact speed limit |
| **Fixed** | A fixed value (in km/h or mph) is added to or subtracted from the limit |
| **%** | A percentage is applied to the speed limit |
@@ -32,6 +32,6 @@ A row of five buttons lets you choose the source policy:
## Related
- [Speed Limit Settings](index.md) -- mode, offset type, and offset value
- [OSM Panel](../../osm.md) -- download map data for your region
- [Speed Limit Assist (Feature)](../../../features/cruise/speed-limit.md) -- how Speed Limit Assist works
- [Speed Limit Settings](index.md) - mode, offset type, and offset value
- [OSM Panel](../../osm.md) - download map data for your region
- [Speed Limit Assist (Feature)](../../../features/cruise/speed-limit.md) - how Speed Limit Assist works
+1 -1
View File
@@ -15,7 +15,7 @@ Advanced settings for developers and power users, including debug tools, connect
## Show Advanced Controls
Reveals additional advanced settings throughout the sunnypilot interface. Enabling this does not change any driving behavior -- it only makes hidden controls visible.
Reveals additional advanced settings throughout the sunnypilot interface. Enabling this does not change any driving behavior - it only makes hidden controls visible.
Settings gated behind this toggle include:
+1 -1
View File
@@ -7,7 +7,7 @@ title: Settings
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.
!!! info "Not all settings appear on every device"
comma four users see a simplified settings screen. Most features still work on comma four -- you just configure the hidden ones through sunnylink. A few onroad visual features are not available on comma four at all. See [Platform Differences](platform-differences.md) for the full breakdown.
comma four users see a simplified settings screen. Most features still work on comma four - you just configure the hidden ones through sunnylink. A few onroad visual features are not available on comma four at all. See [Platform Differences](platform-differences.md) for the full breakdown.
| Panel | Description |
|-------|-------------|
+3 -3
View File
@@ -26,9 +26,9 @@ A button labeled **SELECT** that opens a model selection dialog. The currently a
When a model is being downloaded, progress bars appear for each component:
- **Driving Model** -- the main supercombo neural network
- **Vision Model** -- the vision processing model
- **Policy Model** -- the decision-making policy model
- **Driving Model** - the main supercombo neural network
- **Vision Model** - the vision processing model
- **Policy Model** - the decision-making policy model
Each shows a progress bar with download percentage.
+3 -3
View File
@@ -14,13 +14,13 @@ The full-featured interface with a sidebar-based settings panel. All settings an
### comma four (MICI)
A simplified, touch-friendly interface designed for the comma four's compact form factor. Only a subset of settings are exposed through the on-device screen. Most features still work on comma four -- you configure the hidden ones through sunnylink.
A simplified, touch-friendly interface designed for the comma four's compact form factor. Only a subset of settings are exposed through the on-device screen. Most features still work on comma four - you configure the hidden ones through sunnylink.
However, some onroad visual features require UI rendering code that does not exist on comma four. These features cannot be activated on comma four even through sunnylink. Each setting page notes which category it falls into.
### sunnylink (Web / App)
The sunnylink web interface provides access to all configurable settings regardless of which device you use. If a setting is not shown on your comma four's screen, you can configure it through sunnylink -- provided the feature is supported on your device.
The sunnylink web interface provides access to all configurable settings regardless of which device you use. If a setting is not shown on your comma four's screen, you can configure it through sunnylink - provided the feature is supported on your device.
## Three Levels of Device Availability
@@ -71,7 +71,7 @@ The following features from the [Visuals](visuals.md) panel rely on onroad UI re
## What This Means for You
If you use a **comma four**, your on-device screen shows a simplified set of controls. Most sunnypilot features still run on your device -- you configure the hidden ones through **sunnylink**. The exception is the onroad visual features listed above, which require rendering code that does not exist on comma four.
If you use a **comma four**, your on-device screen shows a simplified set of controls. Most sunnypilot features still run on your device - you configure the hidden ones through **sunnylink**. The exception is the onroad visual features listed above, which require rendering code that does not exist on comma four.
If you use a **comma 3X or comma 3**, all settings and onroad visual features are directly accessible from the device sidebar.
+3 -3
View File
@@ -75,9 +75,9 @@ Enables a neural network model to handle lateral control instead of the traditio
The Steering section contains these additional configuration pages:
- **[MADS Settings](mads.md)** -- configure engagement modes and brake pedal behavior
- **[Lane Change Settings](lane-change.md)** -- configure auto lane change timing and blind spot monitoring
- **[Torque Settings](torque.md)** -- fine-tune torque lateral control parameters
- **[MADS Settings](mads.md)** - configure engagement modes and brake pedal behavior
- **[Lane Change Settings](lane-change.md)** - configure auto lane change timing and blind spot monitoring
- **[Torque Settings](torque.md)** - fine-tune torque lateral control parameters
---
+1 -1
View File
@@ -21,7 +21,7 @@ A selector that controls how lane changes are initiated when you activate the tu
|--------|-------------|
| **Off** | Auto lane change is disabled |
| **Nudge** | Requires a light steering nudge in the desired direction to start the lane change (default) |
| **Nudgeless** | Lane change begins immediately when the turn signal is activated -- no nudge needed |
| **Nudgeless** | Lane change begins immediately when the turn signal is activated - no nudge needed |
| **0.5 s** | Lane change begins 0.5 seconds after the turn signal is activated |
| **1 s** | Lane change begins 1 second after activation |
| **2 s** | Lane change begins 2 seconds after activation |
+6 -6
View File
@@ -17,9 +17,9 @@ View your cumulative and recent driving statistics.
A stat card showing your lifetime driving totals:
- **Drives** -- total number of driving routes recorded
- **Distance** -- total distance driven (km or miles, based on your unit preference)
- **Hours** -- total hours of driving time
- **Drives** - total number of driving routes recorded
- **Distance** - total distance driven (km or miles, based on your unit preference)
- **Hours** - total hours of driving time
---
@@ -27,9 +27,9 @@ A stat card showing your lifetime driving totals:
A stat card showing your driving activity from the last 7 days:
- **Drives** -- number of routes recorded this week
- **Distance** -- distance driven this week
- **Hours** -- hours driven this week
- **Drives** - number of routes recorded this week
- **Distance** - distance driven this week
- **Hours** - hours driven this week
!!! note
This panel is display-only. There are no interactive controls.
+4 -4
View File
@@ -34,9 +34,9 @@ A legend below the vehicle name explains the color codes.
After a vehicle is detected or selected, brand-specific settings appear below the vehicle selector. Only brands with configurable settings show additional items:
- [Toyota / Lexus](toyota.md) -- Enforce Factory Longitudinal Control, Stop and Go Hack
- [Hyundai / Kia / Genesis](hyundai.md) -- Custom Longitudinal Tuning
- [Subaru](subaru.md) -- Stop and Go, Stop and Go for Manual Parking Brake
- [Tesla](tesla.md) -- Cooperative Steering
- [Toyota / Lexus](toyota.md) - Enforce Factory Longitudinal Control, Stop and Go Hack
- [Hyundai / Kia / Genesis](hyundai.md) - Custom Longitudinal Tuning
- [Subaru](subaru.md) - Stop and Go, Stop and Go for Manual Parking Brake
- [Tesla](tesla.md) - Cooperative Steering
The following brands are supported for vehicle selection but have no brand-specific settings: Honda, GM, Ford, Volkswagen, Nissan, Mazda, Chrysler, PSA, Rivian.
+3 -3
View File
@@ -6,6 +6,6 @@ title: Installation
Follow these guides to install sunnypilot on your comma device.
- **[Read Before Installing](read-before-installing.md)** -- Prerequisites, warnings, and preparation steps
- **[URL Method](url-method.md)** -- Install via the built-in URL installer (recommended)
- **[SSH Method](ssh-method.md)** -- Install via SSH for advanced users
- **[Read Before Installing](read-before-installing.md)** - Prerequisites, warnings, and preparation steps
- **[URL Method](url-method.md)** - Install via the built-in URL installer (recommended)
- **[SSH Method](ssh-method.md)** - Install via SSH for advanced users
+3 -3
View File
@@ -6,6 +6,6 @@ title: Technical Reference
In-depth technical documentation, tuning guides, and branch information.
- **[Hyundai Longitudinal Tuning](hyundai-longitudinal-tuning.md)** -- Detailed longitudinal control tuning for Hyundai vehicles
- **[Recommended Branches](../references/recommended-branches.md)** -- Which branches to use for your setup
- **[Branch Definitions](../references/branch-definitions.md)** -- Explanation of branch naming and release channels
- **[Hyundai Longitudinal Tuning](hyundai-longitudinal-tuning.md)** - Detailed longitudinal control tuning for Hyundai vehicles
- **[Recommended Branches](../references/recommended-branches.md)** - Which branches to use for your setup
- **[Branch Definitions](../references/branch-definitions.md)** - Explanation of branch naming and release channels