Legacypilot

This software includes contributions from dragonpilot and openpilot.

NOTICE: legacypilot is not affiliated with comma.ai and is not an official comma.ai product. legacypilot is released under the terms of the MIT License. See the LICENSE file for more details.

About

legacypilot is a side project that enables comma.ai EON and Comma Two devices to use the dragonpilot. This project was started after comma.ai deprecated support for the EON in version 0.7.9 and for Comma Two in version 0.8.13.1, in order to provide continued access to these devices.

legacypilot combines the Nuclear Grade Model with the latest openpilot (almost) codebase to create a hybrid solution. With the legacypilot project, we have stripped out nearly 99% of the dragonpilot code.

In summary, legacypilot is based on Openpilot 0.8.16 with the latest vehicle model support from the Openpilot master branch.

Please note that this build is and will always be in the experimental phase and may not be suitable for use as a daily driver.

I recommend using the openpilot commatwo_master branch for your daily driving needs.

Why use legacypilot

I have decided to make this side project open source for users who wish to:

Port unsupported vehicles
Evaluate end-to-end lateral and longitudinal control on previously unsupported vehicles
Understand the limitations of legacy devices
Experience pure openpilot (without the modifications of dragonpilot)
Make their own EON/C2 fork without spending hundreds of hours reverting and testing code.

By making this project open source, I hope to alleviate some of the frustration and complaints about not being able to access the dragonpilot source code.

I encourage users to consider purchasing a comma 3 for the best and up-to-date openpilot experience.

Limitations

CAN-FD and BODY features are not supported due to outdated libraries in EON/C2 firmware.
The driving AI model remains in version 0.8.16, as porting TinyGrad/PyOpenCL requires significant effort.
The driver monitoring AI model remains in version 0.8.13.
Navigation On Openpilot (NOO) is not supported, as it requires a newer driving model that is not currently available in legacypilot.
Services are not optimized for resource usage, and using all services may result in overheating issues.
Language files can only be generated in a PC due to missing Qt5 tools.

Configuration

Considering performance issues, I have turned off all logging-related services. If anyone needs to use them, they can use dp_logging parameter to enable them.
If you are not a Comma Two device, you can use the dp_no_fan_ctrl parameter to disable fan-related detection and control. =======================

What is openpilot?
Running in a car
Running on PC
Community and Contributing
User Data and comma Account
Safety and Testing
Directory Structure
Licensing

What is openpilot?

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. In addition, while openpilot is engaged, a camera-based Driver Monitoring (DM) feature alerts distracted and asleep drivers. See more about the vehicle integration and limitations.

Running on a dedicated device in a car

To use openpilot in a car, you need four things

A supported device to run this software: a comma three.
This software. The setup procedure of the comma three allows the user to enter a URL for custom software. The URL, openpilot.comma.ai will install the release version of openpilot. To install openpilot master, you can use installer.comma.ai/commaai/master, and replacing commaai with another GitHub username can install a fork.
One of the 250+ supported cars. We support Honda, Toyota, Hyundai, Nissan, Kia, Chrysler, Lexus, Acura, Audi, VW, Ford and more. If your car is not supported but has adaptive cruise control and lane-keeping assist, it's likely able to run openpilot.
A car harness to connect to your car.

We have detailed instructions for how to mount the device in a car.

Running on PC

All openpilot services can run as usual on a PC without requiring special hardware or a car. You can also run openpilot on recorded or simulated data to develop or experiment with openpilot.

With openpilot's tools, you can plot logs, replay drives, and watch the full-res camera streams. See the tools README for more information.

You can also run openpilot in simulation with the CARLA simulator. 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, a black panda, and a harness.

Community and Contributing

openpilot is developed by comma and by users like you. We welcome both pull requests and issues on GitHub. Bug fixes and new car ports are encouraged. Check out the contributing docs.

Documentation related to openpilot development can be found on docs.comma.ai. Information about running openpilot (e.g. FAQ, fingerprinting, troubleshooting, custom forks, community hardware) should go on the wiki.

You can add support for your car by following guides we have written for Brand and Model ports. Generally, a car with adaptive cruise control and lane keep assist is a good candidate. Join our Discord to discuss car ports: most car makes have a dedicated channel.

Want to get paid to work on openpilot? comma is hiring.

And follow us on Twitter.

User Data and comma Account

By default, openpilot uploads the driving data to our servers. You can also access your data through comma connect. We use your data to train better models and improve openpilot for everyone.

openpilot is open source software: the user is free to disable data collection if they wish to do so.

openpilot logs the road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs. The driver-facing camera is only logged if you explicitly opt-in in settings. The microphone is not recorded.

By using openpilot, you agree to our Privacy Policy. 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 for more details.
openpilot has software-in-the-loop tests that run on every commit.
The code enforcing the safety model lives in panda and is written in C, see code rigor for more details.
panda has software-in-the-loop safety tests.
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.
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
    ├── clocksd         # Broadcasts current time
    ├── 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

openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified.

Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user.

THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT. YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS. NO WARRANTY EXPRESSED OR IMPLIED.

Edison-CBS/legacypilot