Skip to content

Commit 5578801

Browse files
PbartekPbartek
committed
Update ReadMe
Update ReadMe
1 parent bd5bf8b commit 5578801

1 file changed

Lines changed: 36 additions & 44 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
pyobd
22
=====
33

4-
OBD-Pi:A Raspberry Pi Displaying Car Diagnostics (OBD-II) Data On An Aftermarket Head Unit
4+
<pre>OBD-Pi: Raspberry Pi Displaying Car Diagnostics (OBD-II) Data On An Aftermarket Head Unit
55

66
In this tutorial you will learn how to connect your Raspberry Pi to a Bluetooth OBD-II adapter and display realtime engine data to your cars aftermarket head unit.
7-
Hardware Required:
87

8+
Hardware Required:
99
1. Raspberry Pi
1010
2. Aftermarket head unit (Note: Must support Auxiliary input)
1111
3. Plugable USB Bluetooth 4.0 Low Energy Micro Adapter
@@ -15,57 +15,42 @@ Hardware Required:
1515
7. Keyboard (*optional)
1616

1717
What is OBD-II?
18-
1918
OBD stands for On-Board Diagnostics, and this standard connector has been mandated in the US since 1996. Now you can think of OBD-II as an on-board computer system that is responsible for monitoring your vehicle’s engine, transmission, and emissions control components.
2019

21-
Vehicles that comply with the OBD-II standards will have a data connector within about 2 feet of the steering wheel. The OBD connector is officially called an SAE J1962 Diagnostic Connector, but is also known by DLC, OBD Port, or OBD connector. It has positions for 16 pins.
20+
Vehicles that comply with the OBD-II standards will have a data connector within about 2 feet of the steering wheel. The OBD connector is officially called a SAE J1962 Diagnostic Connector, but is also known by DLC, OBD Port, or OBD connector. It has positions for 16 pins.
2221

2322
pyOBD?
24-
2523
pyOBD (aka pyOBD-II or pyOBD2) is an open source OBD-II (SAE-J1979) compliant scantool software written entirely in Python. It is designed to interface with low-cost ELM 32x OBD-II diagnostic interfaces such as ELM-USB. It will basically allow you to talk to your car's ECU, display fault codes, display measured values, read status tests, etc.
2624

27-
I took a fork of pyOBD’s software from there GitHub repository, https://github.com/peterh/pyobd, and used this as the basis for my program.
28-
29-
The program will connect through the OBD-II interface, display the gauges available dependent on the particular vehicle and display realtime engine data to the cars aftermarket head unit in a interactive GUI.
25+
I took a fork of pyOBD’s software from their GitHub repository, https://github.com/peterh/pyobd, and used this as the basis for my program.
3026

27+
The program will connect through the OBD-II interface, display the gauges available dependent on the particular vehicle and display realtime engine data to the cars aftermarket head unit in an interactive GUI.
3128
Software Installation
32-
3329
Before you start you will need a working install of Raspbian with network access.
3430

3531
We'll be doing this from a console cable connection, but you can just as easily do it from the direct HDMI/TV console or by SSH'ing in. Whatever gets you to a shell will work!
3632

37-
Before proceeding, run:
33+
Note: For the following command line instructions, do not type the '#', that is only to indicate that it is a command to enter.
3834

39-
sudo apt-get update
40-
41-
sudo apt-get upgrade
42-
43-
sudo apt-get autoremove
44-
45-
sudo reboot
35+
Before proceeding, run:
36+
# sudo apt-get update
37+
# sudo apt-get upgrade
38+
# sudo apt-get autoremove
39+
# sudo reboot
4640

4741
Install these components using the command:
42+
# sudo apt-get install python-serial
43+
# sudo apt-get install bluetooth bluez-utils blueman
44+
# sudo apt-get install python-wxgtk2.8 python-wxtools wx2.8-i18n libwxgtk2.8-dev
45+
# sudo apt-get install git-core
46+
# sudo reboot
4847

49-
sudo apt-get install python-serial
50-
51-
sudo apt-get install bluetooth bluez-utils blueman
52-
53-
sudo apt-get install python-wxgtk2.8 python-wxtools wx2.8-i18n libwxgtk2.8-dev
54-
55-
sudo apt-get install git-core
56-
57-
sudo reboot
58-
59-
Next, download the OBD-Pi Software direct from GitHub (https://github.com/Pbartek/pyobd.git)
48+
Next, download the OBD-Pi Software direct from GitHub (https://github.com/Pbartek/pyobd-pi.git)
6049

6150
Or using the command:
62-
63-
cd ~
64-
65-
git clone https://github.com/Pbartek/pyobd.git
66-
67-
Vechicle Installation
68-
51+
# cd ~
52+
# git clone https://github.com/Pbartek/pyobd-pi.git
53+
Vehicle Installation
6954
The vehicle installation is quite simple.
7055

7156
1. Insert the USB Bluetooth dongle into the Raspberry Pi along with the SD card.
@@ -79,21 +64,28 @@ The vehicle installation is quite simple.
7964
5. Finally turn your key to the ON position and navigate your head unit to Auxiliary input.
8065

8166
6. Enter your login credentials and run:
82-
startx
67+
# startx
8368

8469
7. Launch BlueZ, the Bluetooth stack for Linux. Pair + Trust your ELM327 Bluetooth Adapter and Connect To: SPP Dev. You should see the Notification "Serial port connected to /dev/rfcomm0"
8570

86-
8. Open up Terminal and run:
87-
88-
cd pyobd
71+
Note: Click the Bluetooth icon, bottom right (Desktop) to configure your device. Right click on your Bluetooth device to bring up Connect To: SPP Dev.
8972

90-
sudo su
91-
92-
python obd_gui.py
73+
8. Open up Terminal and run:
74+
# cd pyobd-pi
75+
# sudo su
76+
# python obd_gui.py
9377

9478
Use the Left and Right arrow key to cycle through the gauge display.
95-
(Note: Left and Right mouse click will also work)
79+
Note: Left and Right mouse click will also work
9680

9781
To exit the program just press Control and C or Alt and Esc.
82+
Update:
83+
Data Logging
84+
If you would like to log your data run:
85+
# cd pyobd-pi
86+
# python obd_recorder.py
87+
88+
The logged data file will be saved under:
89+
/home/username/pyobd-pi/log/
9890

99-
Enjoy and drive safe!
91+
Enjoy and drive safe!</pre>

0 commit comments

Comments
 (0)