panda/README.md

Welcome to panda
======

[panda](http://github.com/commaai/panda) is the nicest universal car interface you've ever seen. 

It supports 3x CAN, 2x LIN, and 1x GMLAN.

It uses an [STM32F413](http://www.st.com/en/microcontrollers/stm32f413-423.html?querycriteria=productId=LN2004) for low level stuff and an [ESP8266](https://en.wikipedia.org/wiki/ESP8266) for wifi. They are connected over high speed SPI, so the panda is actually capable of dumping the full contents of the busses over wifi, unlike every other dongle on amazon. ELM327 is weak, panda is strong.

It is 2nd gen hardware, reusing code and parts from the [NEO](https://github.com/commaai/neo) interface board.

Usage
------

See [panda.py](https://github.com/commaai/panda/blob/master/lib/panda.py) for how to interact with the panda.

For example, to receive CAN messages:
```
>>> from panda.lib.panda import Panda
>>> panda = Panda()
>>> panda.can_recv()
```
And to send one on bus 0:
```
>>> panda.can_send(0x1aa, "message", 0)
```
More examples coming soon

Directory structure
------

- board      -- Code that runs on the STM32
- boardesp   -- Code that runs on the ESP8266
- lib        -- Python userspace library for interfacing with the panda
- tests      -- Tests and helper programs for panda

Programming (over USB)
------

Programming the STM32
```
cd board
./get_sdk.sh
make
```

Programming the ESP
```
cd boardesp
./get_sdk.sh
make
```

Hardware
------
Check out the hardware [guide](https://github.com/commaai/panda/blob/master/docs/guide.pdf)

Licensing
------

panda software is released under the MIT license. See LICENSE
initial commit 2017-04-07 09:11:36 +08:00			`Welcome to panda`
			`======`

			`[panda](http://github.com/commaai/panda) is the nicest universal car interface you've ever seen.`

			`It supports 3x CAN, 2x LIN, and 1x GMLAN.`

			`It uses an [STM32F413](http://www.st.com/en/microcontrollers/stm32f413-423.html?querycriteria=productId=LN2004) for low level stuff and an [ESP8266](https://en.wikipedia.org/wiki/ESP8266) for wifi. They are connected over high speed SPI, so the panda is actually capable of dumping the full contents of the busses over wifi, unlike every other dongle on amazon. ELM327 is weak, panda is strong.`

			`It is 2nd gen hardware, reusing code and parts from the [NEO](https://github.com/commaai/neo) interface board.`

update readme 2017-04-07 09:23:26 +08:00			`Usage`
add hardware guide 2017-04-07 09:14:15 +08:00			`------`
update readme 2017-04-07 09:23:26 +08:00
			`See [panda.py](https://github.com/commaai/panda/blob/master/lib/panda.py) for how to interact with the panda.`

			`For example, to receive CAN messages:`
			```
			`>>> from panda.lib.panda import Panda`
fix readme example 2017-04-07 09:28:59 +08:00			`>>> panda = Panda()`
update readme 2017-04-07 09:23:26 +08:00			`>>> panda.can_recv()`
			```
fix readme example 2017-04-07 09:28:59 +08:00			`And to send one on bus 0:`
			```
			`>>> panda.can_send(0x1aa, "message", 0)`
			```
more examples 2017-04-07 09:31:56 +08:00			`More examples coming soon`
add hardware guide 2017-04-07 09:14:15 +08:00
initial commit 2017-04-07 09:11:36 +08:00			`Directory structure`
			`------`

			`- board -- Code that runs on the STM32`
			`- boardesp -- Code that runs on the ESP8266`
			`- lib -- Python userspace library for interfacing with the panda`
			`- tests -- Tests and helper programs for panda`

add over usb note 2017-04-07 09:30:45 +08:00			`Programming (over USB)`
initial commit 2017-04-07 09:11:36 +08:00			`------`

			`Programming the STM32`
			```
			`cd board`
			`./get_sdk.sh`
			`make`
			```

			`Programming the ESP`
			```
			`cd boardesp`
			`./get_sdk.sh`
			`make`
			```

update readme 2017-04-07 09:23:26 +08:00			`Hardware`
			`------`
			`Check out the hardware [guide](https://github.com/commaai/panda/blob/master/docs/guide.pdf)`

initial commit 2017-04-07 09:11:36 +08:00			`Licensing`
			`------`

			`panda software is released under the MIT license. See LICENSE`