Vehicle Researcher 35bd9d9fb3 Squashed 'opendbc/' changes from f1e69a6cf..e92e74311
e92e74311 whitespace after comma
5d33ec0f1 two spaces before inline comment
73685b609 fix linter complaint about whitespace around operators
b15edbc1b fix linter complaint about inline comment whitespace
4ac30725b clean up blank lines
0430bfa5c run pre commit in ci (#268)
2ade6eeba Subaru DBC update (#242)
d1185a53e Toyota ACC_CONTROL PERMIT_BRAKING and ACCEL_CMT_ALT speculated definition (#258)
e6766bbbb Update SCC ECU Messages for OP Long Dev. (#267)
b49b9ee75 Add DAW (#175)
3b5cccba0 Fixed up cell voltage readings and added more commands (#220)
8b0449327 Mazda: add missing static bits, tidy up endianness  (#263)
124719992 Add BSD_RCTA to Subaru Global (#244)
af1821f84 fix endianness in signal from new hyundai message
7ef41084b Add gas/brake message for hyundai EVs, from @TK211X
472aabb4f Subaru preglobal update (#260)
45c0d9ecc fix lta message (#262)
11343c108 Library cleanup (#261)
67d70cb86 Fix Toyota message size

git-subtree-dir: opendbc
git-subtree-split: e92e74311a7ed66922629bec4b8cee7c8db1b9f0
2020-05-31 13:22:45 -07:00

opendbc

The project to democratize access to the decoder ring of your car.

DBC file basics

A DBC file encodes, in a humanly readable way, the information needed to understand a vehicle's CAN bus traffic. A vehicle might have multiple CAN buses and every CAN bus is represented by its own dbc file. Wondering what's the DBC file format? Here and Here a couple of good overviews.

How to start reverse engineering cars

opendbc is integrated with cabana.

Use panda to connect your car to a computer.

How to use reverse engineered DBC

To create custom CAN simulations or send reverse engineered signals back to the car you can use CANdevStudio project.

DBC file preprocessor

DBC files for different models of the same brand have a lot of overlap. Therefore, we wrote a preprocessor to create DBC files from a brand DBC file and a model specific DBC file. The source DBC files can be found in the generator folder. After changing one of the files run the generator.py script to regenerate the output files. These output files will be placed in the root of the opendbc repository and are suffixed by _generated.

Good practices for contributing to opendbc

  • Comments: the best way to store comments is to add them directly to the DBC files. For example:

    CM_ SG_ 490 LONG_ACCEL "wheel speed derivative, noisy and zero snapping";
    

    is a comment that refers to signal LONG_ACCEL in message 490. Using comments is highly recommended, especially for doubts and uncertainties. cabana can easily display/add/edit comments to signals and messages.

  • Units: when applicable, it's recommended to convert signals into physical units, by using a proper signal factor. Using a SI unit is preferred, unless a non-SI unit rounds the signal factor much better. For example:

    SG_ VEHICLE_SPEED : 7|15@0+ (0.00278,0) [0|70] "m/s" PCM
    

    is better than:

    SG_ VEHICLE_SPEED : 7|15@0+ (0.00620,0) [0|115] "mph" PCM
    

    However, the cleanest option is really:

    SG_ VEHICLE_SPEED : 7|15@0+ (0.01,0) [0|250] "kph" PCM
    
  • Signal size: always use the smallest amount of bits possible. For example, let's say I'm reverse engineering the gas pedal position and I've determined that it's in a 3 bytes message. For 0% pedal position I read a message value of 0x00 0x00 0x00, while for 100% of pedal position I read 0x64 0x00 0x00: clearly, the gas pedal position is within the first byte of the message and I might be tempted to define the signal GAS_POS as:

    SG_ GAS_POS : 7|8@0+ (1,0) [0|100] "%" PCM
    

    However, I can't be sure that the very first bit of the message is referred to the pedal position: I haven't seen it changing! Therefore, a safer way of defining the signal is:

    SG_ GAS_POS : 6|7@0+ (1,0) [0|100] "%" PCM
    

    which leaves the first bit unallocated. This prevents from very erroneous reading of the gas pedal position, in case the first bit is indeed used for something else.

Languages
Python 66%
C 20.2%
C++ 4.5%
Cuda 3.6%
Metal 1.6%
Other 4%