panda/README.md

Welcome to panda
======

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

<img src="https://github.com/commaai/panda/blob/master/panda.png">

It supports 3x CAN, 2x LIN, and 1x GMLAN. It also charges a phone.

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
------

To install the library:
```
# pip install pandacan
```

See [this class](https://github.com/commaai/panda/blob/master/panda/__init__.py#L80) 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)
```
More examples coming soon

Software interface support
------

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

- User space (done)
- socketcan in kernel (alpha)
- ELM327 (planned)
- Windows J2534 (planned)

Directory structure
------

- board      -- Code that runs on the STM32
- boardesp   -- Code that runs on the ESP8266
- drivers    -- Drivers (not needed for use with python)
- 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
```

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

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 unless otherwise specified.
initial commit 2017-04-07 09:11:36 +08:00			`Welcome to panda`
			`======`

marketing 2017-06-29 13:20:38 +08:00			`[panda](http://github.com/commaai/panda) is the nicest universal car interface ever.`
initial commit 2017-04-07 09:11:36 +08:00
add panda picture 2017-04-07 09:56:25 +08:00			`<img src="https://github.com/commaai/panda/blob/master/panda.png">`

phone charger 2017-04-07 09:57:04 +08:00			`It supports 3x CAN, 2x LIN, and 1x GMLAN. It also charges a phone.`
initial commit 2017-04-07 09:11:36 +08:00
			`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
update readme and setup.py 2017-06-21 06:40:34 +08:00			`To install the library:`
			```
			`# pip install pandacan`
			```

fix docs 2017-06-21 06:41:22 +08:00			`See [this class](https://github.com/commaai/panda/blob/master/panda/__init__.py#L80) for how to interact with the panda.`
update readme 2017-04-07 09:23:26 +08:00
			`For example, to receive CAN messages:`
			```
Changed documentation to reflect new python package name. 2017-06-21 02:30:35 +08:00			`>>> from 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
software interface 2017-06-26 14:01:41 +08:00			`Software interface support`
			`------`

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

			`- User space (done)`
			`- socketcan in kernel (alpha)`
			`- ELM327 (planned)`
			`- Windows J2534 (planned)`

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`
software interface 2017-06-26 14:01:41 +08:00			`- drivers -- Drivers (not needed for use with python)`
initial commit 2017-04-07 09:11:36 +08:00			`- 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`
			```

remove some dead code, move comment 2017-04-18 06:28:28 +08:00			`Debugging`
			`------`

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

flashing over http ugh 2017-04-29 15:09:08 +08:00			`To print out the serial console from the ESP8266, run PORT=1 tests/debug_console.py`

update readme 2017-04-07 09:23:26 +08:00			`Hardware`
			`------`
add bootloader lock support 2017-04-28 11:32:16 +08:00
update readme 2017-04-07 09:23:26 +08:00			`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`
			`------`

add wip note 2017-04-07 09:53:43 +08:00			`panda software is released under the MIT license unless otherwise specified.`