forked from commaai/openpilot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'commaai:master' into PA-testing
- Loading branch information
Showing
39 changed files
with
1,486 additions
and
304 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| This is the source for a new https://docs.comma.ai. It's not hosted anywhere yet, but it's easy to run locally. | ||
|
|
||
| https://www.mkdocs.org/getting-started/ | ||
|
|
||
| ``` | ||
| pip install mkdocs mkdocs-terminal | ||
| mkdocs --serve | ||
| ``` | ||
|
|
||
| inspiration: | ||
| * https://rerun.io/docs/ | ||
| * https://docs.expo.dev/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Developing a car brand port | ||
|
|
||
| A brand port is a port of openpilot to a substantially new car brand or platform within a brand. | ||
|
|
||
| Here's an example of one: https://github.com/commaai/openpilot/pull/23331. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Developing a car model port | ||
|
|
||
| A model port is a port of openpilot to a new car model within an already supported brand. Model ports are easier than brand ports because the car's existing APIs are already known. | ||
|
|
||
| Here's an example of one: https://github.com/commaai/openpilot/pull/30672/. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # What is a car port? | ||
|
|
||
| All car ports live in `openpilot/selfdrive/car/`. | ||
|
|
||
| * interface.py: Interface for the car, defines the CarInterface class | ||
| * carstate.py: Reads CAN from car and builds openpilot CarState message | ||
| * carcontroller.py: Builds CAN messages to send to car | ||
| * values.py: Limits for actuation, general constants for cars, and supported car documentation | ||
| * radar_interface.py: Interface for parsing radar points from the car |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # What is openpilot? | ||
|
|
||
| [openpilot](http://github.com/commaai/openpilot) is an open source driver assistance system. Currently, openpilot performs the functions of Adaptive Cruise Control (ACC), Automated Lane Centering (ALC), Forward Collision Warning (FCW), and Lane Departure Warning (LDW) for a growing variety of [supported car makes, models, and model years](docs/CARS.md). In addition, while openpilot is engaged, a camera-based Driver Monitoring (DM) feature alerts distracted and asleep drivers. See more about [the vehicle integration](docs/INTEGRATION.md) and [limitations](docs/LIMITATIONS.md). | ||
|
|
||
|
|
||
| ## How do I use it? | ||
|
|
||
| openpilot is designed to be used on the comma 3X. | ||
|
|
||
| ## How does it work? | ||
|
|
||
| In short, openpilot uses the car's existing APIs for the built-in [ADAS](https://en.wikipedia.org/wiki/Advanced_driver-assistance_system) system and simply provides better acceleration, braking, and steering inputs than the stock system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| This section is for how-to's on common workflows. | ||
|
|
||
| They'll be like this blog post we wrote: | ||
| https://blog.comma.ai/turning-the-speed-blue/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| site_name: openpilot docs | ||
| docs_dir: docs | ||
| repo_url: https://github.com/commaai/openpilot/ | ||
|
|
||
| theme: | ||
| name: terminal | ||
| features: | ||
| - navigation.side.toc.hide | ||
|
|
||
| nav: | ||
| - Getting Started: | ||
| - What is openpilot?: getting-started/what-is-openpilot.md | ||
| - How-to: | ||
| - Turn the speed blue: how-to/turning-the-speed-blue.md | ||
| - Car Porting: | ||
| - What is a car port?: car-porting/what-is-a-car-port.md | ||
| - Porting a car brand: car-porting/brand-port.md | ||
| - Porting a car model: car-porting/model-port.md |
Oops, something went wrong.