Go to file
Willem Melching ad9ecefe65
Switch panda to scons builder (#635)
* add scons builder

* cleanup 1

* remove building from python code

* add pedal build

* fixup flags

* add EON flag

* change github actions to scons

* fixup automated tests

* move flashing scripts

* fix indent

* remove version.mk

* fix not in git

* fix linker script filename

* untested pedal flashing scripts

* add release option

* better asserts

* swap condition

* enable usb and fix flash script

* usb flash is not supported

* use button to enable dfu mode

* no usb because misra

* remove sleep
2021-03-24 14:44:32 +01:00
.github/workflows Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
board Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
certs Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
crypto Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01: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 Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
release Added build type to release version strings 2019-10-07 14:42:38 -07:00
tests Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
.dockerignore Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
.gitignore Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
.pre-commit-config.yaml Deprecate ESP (#592) 2020-08-26 15:37:50 -07:00
Dockerfile update python to 3.8.5 2021-03-11 13:47:40 -08:00
Dockerfile.panda VW MQB: Updated message and signal data, round 1 (#632) 2021-03-14 16:24:53 -07:00
Jenkinsfile Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01: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
SConstruct Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01: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 Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01:00
panda.png update readme graphics 2018-05-10 00:01:08 -07:00
requirements.txt Switch panda to scons builder (#635) 2021-03-24 14:44:32 +01: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.