Add README.md and COPYING
[revag-bap.git] / README.md
1 VAG / VW reverse-engineered BAP (Bedien- und Anzeigeprotokoll) implementation
2 ==============================================================================
3
4 This is a dump of my previous work in re-implementing the BAP (Bedien-
5 und Anzeigeprotokoll) used on the CAN bus in a VW Golf Mk 6, using
6 Linux SocketCAN.
7
8 It contains tools to dump, decode, and somewhat intelligently
9 sniff BAP channels. Sending is not really done yet.
10
11 The code is far from neat and finished, but I'd rather have it out
12 in the open than lost in the sands of time.
13
14
15 Sources
16 --------
17
18 The vendor specific CAN protocol has been reverse engineered entirely
19 from wire traces between an RCD 310 head unit and a MDI device.
20
21
22 Acknowledgements
23 -----------------
24
25 Special thanks go out to tmbinc who inspired me to do this, and
26 laid out the simplicity of BAP in his talk on hacking his handsfree
27 unit in his Golf Mk 6:
28
29   https://media.ccc.de/v/30C3_-_5360_-_en_-_saal_2_-_201312281600_-_script_your_car_-_felix_tmbinc_domke
30   https://github.com/tmbinc/car
31   https://github.com/tmbinc/kisim/
32
33
34 Disclaimer
35 -----------
36
37 This code has only been used in a lab bench setup, driving an RCD 310
38 radio head unit, as well as a MDI/Media-In interface. It has NOT been
39 tested inside a real car, and the author(s) take NO responsibility
40 whatsoever for any damage, safety issues, or anything else, be it
41 in a lab setup or in an actual car.
42
43
44 Licence
45 --------
46
47 GNU GPL v2 only.
48
49 Please see the file COPYING for details.