sadmen
/
openpilot_comma
mirror of https://github.com/commaai/openpilot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add nice table formatting for column description

Browse Source 
Add nice table formatting for column description
pull/23762/head
Shane Smiskol 3 years ago
parent cb9350b0d4
commit b18f8073bb
3 changed files with 60 additions and 23 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 35
      docs/CARS_generated.md
  2. 47
      docs/CARS_template.md
  3. 1
      docs/cars.py

35
docs/CARS_generated.md
Unescape View File

@ -6,13 +6,36 @@ Cars are organized into three tiers:
- 🥈 Silver - a pretty good, albeit limited experience - 🥈 Silver - a pretty good, albeit limited experience
- 🥉 Bronze - a significantly limited experience - 🥉 Bronze - a significantly limited experience
Tier Criteria: How We Rate The Cars
---
<table>
<tr>
<th width="50%">openpilot Longitudinal</th>
<th>Full-Speed Range (FSR) Longitudinal</th>
</tr>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - openpilot is able to control gas and brakes<br/><img style="float: left;" src="assets/icon-star-half.png" width="22" /> - openpilot is able to control the gas and brakes with some restrictions<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - The gas and brakes are controlled by the car's stock Adaptive Cruise Control (ACC) system</td>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Adaptive Cruise Control (ACC) operates down to 0 mph <br/> <img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Adaptive Cruise Control (ACC) available only above certain speeds. See your car's manual for the minimum speed.</td>
</tr>
</table>
- openpilot Longitudinal - openpilot is able to control gas and brakes. If no star is present, the car is limited to the stock system <table>
- FSR Longitudinal - openpilot can brake and accelerate down to 0 mph <tr>
- FSR Steering - openpilot can actuate the steering wheel down to 0 mph <th width="50%">Full-Speed Range (FSR) Steering</th>
- Steering Torque - car has enough steering torque for comfortable highway driving <th>Steering Torque</th>
- Actively Maintained - mainline software support, harness hardware sold by comma.ai </tr>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - openpilot can control the steering wheel down to 0 mph<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - No steering control below certain speeds</td>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Car has enough steering torque for comfortable highway driving<br/> <img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Limited ability to make turns</td>
</tr>
</table>
<table >
<tr>
<th>Actively Maintained</th>
<td style="visibility:hidden;" width="50%"></td>
</tr>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Mainline software support, harness hardware sold by comma, lots of users, primary development target<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Low user count, community maintained, harness hardware sold by comma</td>
</tr>
</table>
**All supported cars can move between the tiers as support changes.** **All supported cars can move between the tiers as support changes.**

47
docs/CARS_template.md
Unescape View File

@ -6,23 +6,36 @@ Cars are organized into three tiers:
- 🥈 Silver - a pretty good, albeit limited experience - 🥈 Silver - a pretty good, albeit limited experience
- 🥉 Bronze - a significantly limited experience - 🥉 Bronze - a significantly limited experience
| Star | openpilot Longitudinal | Star | Full-Speed Range (FSR) Longitudinal | How We Rate The Cars
|:---------------------------------------------------:|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|-------------------------------------------------------| ---
| <img src="assets/icon-star-full.png" width="22" /> | openpilot is able to control gas and brakes | <img src="assets/icon-star-full.png" width="22" /> | Adaptive Cruise Control (ACC) operates down to 0 mph | <table>
| <img src="assets/icon-star-half.png" width="22" /> | openpilot is able to control the gas and brakes with some restrictions |<img src="assets/icon-star-half.png" width="22" /> <tr>
| <img src="assets/icon-star-empty.png" width="22" /> | The gas and brakes are controlled by the car's stock Adaptive Cruise Control (ACC) system | <th width="50%">openpilot Longitudinal</th>
<th>Full-Speed Range (FSR) Longitudinal</th>
| openpilot Longitudinal | Full-Speed Range (FSR) Longitudinal | </tr>
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------| <td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - openpilot is able to control gas and brakes<br/><img style="float: left;" src="assets/icon-star-half.png" width="22" /> - openpilot is able to control the gas and brakes with some restrictions<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - The gas and brakes are controlled by the car's stock Adaptive Cruise Control (ACC) system</td>
| <img src="assets/icon-star-full.png" width="22" /> - openpilot is able to control gas and brakes<br/><img src="assets/icon-star-half.png" width="22" /> - openpilot is able to control the gas and brakes with some restrictions<br/><img src="assets/icon-star-empty.png" width="22" /> - The gas and brakes are controlled by the car's stock Adaptive Cruise Control (ACC) system | <td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Adaptive Cruise Control (ACC) operates down to 0 mph <br/> <img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Adaptive Cruise Control (ACC) available only above certain speeds. See your car's manual for the minimum speed.</td>
</tr>
Tier Criteria: </table>
- openpilot Longitudinal - openpilot is able to control gas and brakes. If no star is present, the car is limited to the stock system <table>
- FSR Longitudinal - openpilot can brake and accelerate down to 0 mph <tr>
- FSR Steering - openpilot can actuate the steering wheel down to 0 mph <th width="50%">Full-Speed Range (FSR) Steering</th>
- Steering Torque - car has enough steering torque for comfortable highway driving <th>Steering Torque</th>
- Actively Maintained - mainline software support, harness hardware sold by comma.ai </tr>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - openpilot can control the steering wheel down to 0 mph<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - No steering control below certain speeds</td>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Car has enough steering torque for comfortable highway driving<br/> <img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Limited ability to make turns</td>
</tr>
</table>
<table >
<tr>
<th>Actively Maintained</th>
<td style="visibility:hidden;" width="50%"></td>
</tr>
<td valign="top"><img style="float: left;" src="assets/icon-star-full.png" width="22" /> - Mainline software support, harness hardware sold by comma, lots of users, primary development target<br/><img style="float: left;" src="assets/icon-star-empty.png" width="22" /> - Low user count, community maintained, harness hardware sold by comma</td>
</tr>
</table>
**All supported cars can move between the tiers as support changes.** **All supported cars can move between the tiers as support changes.**

1
docs/cars.py
Unescape View File

@ -12,6 +12,7 @@ from selfdrive.car.car_helpers import interfaces, get_interface_attr
from selfdrive.car.gm.values import CAR as GM from selfdrive.car.gm.values import CAR as GM
from selfdrive.car.hyundai.radar_interface import RADAR_START_ADDR as HKG_RADAR_START_ADDR from selfdrive.car.hyundai.radar_interface import RADAR_START_ADDR as HKG_RADAR_START_ADDR
from selfdrive.car.toyota.values import CAR as TOYOTA from selfdrive.car.toyota.values import CAR as TOYOTA
from selfdrive.car.hyundai.values import CAR as HYUNDAI
from selfdrive.car.honda.values import CAR as HONDA from selfdrive.car.honda.values import CAR as HONDA
from selfdrive.car.chrysler.values import CAR as CHRYSLER from selfdrive.car.chrysler.values import CAR as CHRYSLER
from selfdrive.car.volkswagen.values import CAR as VOLKSWAGEN from selfdrive.car.volkswagen.values import CAR as VOLKSWAGEN

Write Preview
Loading…
Cancel
Save