mvp of new docs.comma.ai (#32926)
* ssh docs
* strict
* need an index
* push to prod
old-commit-hash: f6189568ea
fix-exp-path
parent
856e536aa8
commit
1490a714a0
10 changed files with 63 additions and 25 deletions
@ -1,9 +1,22 @@ |
|||||||
# What is a car port? |
# What is a car port? |
||||||
|
|
||||||
All car ports live in `openpilot/selfdrive/car/`. |
A car port enables openpilot support on a particular car. Each car model openpilot supports needs to be individually ported. All car ports live in `openpilot/selfdrive/car/`. |
||||||
|
|
||||||
* interface.py: Interface for the car, defines the CarInterface class |
The complexity of a car port varies depending on many factors including: |
||||||
* carstate.py: Reads CAN from car and builds openpilot CarState message |
* existing openpilot support for similar cars |
||||||
* carcontroller.py: Builds CAN messages to send to car |
* architecture and APIs available in the 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 |
|
||||||
|
# Structure of a car port |
||||||
|
* `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 |
||||||
|
|
||||||
|
|
||||||
|
# Overiew |
||||||
|
|
||||||
|
[Jason Young](https://github.com/jyoung8607) gave a talk at COMMA_CON with an overview of the car porting process. The talk is available on YouTube: |
||||||
|
|
||||||
|
https://youtu.be/KcfzEHB6ms4?si=5szh1PX6TksOCKmM |
||||||
|
@ -0,0 +1 @@ |
|||||||
|
# Architecture |
@ -0,0 +1,5 @@ |
|||||||
|
# Roadmap |
||||||
|
|
||||||
|
Coming soon... |
||||||
|
|
||||||
|
For now, check out our GitHub [milestones](https://github.com/commaai/openpilot/milestones) and [bounties](https://comma.ai/bounties). |
@ -0,0 +1 @@ |
|||||||
|
getting-started/what-is-openpilot.md |
Loading…
Reference in new issue