code powering the comma.ai panda
Go to file
Willem Melching e0a706e4f0
Stricter pylint (#550)
* stricter pylint

* Add as argument
2020-06-02 16:27:07 -07:00
.github/workflows Add pre commit checks + CI (#545) 2020-05-29 11:52:03 -07:00
board this fixes the fw on newer compilers. haven't figured out why it broke yet (#549) 2020-06-02 14:21:41 -07:00
boardesp match safety enum in cereal (#285) 2019-10-02 18:20:32 -07:00
certs add crypto stuff to ESP as well 2017-04-27 22:06:31 -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 White Panda's Wi-Fi setup instructions (#457) 2020-03-02 14:50:45 -08:00
drivers update J2534 download link 2020-01-02 13:39:07 -08:00
examples Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
python Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
release Added build type to release version strings 2019-10-07 14:42:38 -07:00
tests Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
.dockerignore Jenkins (#179) 2019-04-09 14:09:18 -07:00
.gitignore fix typing errors 2020-05-28 14:06:13 -07:00
.pre-commit-config.yaml Stricter pylint (#550) 2020-06-02 16:27:07 -07:00
Dockerfile Panda Jungle testing (#394) 2019-11-26 16:18:34 -08:00
Dockerfile.panda Add pre commit checks + CI (#545) 2020-05-29 11:52:03 -07:00
Jenkinsfile Panda Jungle testing (#394) 2019-11-26 16:18:34 -08:00
LICENSE initial commit 2017-04-06 18:11:36 -07:00
README.md GitHub Actions (#535) 2020-05-17 19:53:23 -07:00
TODO update TODO 2017-05-29 11:38:49 -07: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 Add pre commit checks + CI (#545) 2020-05-29 11:52:03 -07:00
buy.png update price 2019-05-22 08:32:56 -07:00
panda.png update readme graphics 2018-05-10 00:01:08 -07:00
requirements.txt Add pre commit checks + CI (#545) 2020-05-29 11:52:03 -07:00
run_automated_tests.sh DFU fix (#288) 2019-10-03 19:46:28 -07:00
setup.cfg Created python package and implemented industry best practices. 2017-06-14 12:00:04 -07:00
setup.py Enable almost all Flake8 checks (#548) 2020-06-01 01:49:26 -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 both USB and Wi-Fi.

It uses an STM32F413 for low level stuff and an ESP8266 for Wi-Fi. They are connected over high speed SPI, so the panda is actually capable of dumping the full contents of the busses over Wi-Fi, unlike every other dongle on amazon. ELM327 is weak, panda is strong.

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

panda tests

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)

Find user made scripts on the wiki

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

Usage (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
  • boardesp -- Code that runs on the ESP8266
  • 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 (over USB)

Programming the Board (STM32)

Programming the ESP

Debugging

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

To print out the serial console from the ESP8266, run PORT=1 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.

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 an EON Dev Kit, 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 and WiFi.
    • Receiving, sending and forwarding CAN messages on all buses, over USB and WiFi.

In addition, we run 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.