code powering the comma.ai panda
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Adeeb Shihadeh d375ce6421 jenkins updates for new master 5 hours ago
.github/workflows CAN comms test (#1181) 1 week ago
board Hyundai: alt steering limits (#1186) 6 days ago
certs Deprecate ESP (#592) 2 years ago
crypto Communication refactor (#997) 4 months ago
docs move those into docs/ 12 months ago
drivers README: remove backtick typo (#1040) 4 months ago
examples Update example scripts to support canfd (#1059) 3 months ago
python Hyundai: alt steering limits (#1186) 6 days ago
release fix release script 9 months ago
tests Hyundai: alt steering limits (#1186) 6 days ago
.dockerignore Deprecate ESP (#592) 2 years ago
.gitignore Hyundai: alt steering limits (#1186) 6 days ago
.pre-commit-config.yaml HITL test fixups (#1117) 1 month ago
Dockerfile jenkins updates for new master 5 hours ago
Jenkinsfile jenkins updates for new master 5 hours ago
LICENSE initial commit 6 years ago
README.md Misc cleanup (#1161) 3 weeks ago
SConscript scons: put targets in global SConscript (#1180) 1 week ago
SConstruct scons: put targets in global SConscript (#1180) 1 week ago
__init__.py CAN comms test (#1181) 1 week ago
panda.png update readme graphics 5 years ago
requirements.txt SPI handle in python lib (#1131) 1 month ago
setup.cfg Created python package and implemented industry best practices. 6 years ago
setup.py Update libusb to 2.0.1 (#816) 11 months ago

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.

panda tests panda drivers

Usage

Setup your dependencies:

# Ubuntu
sudo apt-get install dfu-util gcc-arm-none-eabi python3-pip
pip install -r requirements.txt

# macOS
brew tap ArmMbed/homebrew-formulae
brew install python dfu-util arm-none-eabi-gcc
pip install -r requirements.txt

Python

To install the library:

git clone https://github.com/commaai/panda.git
cd panda
python setup.py install

See the Panda 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

The panda jungle uses different udev rules. See the repo for instructions.

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

The panda firmware is written for its use in conjuction with openpilot. The panda firmware, 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.
  • 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 and flashing it 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.