Update Docs (#22229)
* initial move of docs
* more cleanups
* more docs
* simpler
* more docs
* link fix
* typos
* more typos
* more info
* minor updates
old-commit-hash: 105be028bd
commatwo_master
George Hotz
4 years ago
committed by
GitHub
parent
8877772a95
commit
30bd49c3b7
6 changed files with 262 additions and 286 deletions
@ -0,0 +1,163 @@ |
|||||||
|
Supported Cars |
||||||
|
------ |
||||||
|
|
||||||
|
| Make | Model (US Market Reference) | Supported Package | ACC | No ACC accel below | No ALC below | |
||||||
|
| ----------| ------------------------------| ------------------| -----------------| -------------------| ------------------| |
||||||
|
| Acura | ILX 2016-19 | AcuraWatch Plus | openpilot | 25mph<sup>1</sup> | 25mph | |
||||||
|
| Acura | RDX 2016-18 | AcuraWatch Plus | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Acura | RDX 2019-21 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Accord 2018-20 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Accord Hybrid 2018-20 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Civic Hatchback 2017-21 | Honda Sensing | Stock | 0mph | 12mph | |
||||||
|
| Honda | Civic Coupe 2016-18 | Honda Sensing | openpilot | 0mph | 12mph | |
||||||
|
| Honda | Civic Coupe 2019-20 | All | Stock | 0mph | 2mph<sup>2</sup> | |
||||||
|
| Honda | Civic Sedan 2016-18 | Honda Sensing | openpilot | 0mph | 12mph | |
||||||
|
| Honda | Civic Sedan 2019-20 | All | Stock | 0mph | 2mph<sup>2</sup> | |
||||||
|
| Honda | CR-V 2015-16 | Touring | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Honda | CR-V 2017-21 | Honda Sensing | Stock | 0mph | 12mph | |
||||||
|
| Honda | CR-V Hybrid 2017-2019 | Honda Sensing | Stock | 0mph | 12mph | |
||||||
|
| Honda | e 2020 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Fit 2018-19 | Honda Sensing | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Honda | HR-V 2019-20 | Honda Sensing | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Honda | Insight 2019-21 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Inspire 2018 | All | Stock | 0mph | 3mph | |
||||||
|
| Honda | Odyssey 2018-20 | Honda Sensing | openpilot | 25mph<sup>1</sup> | 0mph | |
||||||
|
| Honda | Passport 2019 | All | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Honda | Pilot 2016-19 | Honda Sensing | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Honda | Ridgeline 2017-21 | Honda Sensing | openpilot | 25mph<sup>1</sup> | 12mph | |
||||||
|
| Hyundai | Palisade 2020-21 | All | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Sonata 2020-21 | All | Stock | 0mph | 0mph | |
||||||
|
| Lexus | CT Hybrid 2017-18 | LSS | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | ES 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Lexus | ES Hybrid 2017-18 | LSS | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | ES Hybrid 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Lexus | IS 2017-2019 | All | Stock | 22mph | 0mph | |
||||||
|
| Lexus | NX 2018 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | NX 2020 | All | openpilot | 0mph | 0mph | |
||||||
|
| Lexus | NX Hybrid 2018-19 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | RX 2016-18 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | RX 2020-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Lexus | RX Hybrid 2016-19 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Lexus | RX Hybrid 2020-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Lexus | UX Hybrid 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Alphard 2020 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Avalon 2016-21 | TSS-P | Stock<sup>3</sup>| 20mph<sup>1</sup> | 0mph | |
||||||
|
| Toyota | Avalon Hybrid 2019-21 | TSS-P | Stock<sup>3</sup>| 20mph<sup>1</sup> | 0mph | |
||||||
|
| Toyota | Camry 2018-20 | All | Stock | 0mph<sup>4</sup> | 0mph | |
||||||
|
| Toyota | Camry 2021 | All | openpilot | 0mph<sup>4</sup> | 0mph | |
||||||
|
| Toyota | Camry Hybrid 2018-20 | All | Stock | 0mph<sup>4</sup> | 0mph | |
||||||
|
| Toyota | Camry Hybrid 2021 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | C-HR 2017-20 | All | Stock | 0mph | 0mph | |
||||||
|
| Toyota | C-HR Hybrid 2017-19 | All | Stock | 0mph | 0mph | |
||||||
|
| Toyota | Corolla 2017-19 | All | Stock<sup>3</sup>| 20mph<sup>1</sup> | 0mph | |
||||||
|
| Toyota | Corolla 2020-22 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Corolla Hatchback 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Corolla Hybrid 2020-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Highlander 2017-19 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Toyota | Highlander 2020-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Highlander Hybrid 2017-19 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Toyota | Highlander Hybrid 2020-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Mirai 2021 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Prius 2016-20 | TSS-P | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Toyota | Prius 2021 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Prius Prime 2017-20 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Toyota | Prius Prime 2021 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Rav4 2016-18 | TSS-P | Stock<sup>3</sup>| 20mph<sup>1</sup> | 0mph | |
||||||
|
| Toyota | Rav4 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Rav4 Hybrid 2016-18 | TSS-P | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
| Toyota | Rav4 Hybrid 2019-21 | All | openpilot | 0mph | 0mph | |
||||||
|
| Toyota | Sienna 2018-20 | All | Stock<sup>3</sup>| 0mph | 0mph | |
||||||
|
|
||||||
|
<sup>1</sup>[Comma Pedal](https://github.com/commaai/openpilot/wiki/comma-pedal) is used to provide stop-and-go capability to some of the openpilot-supported cars that don't currently support stop-and-go. ***NOTE: The Comma Pedal is not officially supported by [comma](https://comma.ai).*** <br /> |
||||||
|
<sup>2</sup>2019 Honda Civic 1.6L Diesel Sedan does not have ALC below 12mph. <br /> |
||||||
|
<sup>3</sup>When disconnecting the Driver Support Unit (DSU), openpilot ACC will replace stock ACC. ***NOTE: disconnecting the DSU disables Automatic Emergency Braking (AEB).*** <br /> |
||||||
|
<sup>4</sup>28mph for Camry 4CYL L, 4CYL LE and 4CYL SE which don't have Full-Speed Range Dynamic Radar Cruise Control. <br /> |
||||||
|
|
||||||
|
Community Maintained Cars and Features |
||||||
|
------ |
||||||
|
|
||||||
|
| Make | Model (US Market Reference) | Supported Package | ACC | No ACC accel below | No ALC below | |
||||||
|
| ----------| ------------------------------| ------------------| -----------------| -------------------| -------------| |
||||||
|
| Audi | A3 2014-19 | Prestige | Stock | 0mph | 0mph | |
||||||
|
| Audi | A3 Sportback e-tron 2017-18 | Prestige | Stock | 0mph | 0mph | |
||||||
|
| Audi | Q2 2018 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Buick | Regal 2018<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Cadillac | ATS 2018<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Chevrolet | Malibu 2017<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Chevrolet | Volt 2017-18<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Chrysler | Pacifica 2017-18 | Adaptive Cruise | Stock | 0mph | 9mph | |
||||||
|
| Chrysler | Pacifica 2020 | Adaptive Cruise | Stock | 0mph | 39mph | |
||||||
|
| Chrysler | Pacifica Hybrid 2017-18 | Adaptive Cruise | Stock | 0mph | 9mph | |
||||||
|
| Chrysler | Pacifica Hybrid 2019-21 | Adaptive Cruise | Stock | 0mph | 39mph | |
||||||
|
| Genesis | G70 2018 | All | Stock | 0mph | 0mph | |
||||||
|
| Genesis | G80 2018 | All | Stock | 0mph | 0mph | |
||||||
|
| Genesis | G90 2018 | All | Stock | 0mph | 0mph | |
||||||
|
| GMC | Acadia 2018<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Holden | Astra 2017<sup>1</sup> | Adaptive Cruise | openpilot | 0mph | 7mph | |
||||||
|
| Hyundai | Elantra 2017-19 | SCC + LKAS | Stock | 19mph | 34mph | |
||||||
|
| Hyundai | Elantra 2021 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Elantra Hybrid 2021 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Genesis 2015-16 | SCC + LKAS | Stock | 19mph | 37mph | |
||||||
|
| Hyundai | Ioniq Electric 2019 | SCC + LKAS | Stock | 0mph | 32mph | |
||||||
|
| Hyundai | Ioniq Electric 2020 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Ioniq PHEV 2020 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Kona 2020 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Kona EV 2018-19 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Kona Hybrid 2020 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Santa Fe 2019-20 | All | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Sonata 2018-2019 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Sonata Hybrid 2021 | All | Stock | 0mph | 0mph | |
||||||
|
| Hyundai | Veloster 2019-20 | SCC + LKAS | Stock | 5mph | 0mph | |
||||||
|
| Jeep | Grand Cherokee 2016-18 | Adaptive Cruise | Stock | 0mph | 9mph | |
||||||
|
| Jeep | Grand Cherokee 2019-20 | Adaptive Cruise | Stock | 0mph | 39mph | |
||||||
|
| Kia | Forte 2018-21 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Niro EV 2019-21 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Niro Hybrid 2021 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Niro PHEV 2019 | SCC + LKAS | Stock | 10mph | 32mph | |
||||||
|
| Kia | Optima 2017 | SCC + LKAS | Stock | 0mph | 32mph | |
||||||
|
| Kia | Optima 2019 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Seltos 2021 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Sorento 2018-19 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Stinger 2018 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Ceed 2019 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Kia | Telluride 2020 | SCC + LKAS | Stock | 0mph | 0mph | |
||||||
|
| Nissan | Altima 2019-20 | ProPILOT | Stock | 0mph | 0mph | |
||||||
|
| Nissan | Leaf 2018-20 | ProPILOT | Stock | 0mph | 0mph | |
||||||
|
| Nissan | Rogue 2018-20 | ProPILOT | Stock | 0mph | 0mph | |
||||||
|
| Nissan | X-Trail 2017 | ProPILOT | Stock | 0mph | 0mph | |
||||||
|
| SEAT | Ateca 2018 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| SEAT | Leon 2014-2020 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Karoq 2019 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Kodiaq 2018-19 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Octavia 2015, 2018-19 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Octavia RS 2016 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Scala 2020 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Škoda | Superb 2015-18 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Subaru | Ascent 2019 | EyeSight | Stock | 0mph | 0mph | |
||||||
|
| Subaru | Crosstrek 2018-19 | EyeSight | Stock | 0mph | 0mph | |
||||||
|
| Subaru | Forester 2019-21 | EyeSight | Stock | 0mph | 0mph | |
||||||
|
| Subaru | Impreza 2017-19 | EyeSight | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Atlas 2018-19 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| e-Golf 2014, 2019-20 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf 2015-20 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf Alltrack 2017-18 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf GTE 2016 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf GTI 2018-20 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf R 2016-19 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf SportsVan 2016 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Golf SportWagen 2015 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Jetta 2018-20 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Jetta GLI 2021 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Passat 2016-17<sup>2</sup> | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| T-Cross 2021 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Tiguan 2020 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
| Volkswagen| Touran 2017 | Driver Assistance | Stock | 0mph | 0mph | |
||||||
|
|
||||||
|
<sup>1</sup>Requires an [OBD-II car harness](https://comma.ai/shop/products/comma-car-harness) and [community built ASCM harness](https://github.com/commaai/openpilot/wiki/GM#hardware). ***NOTE: disconnecting the ASCM disables Automatic Emergency Braking (AEB).*** <br /> |
||||||
|
<sup>2</sup>Only includes the MQB Passat sold outside of North America. The NMS Passat made in Chattanooga TN is not yet supported. |
||||||
|
|
||||||
|
Community Maintained Cars and Features are not verified by comma to meet our [safety model](SAFETY.md). Be extra cautious using them. They are only available after enabling the toggle in `Settings->Developer->Enable Community Features`. |
||||||
|
|
||||||
|
To promote a car from community maintained, it must meet a few requirements. We must own one from the brand, we must sell the harness for it, has full ISO26262 in both panda and openpilot, there must be a path forward for longitudinal control, it must have AEB still enabled, and it must support fingerprinting 2.0 |
||||||
|
|
||||||
|
Although they're not upstream, the community has openpilot running on other makes and models. See the 'Community Supported Models' section of each make [on our wiki](https://wiki.comma.ai/). |
||||||
@ -0,0 +1,73 @@ |
|||||||
|
Integration with Stock Features |
||||||
|
------ |
||||||
|
|
||||||
|
In all supported cars: |
||||||
|
* Stock Lane Keep Assist (LKA) and stock ALC are replaced by openpilot ALC, which only functions when openpilot is engaged by the user. |
||||||
|
* Stock LDW is replaced by openpilot LDW. |
||||||
|
|
||||||
|
Additionally, on specific supported cars (see ACC column in [supported cars](docs/CARS.md)): |
||||||
|
* Stock ACC is replaced by openpilot ACC. |
||||||
|
* openpilot FCW operates in addition to stock FCW. |
||||||
|
|
||||||
|
openpilot should preserve all other vehicle's stock features, including, but are not limited to: FCW, Automatic Emergency Braking (AEB), auto high-beam, blind spot warning, and side collision warning. |
||||||
|
|
||||||
|
Limitations of openpilot ALC and LDW |
||||||
|
------ |
||||||
|
|
||||||
|
openpilot ALC and openpilot LDW do not automatically drive the vehicle or reduce the amount of attention that must be paid to operate your vehicle. The driver must always keep control of the steering wheel and be ready to correct the openpilot ALC action at all times. |
||||||
|
|
||||||
|
While changing lanes, openpilot is not capable of looking next to you or checking your blind spot. Only nudge the wheel to initiate a lane change after you have confirmed it's safe to do so. |
||||||
|
|
||||||
|
Many factors can impact the performance of openpilot ALC and openpilot LDW, causing them to be unable to function as intended. These include, but are not limited to: |
||||||
|
|
||||||
|
* Poor visibility (heavy rain, snow, fog, etc.) or weather conditions that may interfere with sensor operation. |
||||||
|
* The road facing camera is obstructed, covered or damaged by mud, ice, snow, etc. |
||||||
|
* Obstruction caused by applying excessive paint or adhesive products (such as wraps, stickers, rubber coating, etc.) onto the vehicle. |
||||||
|
* The device is mounted incorrectly. |
||||||
|
* When in sharp curves, like on-off ramps, intersections etc...; openpilot is designed to be limited in the amount of steering torque it can produce. |
||||||
|
* In the presence of restricted lanes or construction zones. |
||||||
|
* When driving on highly banked roads or in presence of strong cross-wind. |
||||||
|
* Extremely hot or cold temperatures. |
||||||
|
* Bright light (due to oncoming headlights, direct sunlight, etc.). |
||||||
|
* Driving on hills, narrow, or winding roads. |
||||||
|
|
||||||
|
The list above does not represent an exhaustive list of situations that may interfere with proper operation of openpilot components. It is the driver's responsibility to be in control of the vehicle at all times. |
||||||
|
|
||||||
|
Limitations of openpilot ACC and FCW |
||||||
|
------ |
||||||
|
|
||||||
|
openpilot ACC and openpilot FCW are not systems that allow careless or inattentive driving. It is still necessary for the driver to pay close attention to the vehicle’s surroundings and to be ready to re-take control of the gas and the brake at all times. |
||||||
|
|
||||||
|
Many factors can impact the performance of openpilot ACC and openpilot FCW, causing them to be unable to function as intended. These include, but are not limited to: |
||||||
|
|
||||||
|
* Poor visibility (heavy rain, snow, fog, etc.) or weather conditions that may interfere with sensor operation. |
||||||
|
* The road facing camera or radar are obstructed, covered, or damaged by mud, ice, snow, etc. |
||||||
|
* Obstruction caused by applying excessive paint or adhesive products (such as wraps, stickers, rubber coating, etc.) onto the vehicle. |
||||||
|
* The device is mounted incorrectly. |
||||||
|
* Approaching a toll booth, a bridge or a large metal plate. |
||||||
|
* When driving on roads with pedestrians, cyclists, etc... |
||||||
|
* In presence of traffic signs or stop lights, which are not detected by openpilot at this time. |
||||||
|
* When the posted speed limit is below the user selected set speed. openpilot does not detect speed limits at this time. |
||||||
|
* In presence of vehicles in the same lane that are not moving. |
||||||
|
* When abrupt braking maneuvers are required. openpilot is designed to be limited in the amount of deceleration and acceleration that it can produce. |
||||||
|
* When surrounding vehicles perform close cut-ins from neighbor lanes. |
||||||
|
* Driving on hills, narrow, or winding roads. |
||||||
|
* Extremely hot or cold temperatures. |
||||||
|
* Bright light (due to oncoming headlights, direct sunlight, etc.). |
||||||
|
* Interference from other equipment that generates radar waves. |
||||||
|
|
||||||
|
The list above does not represent an exhaustive list of situations that may interfere with proper operation of openpilot components. It is the driver's responsibility to be in control of the vehicle at all times. |
||||||
|
|
||||||
|
Limitations of openpilot DM |
||||||
|
------ |
||||||
|
|
||||||
|
openpilot DM should not be considered an exact measurement of the alertness of the driver. |
||||||
|
|
||||||
|
Many factors can impact the performance of openpilot DM, causing it to be unable to function as intended. These include, but are not limited to: |
||||||
|
|
||||||
|
* Low light conditions, such as driving at night or in dark tunnels. |
||||||
|
* Bright light (due to oncoming headlights, direct sunlight, etc.). |
||||||
|
* The driver's face is partially or completely outside field of view of the driver facing camera. |
||||||
|
* The driver facing camera is obstructed, covered, or damaged. |
||||||
|
|
||||||
|
The list above does not represent an exhaustive list of situations that may interfere with proper operation of openpilot components. A driver should not rely on openpilot DM to assess their level of attention. |
||||||
Loading…
Reference in new issue