-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathindex.html
47 lines (47 loc) · 3.49 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimal-ui">
<meta name="google-site-verification" content="U8IKKw_5q5cZg6UV6fUxzrDT9Zr-CuDWYTUGPESQu_k" />
<title>KLineKWP1281Lib Arduino Library</title>
<link type="text/css" rel="stylesheet" href="assets/css/github-markdown.css">
<link type="text/css" rel="stylesheet" href="assets/css/pilcrow.css">
<link type="text/css" rel="stylesheet" href="assets/css/hljs-github.min.css"/>
</head>
<body>
<article class="markdown-body"><h2 id="KLineKWP1281Lib"><a class="header-link" href="#KLineKWP1281Lib"></a>KLineKWP1281Lib</h2>
<p><strong>KLineKWP1281Lib</strong> is a library designed for communicating with VAG control modules which use the proprietary VAG Key-Word 1281 protocol (KWP1281/KW1281), through an Arduino / ESP / RPi Pico development board.</p>
<p><a href="https://github.com/domnulvlad/KLineKWP1281Lib"><img src="assets\github_button.png" alt="GitHub"></a></p>
<h2 id="supported-features"><a class="header-link" href="#supported-features"></a>Supported features:</h2>
<ul class="list">
<li><strong>Ability to use any method to send and receive data</strong> (best being a hardware serial port, or software serial if an additional port is not available)</li>
<li>Ability to keep the connection alive while doing other tasks</li>
<li>Connecting to any control module that supports KWP1281</li>
<li>Reading the module's part number + extra fields, coding, WSC</li>
<li>Recoding</li>
<li>Performing a login operation</li>
<li><strong>Reading stored fault codes and elaboration codes</strong></li>
<li><strong>Converting fault/elaboration codes to strings</strong> (available in a few different languages)</li>
<li>Clearing stored fault codes</li>
<li>Reading, testing and saving an adaptation value</li>
<li><strong>Reading measuring blocks, calculating a measurement's value and providing its units, or displaying text from a table where applicable</strong> (available in a few different languages)</li>
<li>Reading ROM / EEPROM (firmware)</li>
<li>Performing actuator tests</li>
<li>Performing basic settings</li>
</ul>
<h2 id="getting-started"><a class="header-link" href="#getting-started"></a>Getting started</h2>
<p>Download <a href="https://github.com/domnulvlad/KLineKWP1281Lib/releases/latest">the latest release (.zip)</a> and <a href="https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#importing-a-zip-library">add it to your Arduino IDE</a>.</p>
<p><strong>Read the documentation on <a href="https://github.com/domnulvlad/KLineKWP1281Lib/wiki">the wiki</a>!</strong> Chapter 3 describes using the demo sketches.</p>
<h2 id="credits"><a class="header-link" href="#credits"></a>Credits</h2>
<p>Thanks go out to these people for their efforts:</p>
<ul class="list">
<li><a href="https://www.blafusel.de/obd/obd2_kw1281.html">Blafusel.de</a>, for the best documentation available for the protocol</li>
<li><a href="http://grauonline.de/wordpress/?p=74">Alexander Grau</a>, for the base code</li>
<li><a href="https://github.com/mnaberez/vwradio/blob/main/kwp1281_tool/firmware/kwp1281.h">Mike Naberezny</a>, for more insight about the commands and parameters</li>
</ul>
<h2 id="contact"><a class="header-link" href="#contact"></a>Contact</h2>
<p>For any inquiries, you can open an issue or contact me at <a href="mailto:[email protected]">[email protected]</a> (but don't include any links in the email, as it will be marked as spam).</p>
</article>
</body>
</html>