diff --git a/README.md b/README.md index 1aa116fa09..f1cfae9925 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,24 @@ pytest . # Run the linter pre-commit run --all-files ``` + +[`examples/`](examples/) contains small example programs that can read state from the car and control the steering, gas, and brakes. +[`examples/joystick.py`](examples/joystick.py) allows you to control a car with a joystick. + +## Roadmap + +This project was pulled out from [openpilot](https://github.com/commaai/openpilot). +We're still figuring out the exact API between openpilot and opendbc, so some of these +may end up going in openpilot. + +* Extend support to every car with LKAS + ACC interfaces +* Automatic lateral and longitudinal control/tuning evaluation +* Auto-tuning for [lateral](https://blog.comma.ai/090release/#torqued-an-auto-tuner-for-lateral-control) and longitudinal control +* [Automatic Emergency Braking](https://en.wikipedia.org/wiki/Automated_emergency_braking_system) +* `pip install opendbc` +* 100% type coverage +* 100% line coverage +* Make car ports easier: refactors, tools, tests, and docs +* Expose the state of all supported cars better: https://github.com/commaai/opendbc/issues/1144 + +Contributions towards anyting here is welcome. Join the [Discord](https://discord.comma.ai)!