mirror of https://github.com/commaai/openpilot.git
Docs update (#30726)
* update readme * three videos looks way better * shorter picture * even smaller * Update README.md * Update README.md
This commit is contained in:
Adeeb Shihadeh
GitHub
parent
075e6ff3e6
commit
57b9e75d6d
111
README.md
111
README.md
|
|
@ -1,18 +1,4 @@
|
||||||
|
|
||||||
|
|
||||||
Table of Contents
|
|
||||||
=======================
|
|
||||||
|
|
||||||
* [What is openpilot?](#what-is-openpilot)
|
|
||||||
* [Running in a car](#running-on-a-dedicated-device-in-a-car)
|
|
||||||
* [Running on PC](#running-on-pc)
|
|
||||||
* [Community and Contributing](#community-and-contributing)
|
|
||||||
* [User Data and comma Account](#user-data-and-comma-account)
|
|
||||||
* [Safety and Testing](#safety-and-testing)
|
|
||||||
* [Directory Structure](#directory-structure)
|
|
||||||
* [Licensing](#licensing)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
What is openpilot?
|
What is openpilot?
|
||||||
------
|
------
|
||||||
|
|
@ -23,33 +9,21 @@ What is openpilot?
|
||||||
<tr>
|
<tr>
|
||||||
<td><a href="https://youtu.be/NmBfgOanCyk" title="Video By Greer Viau"><img src="https://i.imgur.com/1w8c6d2.jpg"></a></td>
|
<td><a href="https://youtu.be/NmBfgOanCyk" title="Video By Greer Viau"><img src="https://i.imgur.com/1w8c6d2.jpg"></a></td>
|
||||||
<td><a href="https://youtu.be/VHKyqZ7t8Gw" title="Video By Logan LeGrand"><img src="https://i.imgur.com/LnBucik.jpg"></a></td>
|
<td><a href="https://youtu.be/VHKyqZ7t8Gw" title="Video By Logan LeGrand"><img src="https://i.imgur.com/LnBucik.jpg"></a></td>
|
||||||
<td><a href="https://youtu.be/VxiR4iyBruo" title="Video By Charlie Kim"><img src="https://i.imgur.com/4Qoy48c.jpg"></a></td>
|
<td><a href="https://www.youtube.com/watch?v=SUIZYzxtMQs">
|
||||||
<td><a href="https://youtu.be/-IkImTe1NYE" title="Video By Aragon"><img src="https://i.imgur.com/04VNzPf.jpg"></a></td>
|
<img src="https://markdown-videos-api.jorgenkh.no/url?url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DSUIZYzxtMQs" alt="drive to taco bell" title="drive to taco bell"/></a></td>
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://youtu.be/iIUICQkdwFQ" title="Video By Logan LeGrand"><img src="https://i.imgur.com/b1LHQTy.jpg"></a></td>
|
|
||||||
<td><a href="https://youtu.be/XOsa0FsVIsg" title="Video By PinoyDrives"><img src="https://i.imgur.com/6FG0Bd8.jpg"></a></td>
|
|
||||||
<td><a href="https://youtu.be/bCwcJ98R_Xw" title="Video By JS"><img src="https://i.imgur.com/zO18CbW.jpg"></a></td>
|
|
||||||
<td><a href="https://youtu.be/BQ0tF3MTyyc" title="Video By Tsai-Fi"><img src="https://i.imgur.com/eZzelq3.jpg"></a></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
|
||||||
Running on a dedicated device in a car
|
Running on a dedicated device in a car
|
||||||
------
|
------
|
||||||
|
|
||||||
To use openpilot in a car, you need four things
|
To use openpilot in a car, you need four things:
|
||||||
1. **Supported Device:** A comma 3/3X. You can purchase these devices from (https://comma.ai/shop/comma-3x)
|
1. **Supported Device:** a comma 3/3X, available at [comma.ai/shop](https://comma.ai/shop/comma-3x).
|
||||||
|
2. **Software:** The setup procedure for the comma 3/3X allows users to enter a URL for custom software. Use the URL `openpilot.comma.ai` to install the release version.
|
||||||
2. **Software:** The setup procedure for the comma 3/3X allows users to enter a URL for custom software.
|
3. **Supported Car:** Ensure that you have one of [the 250+ supported cars](docs/CARS.md).
|
||||||
To install the release version of openpilot, use the URL `openpilot.comma.ai`.
|
|
||||||
To install openpilot master (for more advanced users), use the URL `installer.comma.ai/commaai/master`. You can replace "commaai" with another GitHub username to install a fork.
|
|
||||||
|
|
||||||
3. **Supported Car:** Ensure that you have one of [the 250+ supported cars](docs/CARS.md). openpilot supports a wide range of car makes including Honda, Toyota, Hyundai, Nissan, Kia, Chrysler, Lexus, Acura, Audi, VW, Ford, and many more.
|
|
||||||
If your car is not officially listed as supported but has adaptive cruise control and lane-keeping assist, it's likely capable of running openpilot.
|
|
||||||
|
|
||||||
4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3/3X to your car.
|
4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3/3X to your car.
|
||||||
We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup).
|
|
||||||
|
We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup).
|
||||||
|
|
||||||
Running on PC
|
Running on PC
|
||||||
------
|
------
|
||||||
|
|
@ -58,22 +32,32 @@ All openpilot services can run as usual on a PC without requiring special hardwa
|
||||||
|
|
||||||
With openpilot's tools, you can plot logs, replay drives, and watch the full-res camera streams. See [the tools README](tools/README.md) for more information.
|
With openpilot's tools, you can plot logs, replay drives, and watch the full-res camera streams. See [the tools README](tools/README.md) for more information.
|
||||||
|
|
||||||
You can also run openpilot in simulation [with the MetaDrive simulator](tools/sim/README.md). This allows openpilot to drive around a virtual car on your Ubuntu machine. The whole setup should only take a few minutes but does require a decent GPU.
|
You can also run openpilot in simulation [with the CARLA simulator](tools/sim/README.md). This allows openpilot to drive around a virtual car on your Ubuntu machine. The whole setup should only take a few minutes but does require a decent GPU.
|
||||||
|
|
||||||
A PC running openpilot can also control your vehicle if it is connected to a [webcam](https://github.com/commaai/openpilot/tree/master/tools/webcam), a [black panda](https://comma.ai/shop/products/panda), and a [harness](https://comma.ai/shop/products/car-harness).
|
A PC running openpilot can also control your vehicle if it is connected to a [webcam](https://github.com/commaai/openpilot/tree/master/tools/webcam), a [black panda](https://comma.ai/shop/products/panda), and a [harness](https://comma.ai/shop/products/car-harness).
|
||||||
|
|
||||||
Community and Contributing
|
Community and Contributing
|
||||||
------
|
------
|
||||||
|
|
||||||
openpilot is developed by [comma](https://comma.ai/) and by users like you. We welcome both pull requests and issues on [GitHub](http://github.com/commaai/openpilot). Bug fixes and new car ports are encouraged. Check out [the contributing docs](docs/CONTRIBUTING.md).
|
openpilot is developed by [comma](https://comma.ai/) and by users like you. We welcome both pull requests and issues on [GitHub](http://github.com/commaai/openpilot).
|
||||||
|
|
||||||
Documentation related to openpilot development can be found on [docs.comma.ai](https://docs.comma.ai). Information about running openpilot (e.g. FAQ, fingerprinting, troubleshooting, custom forks, community hardware) should go on the [wiki](https://github.com/commaai/openpilot/wiki).
|
* Join the [community Discord](https://discord.comma.ai)
|
||||||
|
* Check out [the contributing docs](docs/CONTRIBUTING.md)
|
||||||
|
* Code documentation lives at https://docs.comma.ai
|
||||||
|
* Information about running openpilot lives on the [community wiki](https://github.com/commaai/openpilot/wiki)
|
||||||
|
|
||||||
You can add support for your car by following guides we have written for [Brand](https://blog.comma.ai/how-to-write-a-car-port-for-openpilot/) and [Model](https://blog.comma.ai/openpilot-port-guide-for-toyota-models/) ports. Generally, a car with adaptive cruise control and lane keep assist is a good candidate. [Join our Discord](https://discord.comma.ai) to discuss car ports: most car makes have a dedicated channel.
|
Want to get paid to work on openpilot? [comma is hiring](https://comma.ai/jobs#open-positions) and offers lots of [bounties](docs/BOUNTIES.md).
|
||||||
|
|
||||||
Want to get paid to work on openpilot? [comma is hiring](https://comma.ai/jobs#open-positions).
|
Safety and Testing
|
||||||
|
----
|
||||||
|
|
||||||
And [follow us on Twitter](https://twitter.com/comma_ai).
|
* openpilot observes [ISO26262](https://en.wikipedia.org/wiki/ISO_26262) guidelines, see [SAFETY.md](docs/SAFETY.md) for more details.
|
||||||
|
* openpilot has software-in-the-loop [tests](.github/workflows/selfdrive_tests.yaml) that run on every commit.
|
||||||
|
* The code enforcing the safety model lives in panda and is written in C, see [code rigor](https://github.com/commaai/panda#code-rigor) for more details.
|
||||||
|
* panda has software-in-the-loop [safety tests](https://github.com/commaai/panda/tree/master/tests/safety).
|
||||||
|
* Internally, we have a hardware-in-the-loop Jenkins test suite that builds and unit tests the various processes.
|
||||||
|
* panda has additional hardware-in-the-loop [tests](https://github.com/commaai/panda/blob/master/Jenkinsfile).
|
||||||
|
* We run the latest openpilot in a testing closet containing 10 comma devices continuously replaying routes.
|
||||||
|
|
||||||
User Data and comma Account
|
User Data and comma Account
|
||||||
------
|
------
|
||||||
|
|
@ -87,49 +71,6 @@ The driver-facing camera is only logged if you explicitly opt-in in settings. Th
|
||||||
|
|
||||||
By using openpilot, you agree to [our Privacy Policy](https://comma.ai/privacy). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data.
|
By using openpilot, you agree to [our Privacy Policy](https://comma.ai/privacy). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data.
|
||||||
|
|
||||||
Safety and Testing
|
|
||||||
----
|
|
||||||
|
|
||||||
* openpilot observes ISO26262 guidelines, see [SAFETY.md](docs/SAFETY.md) for more details.
|
|
||||||
* openpilot has software-in-the-loop [tests](.github/workflows/selfdrive_tests.yaml) that run on every commit.
|
|
||||||
* The code enforcing the safety model lives in panda and is written in C, see [code rigor](https://github.com/commaai/panda#code-rigor) for more details.
|
|
||||||
* panda has software-in-the-loop [safety tests](https://github.com/commaai/panda/tree/master/tests/safety).
|
|
||||||
* Internally, we have a hardware-in-the-loop Jenkins test suite that builds and unit tests the various processes.
|
|
||||||
* panda has additional hardware-in-the-loop [tests](https://github.com/commaai/panda/blob/master/Jenkinsfile).
|
|
||||||
* We run the latest openpilot in a testing closet containing 10 comma devices continuously replaying routes.
|
|
||||||
|
|
||||||
Directory Structure
|
|
||||||
------
|
|
||||||
.
|
|
||||||
├── cereal # The messaging spec and libs used for all logs
|
|
||||||
├── common # Library like functionality we've developed here
|
|
||||||
├── docs # Documentation
|
|
||||||
├── opendbc # Files showing how to interpret data from cars
|
|
||||||
├── panda # Code used to communicate on CAN
|
|
||||||
├── third_party # External libraries
|
|
||||||
└── system # Generic services
|
|
||||||
├── camerad # Driver to capture images from the camera sensors
|
|
||||||
├── hardware # Hardware abstraction classes
|
|
||||||
├── logcatd # systemd journal as a service
|
|
||||||
├── loggerd # Logger and uploader of car data
|
|
||||||
├── proclogd # Logs information from /proc
|
|
||||||
├── sensord # IMU interface code
|
|
||||||
└── ubloxd # u-blox GNSS module interface code
|
|
||||||
└── selfdrive # Code needed to drive the car
|
|
||||||
├── assets # Fonts, images, and sounds for UI
|
|
||||||
├── athena # Allows communication with the app
|
|
||||||
├── boardd # Daemon to talk to the board
|
|
||||||
├── car # Car specific code to read states and control actuators
|
|
||||||
├── controls # Planning and controls
|
|
||||||
├── debug # Tools to help you debug and do car ports
|
|
||||||
├── locationd # Precise localization and vehicle parameter estimation
|
|
||||||
├── manager # Daemon that starts/stops all other daemons as needed
|
|
||||||
├── modeld # Driving and monitoring model runners
|
|
||||||
├── monitoring # Daemon to determine driver attention
|
|
||||||
├── navd # Turn-by-turn navigation
|
|
||||||
├── test # Unit tests, system tests, and a car simulator
|
|
||||||
└── ui # The UI
|
|
||||||
|
|
||||||
Licensing
|
Licensing
|
||||||
------
|
------
|
||||||
|
|
||||||
|
|
@ -145,5 +86,5 @@ NO WARRANTY EXPRESSED OR IMPLIED.**
|
||||||
|
|
||||||
<img src="https://d1qb2nb5cznatu.cloudfront.net/startups/i/1061157-bc7e9bf3b246ece7322e6ffe653f6af8-medium_jpg.jpg?buster=1458363130" width="75"></img> <img src="https://cdn-images-1.medium.com/max/1600/1*C87EjxGeMPrkTuVRVWVg4w.png" width="225"></img>
|
<img src="https://d1qb2nb5cznatu.cloudfront.net/startups/i/1061157-bc7e9bf3b246ece7322e6ffe653f6af8-medium_jpg.jpg?buster=1458363130" width="75"></img> <img src="https://cdn-images-1.medium.com/max/1600/1*C87EjxGeMPrkTuVRVWVg4w.png" width="225"></img>
|
||||||
|
|
||||||
[](https://github.com/commaai/openpilot/actions)
|
|
||||||
[](https://codecov.io/gh/commaai/openpilot)
|
[](https://codecov.io/gh/commaai/openpilot)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue