Skip to content

Latest commit

 

History

History
executable file
·
201 lines (150 loc) · 14 KB

README.md

File metadata and controls

executable file
·
201 lines (150 loc) · 14 KB

OPGM - Wide compatibility openpilot port collection for GM Vehicles

Chevy Equinox

Table of Contents


What is OPGM?

OPGM is a fork of openpilot that enables level-2 autonomous driving support for many GM Vehicles not yet supported by comma.ai. This fork is regularly updated with the official upstream openpilot, typicically within a few days of their master branch (bleeding edge). The goal has always been to seek to upstream as much as possible, and we are remarkably close: the Silverado, GMC Sierra and Bolt EUV will likely be gaining official comma.ai support in the next few upstream releases. The Suburban, Tahoe, and 2022 Bolt EV LT2 should be inbound very soon thereafter!

The GM Camera Harness (previously referred to as the Bolt EV Harness (See link for schematic) is also on the path to official support. It has been 3 LONG years in the making, but it looks like finally the goal is in sight!

This support will effectively open the door for official comma.ai support (no need for custom Forks or hardware) for ANY GM vehicle with Lane-Keep Assist and Adaptive Cruise Control manufactured between 2016 and 2022 (with some exceptions...)

OPGM isn't going anywhere any time soon either. Vehicles without built-in Adaptive Cruise will continue to be supported in OPGM with the use of a Comma Pedal. I'm hoping to continue supporting the Comma 2, EON, and White/black panda hardware as long as possible (Note that this has been on hold due to upstreaming efforts)

Don't feel like waiting for the upstream? You will need to purchase a few things. Get the following two products from comma.ai:

You will also need the GM Camera harness - you can make it yourself or buy one from BearTechWorkshop run by Discord user tinybear

  • GM Camera Harness
    • Note: I am submitting the schematics to comma.ai as part of the Silverado port - I expect they will eventually take over the manufacture
  • Only if your car doesn't have Adaptive Cruise Comma Pedal
    • Note 1: OPGM uses openpilot's vision-only ACC, which is not yet supported by comma.ai
    • Note 2: The Pedal (currently) requires custom GM firmware (from the OPGM repo); flashing requires a special cable (you can also build yourself, buy from comma or tinybear)
    • Note 3: OP with a Pedal performing ACC on a gas-powered vehicle is unable to apply the brakes (yet) - it still works well enough in many cases

You can also hop on the openpilot Community Discord and / or the official comma.ai Discord should you need assistance, or want to inquire about a new model.

OPGM is just as free and open source as openpilot... except all the effort is volunteer. While never required, if you find this useful and would like to help keep it going, consider a donation!

If you would like a shoutout on the Stand Back Labs Youtube Channel please mention it in the comments!


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 150+ supported cars. We support Honda, Toyota, Hyundai, Nissan, Kia, Chrysler, Lexus, Acura, Audi, VW, 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 of openpilot's services can run as normal on a PC, even without special hardware or a car. To develop or experiment with openpilot you can run openpilot on recorded or simulated data.

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 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
├── pyextra             # Extra python packages
└── system              # Generic services
    ├── logcatd         # systemd journal as a service
    └── proclogd        # Logs information from /proc
└── 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
    ├── camerad         # Driver to capture images from the camera sensors
    ├── car             # Car specific code to read states and control actuators
    ├── common          # Shared C/C++ code for the daemons
    ├── controls        # Planning and controls
    ├── debug           # Tools to help you debug and do car ports
    ├── locationd       # Precise localization and vehicle parameter estimation
    ├── loggerd         # Logger and uploader of car data
    ├── modeld          # Driving and monitoring model runners
    ├── proclogd        # Logs information from proc
    ├── sensord         # IMU interface code
    ├── 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.


openpilot tests Total alerts Language grade: Python Language grade: C/C++ codecov