code powering the comma.ai panda
Go to file
Jason Young 75ec1a0c6a Bump openpilot commit ref 2021-03-11 16:27:39 -05:00
.github/workflows ubuntu 16.04 -> 20.04 (#608) 2020-10-23 23:14:58 -07:00
board EPS_01 -> LH_EPS_03 2021-03-10 07:51:47 -05:00
certs Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
common Fix Pedal bootstub version 2019-03-22 21:06:47 -07:00
crypto Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
docs Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
drivers get value by reference in ranged based loop (#624) 2021-01-27 12:01:23 +01:00
examples Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
python Add support for variable UDS RX offsets (#631) 2021-03-07 20:33:55 -08:00
release Added build type to release version strings 2019-10-07 14:42:38 -07:00
tests EPS_01 -> LH_EPS_03 2021-03-10 07:51:47 -05:00
.dockerignore Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
.gitignore ignore everything from vscode 2021-02-13 11:14:28 +01:00
.pre-commit-config.yaml Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
Dockerfile ubuntu 16.04 -> 20.04 (#608) 2020-10-23 23:14:58 -07:00
Dockerfile.panda Bump openpilot commit ref 2021-03-11 16:27:39 -05:00
Jenkinsfile Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
LICENSE initial commit 2017-04-06 18:11:36 -07:00
README.md Remove reference to missing image 2020-09-09 15:27:50 +02:00
UPDATING.md more Python 3 fixes, attempting to fix jenkins wifi regresison test (#295) 2019-10-10 12:34:52 -07:00
VERSION Make sure relay faults make it to the health packet (#492) 2020-04-09 15:53:46 -07:00
__init__.py Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
panda.png update readme graphics 2018-05-10 00:01:08 -07:00
requirements.txt ubuntu 16.04 -> 20.04 (#608) 2020-10-23 23:14:58 -07:00
run_automated_tests.sh Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
setup.cfg Created python package and implemented industry best practices. 2017-06-14 12:00:04 -07:00
setup.py Replace pycrypto with pycryptodome (#581) 2020-08-05 12:58:43 -07:00

README.md

Welcome to panda

panda is the nicest universal car interface ever.

It supports 3x CAN, 2x LIN, and 1x GMLAN. It also charges a phone. On the computer side, it has USB.

It uses an STM32F413.

It is 2nd gen hardware, reusing code and parts from the NEO interface board.

panda tests panda drivers

Usage

Python

To install the library:

pip install pandacan

See this class for how to interact with the panda.

For example, to receive CAN messages:

>>> from panda import Panda
>>> panda = Panda()
>>> panda.can_recv()

And to send one on bus 0:

>>> panda.can_send(0x1aa, "message", 0)

Note that you may have to setup udev rules for Linux, such as

sudo tee /etc/udev/rules.d/11-panda.rules <<EOF
SUBSYSTEM=="usb", ATTRS{idVendor}=="bbaa", ATTRS{idProduct}=="ddcc", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="bbaa", ATTRS{idProduct}=="ddee", MODE="0666"
EOF
sudo udevadm control --reload-rules && sudo udevadm trigger

JavaScript

See PandaJS

Software interface support

As a universal car interface, it should support every reasonable software interface.

Directory structure

  • board -- Code that runs on the STM32
  • drivers -- Drivers (not needed for use with python)
  • python   -- Python userspace library for interfacing with the panda
  • tests -- Tests and helper programs for panda

Programming

See board/README.md

Debugging

To print out the serial console from the STM32, run tests/debug_console.py

Safety Model

When a panda powers up, by default it's in SAFETY_SILENT mode. While in SAFETY_SILENT mode, the buses are also forced to be silent. In order to send messages, you have to select a safety mode. Currently, setting safety modes is only supported over USB. Some of safety modes (for example SAFETY_ALLOUTPUT) are disabled in release firmwares. In order to use them, compile and flash your own build.

Safety modes optionally supports controls_allowed, which allows or blocks a subset of messages based on a customizable state in the board.

Code Rigor

When compiled from the EON or comma two dev kits, the panda FW is configured and optimized (at compile time) for its use in conjuction with openpilot. The panda FW, through its safety model, provides and enforces the openpilot safety. Due to its critical function, it's important that the application code rigor within the board folder is held to high standards.

These are the CI regression tests we have in place:

  • A generic static code analysis is performed by cppcheck.
  • In addition, cppcheck has a specific addon to check for MISRA C:2012 violations. See current coverage.
  • Compiler options are relatively strict: the flags -Wall -Wextra -Wstrict-prototypes -Werror are enforced on board and pedal Makefiles.
  • The safety logic is tested and verified by unit tests for each supported car variant.
  • A recorded drive for each supported car variant is replayed through the safety logic to ensure that the behavior remains unchanged.
  • An internal Hardware-in-the-loop test, which currently only runs on pull requests opened by comma.ai's organization members, verifies the following functionalities:
    • compiling the code in various configuration and flashing it both through USB.
    • Receiving, sending and forwarding CAN messages on all buses, over USB.

In addition, we run the pylint and flake8 linters on all python files within the panda repo.

Hardware

Check out the hardware guide

Licensing

panda software is released under the MIT license unless otherwise specified.