Skip to content

Commit a47d791

Browse files
ion-mironovalistair23
authored andcommitted
Included note mentioning which OBD it will work with.
1 parent 0c9abbc commit a47d791

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Welcome
22

3-
Python-OBD is a library for handling data from a car's [**O**n-**B**oard **D**iagnostics port](https://en.wikipedia.org/wiki/On-board_diagnostics) (OBD-II). It can stream real time sensor data, perform diagnostics (such as reading check-engine codes), and is fit for the Raspberry Pi. This library is designed to work with standard [ELM327 OBD-II adapters](http://www.amazon.com/s/ref=nb_sb_noss?field-keywords=elm327).
3+
Python-OBD is a library for handling data from a car's [**O**n-**B**oard **D**iagnostics](https://en.wikipedia.org/wiki/On-board_diagnostics) port. Please keep in mind that the car **must** have OBD-II (any car made in 1996 and up); this will _**not**_ work with OBD-I.
4+
5+
Python-OBD can stream real time sensor data, perform diagnostics (such as reading check-engine codes), and is fit for the Raspberry Pi. This library is designed to work with standard [ELM327 OBD-II adapters](http://www.amazon.com/s/ref=nb_sb_noss?field-keywords=elm327).
46

57
<span style="color:red">*NOTE: Python-OBD is below 1.0.0, meaning the API may change between minor versions. Consult the [GitHub release page](https://github.com/brendan-w/python-OBD/releases) for changelogs before updating.*</span>
68

@@ -31,13 +33,13 @@ connection = obd.OBD() # auto-connects to USB or RF port
3133

3234
cmd = obd.commands.SPEED # select an OBD command (sensor)
3335

34-
response = connection.query(cmd) # send the command, and parse the response
36+
response = connection.query(cmd) # send the command and parse the response
3537

3638
print(response.value) # returns unit-bearing values thanks to Pint
3739
print(response.value.to("mph")) # user-friendly unit conversions
3840
```
3941

40-
OBD connections operate in a request-reply fashion. To retrieve data from the car, you must send commands that query for the data you want (e.g. RPM, Vehicle speed, etc). In python-OBD, this is done with the `query()` function. The commands themselves are represented as objects, and can be looked up by name or value in `obd.commands`. The `query()` function will return a response object with parsed data in its `value` property.
42+
OBD connections operate in a request-reply fashion. To retrieve data from the car, you must send commands that query for the data you want (e.g. RPM, Vehicle speed, etc). In python-OBD this is done with the `query()` function. The commands themselves are represented as objects and can be looked up by name or value in `obd.commands`. The `query()` function will return a response object with parsed data in its `value` property.
4143

4244
<br>
4345

0 commit comments

Comments
 (0)