Skip to content

Commit adc13b4

Browse files
author
Brendan Whitfield
committed
converted README back to markdown
1 parent 92fb9e7 commit adc13b4

2 files changed

Lines changed: 75 additions & 72 deletions

File tree

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
python-OBD
2+
==========
3+
4+
A python module for handling realtime sensor data from OBD-II vehicle
5+
ports. Works with ELM327 OBD-II adapters, and is fit for the Raspberry
6+
Pi.
7+
8+
Installation
9+
------------
10+
11+
```Shell
12+
$ pip install obd
13+
```
14+
15+
Basic Usage
16+
-----------
17+
18+
```Python
19+
import obd
20+
21+
connection = obd.OBD() # auto-connects to USB or RF port
22+
23+
cmd = obd.commands.RPM # select an OBD command (sensor)
24+
25+
response = connection.query(cmd) # send the command, and parse the response
26+
27+
print(response.value)
28+
print(response.unit)
29+
```
30+
31+
Documentation
32+
-------------
33+
34+
[Visit the GitHub Wiki!](http://github.com/brendanwhitfield/python-OBD/wiki)
35+
36+
Commands
37+
--------
38+
39+
Here are a handful of the supported commands (sensors):
40+
41+
*note: support for these commands will vary from car to car*
42+
43+
- Calculated Engine Load
44+
- Engine Coolant Temperature
45+
- Fuel Pressure
46+
- Intake Manifold Pressure
47+
- Engine RPM
48+
- Vehicle Speed
49+
- Timing Advance
50+
- Intake Air Temp
51+
- Air Flow Rate (MAF)
52+
- Throttle Position
53+
- Engine Run Time
54+
- Fuel Level Input
55+
- Number of warm-ups since codes cleared
56+
- Barometric Pressure
57+
- Ambient air temperature
58+
- Commanded throttle actuator
59+
- Time run with MIL on
60+
- Time since trouble codes cleared
61+
- Hybrid battery pack remaining life
62+
- Engine fuel rate
63+
- etc... For a full list, see [the wiki](http://github.com/brendanwhitfield/python-OBD/wiki)
64+
65+
License
66+
-------
67+
68+
GNU GPL v2
69+
70+
This library is forked from:
71+
72+
- <https://github.com/peterh/pyobd>
73+
- <https://github.com/Pbartek/pyobd-pi>
74+
75+
Enjoy and drive safe!

README.rst

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)