Difference between revisions of "F12: OBD-II Android Monitor"

From Embedded Systems Learning Academy
Jump to: navigation, search
(→‎Parts List & Cost)
(→‎Project Source Code)
 
(114 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
== Abstract ==
 
== Abstract ==
−
Interfacing an ELM Electronics ELM327 OBD-II to RS232 interpreter to an Android mobile device. The Android mobile device connects to the interpreter via Bluetooth and gathers information through a designed application. The designed application will be able to gather real time information from the vehicle such as RPM, MPH, and intake temperature. The designed application will also be able to clear diagnostic trouble codes.
+
Interfacing a PLX Devices Kiwi Bluetooth to an Android mobile device. The PLX Devices Kiwi contains an ELM327 OBD-II to RS232 interpreter that gathers vehicle information. An Android application will be designed to gather real time information from the vehicle such as RPM, MPH, and intake temperature. The designed application will also be able to clear diagnostic trouble codes.
  
 
== Features & Objectives ==
 
== Features & Objectives ==
Line 9: Line 9:
 
* Establish communication with vehicle on board diagnostics computer with Android device
 
* Establish communication with vehicle on board diagnostics computer with Android device
 
* Design and create Android Application with features of:
 
* Design and create Android Application with features of:
−
:a) Gather real time vehicle engine information such as Intake temperature, Engine coolant temperature, MPH, RPM, MPG, etc.
+
:a) Gather real time vehicle engine information such as Intake temperature, Engine coolant temperature, MPH, RPM, Voltage, etc.
−
:b) Read and clear check engine lights (CEL)
+
:b) Clear check engine lights (CEL)
  
−
 
+
=== Team Members and Responsibilities ===
−
=== Team Members ===
 
 
* Ryan James Cristobal
 
* Ryan James Cristobal
 +
** Communication Link Between ELM327 and Android Application
 +
** Parsing Data from ELM327 for Gauges
 
* Jonathan Luong
 
* Jonathan Luong
−
 
+
** Application GUI (Animated Gauges)
−
=== Roles & Responsibilities ===
+
** Data Conversion
  
 
== Schedule ==
 
== Schedule ==
 
<table class="wikitable">
 
<table class="wikitable">
−
<th>Week Number</th> <th>Date</th> <th>Tasks</th> <th>Tasks Completed</th>
+
<th>Week Number</th> <th>Date</th> <th>Planned Tasks</th> <th>Actual</th>
  
 
<tr>
 
<tr>
Line 76: Line 77:
 
</td>
 
</td>
 
<td>
 
<td>
−
* ____
+
* Establish App requirements
−
* ____
+
* Purchased Android tablet
−
* ____
+
* Implement app GUI
 +
* App can connect to ELM327
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 94: Line 96:
 
</td>
 
</td>
 
<td>
 
<td>
−
* ____
+
* Communication link established
−
* ____
+
* Started UI design
−
* ____
+
* Created simple gauge
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 112: Line 114:
 
</td>
 
</td>
 
<td>
 
<td>
−
* ____
+
* Determined data parameters to be obtained
−
* ____
+
* Completed data parsing methods
−
* ____
+
* Started system testing
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 127: Line 129:
 
<td>
 
<td>
 
* Begin system testing
 
* Begin system testing
−
* Begin finalizing project report
+
* Begin project report
 
</td>
 
</td>
 
<td>
 
<td>
−
* ____
+
* Implemented dataflow algorithm
−
* ____
+
* Continued system testing of retrieving statistics
−
* ____
+
* Six parameter gauge implementation in progress
 +
* Continued work on project report
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 149: Line 152:
 
</td>
 
</td>
 
<td>
 
<td>
−
* ____
+
* Project report and Demo rescheduled for Dec 19th
−
* ____
+
* Continued implementation of 6 gauges
−
* ____
+
* Continued work of project report
 +
</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td> <center>
 +
8
 +
</center> </td>
 +
<td> <center>
 +
12/8 - 12/14
 +
</center> </td>
 +
<td>
 +
* Finish gauges implementation
 +
* Continue system testing for gauges
 +
* Prepare project demo material
 +
</td>
 +
<td>
 +
* Prepared powerpoint/video for presentation (uploaded to youtube)
 +
* Finished Gauge Implementation
 +
* Fixed needle rotation position bug
 +
* Continued Project Report
 +
</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td> <center>
 +
9
 +
</center> </td>
 +
<td> <center>
 +
12/15 - 12/19
 +
</center> </td>
 +
<td>
 +
* Finish project report
 +
* Finish system testing
 +
* Demo project
 +
</td>
 +
<td>
 +
* Project report completed
 +
* System testing completed
 +
* Presented Wednesday December 19
 +
 
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 158: Line 201:
  
 
== Parts List & Cost ==
 
== Parts List & Cost ==
−
:1. ELM327 Bluetooth Microcontroller [$22]
+
 
−
:2. Android Device [Free]
+
===Hardware===
 +
[[File:CmpE146_F12_T6_PLX_Kiwi.png|right|thumb|Figure 1. PLX Bluetooth Kiwi]]
 +
 
 +
:* PLX Devices Kiwi Bluetooth [$99.95]
 +
:* ASUS Nexus 7 Tablet (running Android 4.2.1) [$249.95]
 +
 
 +
===Software===
 +
:* Windows Vista / 7 (32 or 64-bit)
 +
:* Eclipse IDE
 +
::a) Must be 3.6.2 (Helios) or higher
 +
::b) JDT Plugin (newer IDE packages will have this plugin included)
 +
:* Android SDK
 +
:* ADT Plugin (recommended but not required)
 +
::a) 20.0.0 or higher
  
 
== Design & Implementation ==
 
== Design & Implementation ==
−
The design section can go over your hardware and software design.  Organize this section using sub-sections that go over your design and implementation.
 
  
 
=== Hardware Design ===
 
=== Hardware Design ===
−
Discuss your hardware design here. Show detailed schematics, and the interface here.
+
 
 +
The OBD-II is a computer system built into modern vehicles. The OBD-II is responsible for monitoring and recording vehicle operating information such as temperatures and engine fault codes. Following different protocols such as SAE J1979, SAE J1850, ISO 9141-2, and etc, many users are using the OBD-II interface as a scan tool to diagnose the status of their vehicles. A pinout of the OBD-II connector is shown in Figure 2. There are many OBD-II adapter devices in the market that range from $25-$200. The OBD-II Android Monitor project uses the PLX Kiwi Bluetooth by PLX Devices.
 +
 
 +
[[File:CmpE146_F12_T6_OBDpinout.jpeg|thumb|center|Figure 2. OBD-II Pin Layout]]
 +
 
 +
 
 +
Figure 3 is the block diagram for the OBD-II Android Monitor project. The Nexus 7 tablet communicates with the PLX Bluetooth Kiwi using serial over Bluetooth (SPP). Refer to the Hardware Interface section for details.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_Block_Diagram.jpg|thumb|600px|center|Figure 3. Hardware Block Diagram]]
  
 
=== Hardware Interface ===
 
=== Hardware Interface ===
−
In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the '''Software Design''' section is isolated to talk about high level workings rather than inner working of your project.
+
 
 +
The hardware interface for this project involved establishing a Bluetooth communication link for the Kiwi device. Specifically, it communicated with the Android tablet using the Serial Profile Port (SPP). SPP is based off of the RFCOMM which emulates the signals for RS-232 communication. By using SPP, the Kiwi Bluetooth device would be able to send and receive different ASCII values through the serial stream. Just like the RS-232 communication, the PLX Kiwi behaves like a transceiver which will send and receive data from the vehicle's ECU to the Android tablet.
  
 
=== Software Design ===
 
=== Software Design ===
−
Show your software design.  For example, if you are designing an MP3 Player, show the tasks that you are using, and what they are doing at a high level.  Do not show the details of the code.  For example, do not show exact code, but you may show psuedocode and fragments of code.  Keep in mind that you are showing DESIGN of your software, not the inner workings of it. 
 
  
−
=== Implementation ===
+
In preparation of the design for the OBD-II Android Monitor, Android Application Requirements were drafted and shown below. 
−
This section includes implementation, but again, not the details, just the high level. For example, you can list the steps it takes to communicate over a sensor, or the steps needed to write a page of memory onto SPI Flash. You can include sub-sections for each of your component implementation.
+
 
 +
Android Application Requirements:
 +
 
 +
:R1. The Android OBD-II Monitor application shall have a graphical user interface.
 +
:R2. The Android OBD-II Monitor application shall use Bluetooth wireless communication to connect to the ELM327 microcontroller.
 +
:R3. The Android OBD-II Monitor application shall be able to clear engine trouble diagnostic codes.
 +
:R4. The Android OBD-II Monitor application shall display multiple vehicle parameters on screen.
 +
::: R4-a. Parameters chosen are MPH, RPM, coolant temperature, intake temperature, engine load percentage, and voltage.
 +
 
 +
As seen in the requirements, an Android application must be created to interface with an ELM327 microcontroller to retrieve vehicle data. To start with the design, we first focused on how to we wanted our graphical interface to look like. The design in mind was to have gauges and the parameters to be changing as accurately as possible.
 +
 
 +
After the GUI, the next application design consideration was how to get the desired data from the vehicle. The design of the ELM327 software operates by servicing a single command. This gives our software design a performance drawback due to the fact that we cannot get all of the vehicle parameters simultaneously. To make our application seem "real time", we need to obtain data as efficiently as possible. To do this, we created the data flow algorithm discussed below:
 +
 
 +
:1.) Send first command string
 +
:2.) Wait until ">" is received, (which indicates that the ELM327 is ready)
 +
:3.) Send next command string
 +
:4.) Go back to step 2 and repeat
 +
 
 +
From the algorithm, constant data flow between the Android application and the ELM327 has been established. The next thing to consider is the method of parsing each message to obtain the desired data. Parsing of data proved to be one of the big challenges faced in this project as the data was not in a consistent format. Data was received with extra spaces, newlines, and null characters. Messages were also often split up randomly when read. To solve our parsing problem, as discussed in the Technical Challenges section, the use of Java String functions and regular expressions was used. More information about the parsing solution will be discussed later.
 +
 
 +
=== Software Implementation ===
 +
 
 +
The main purpose of the software implementation was to create an Android application which established a wireless communication link via Bluetooth with the PLX Kiwi device. This was achieved by using the [http://www.eclipse.org/downloads/ Eclipse IDE], Android [http://developer.android.com/sdk/index.html Software Development Kit (SDK)], and [http://developer.android.com/tools/devices/index.html Android Virtual Device (AVD)]. In addition to having the application be written in Java and API 17, it was also created for Android OS 4.2 (Jelly Bean). Users who are new to the Android environment and would like to find more information can follow this [http://developer.android.com/training/index.html link] for a tutorial.
 +
 
 +
=== Android Application ===
 +
 
 +
'''Getting Started with BluetoothChat'''
 +
 
 +
Some basic features for the application such as enabling Bluetooth, scanning for nearby Bluetooth devices, and connecting to a Bluetooth device were referenced by Google's sample code, [http://developer.android.com/guide/topics/connectivity/bluetooth.html BluetoothChat]. The Bluetooth Chat essentially allows devices to create a Bluetooth socket to communicate between itself and another Bluetooth enabled device. Once the Bluetooth communication link was achieved, the application can send PIDs to and receive data strings from the Kiwi device.
 +
 
 +
Before we are able to use the BluetoothChat sample code, a few modifications had to be made in order for it to run on our tablet. The first modification dealt with the ''AndroidManifest.xml'' file.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_Manifest_2.JPG||thumb|350px|center|Figure 4. AndroidManifest.xml Original]]
 +
 
 +
 
 +
From Figure 4, the original Android manifest file only stated a minimum SDK version allowed but not a target version. This is a problem for Android devices using versions 4.0 and up. To correct this, add a target version which is shown in Figure 5.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_Manifest_1.JPG||thumb|350px|center|Figure 5. AndroidManifest.xml Modified]]
 +
 
 +
 
 +
The next modification dealt with the Universally Unique Identifier (UUID) which is used by BluetoothChat to assign each connected device an ID. For our purposes of using BluetoothChat to connect to SPP devices, the UUID needed to be changed to a specific UUID used by all SPP devices which is shown in Figure 6. 
 +
 +
[[File:CmpE146_F12_T6_HWInterface.JPG||thumb|500px|center|Figure 6. UUID Code]]
 +
 
 +
 
 +
This needed to be changed in the BluetoothChat sample code to enable the program to be used with an SPP device such as the PLX Kiwi Bluetooth. The reason for change is because BluetoothChat is used for communication between two Android devices rather than an Android and SPP device. Now that the modifications have been made, the BluetoothChat sample program will be able to connect and communicate with SPP devices.
 +
 +
 
 +
''' Android Backend '''
 +
 
 +
In order for the gauges and textViews to display data, we first needed a way to parse the incoming data from the Kiwi Bluetooth. The sample code below shows how we parsed the data for Intake Temperature and calculated the actual value.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_SampleCode.png|center|thumb|550px|Figure 7. Intake Temperature Parsing Sample Code]]
 +
 
 +
 
 +
As shown in the sample code, the use of regular expressions was used in order to parse the incoming data. The regular expression shown is to match incoming data of a two hex byte format such as "0F 5D." Once we are able to get a match with the incoming data, we then use String.trim() to remove any excess white space which will cause errors in calculations if not removed. Once we implemented the parsing code for Intake Temperature, we can apply the same methods to the other five parameters.
 +
 
 +
Given the nature of the ELM327 OBD to serial interpreter, it is hard to predict the incoming string format response. Therefore, many regular expression cases were implemented in order to match data more often. It is desired to match data as much as possible in order to display the change in values as real time as possible which was a goal of this project. 
 +
 
 +
Once the incoming data has been retrieved, the data must be converted into different units based on parameters. Each PID based on the OBD-II have a specific conversion formula to give users the actual value. These formulas can be found [http://en.wikipedia.org/wiki/OBD-II_PIDs here]. After conversion has been complete, the data values will then be sent to the front end of the application.
 +
 
 +
 
 +
''' Android Frontend'''
 +
 
 +
Figure 8 below displays the main page for the application.
 +
 
 +
[[File:CmpE146_F12_T6_Screenshot.png|thumb|center|500px|Figure 8. Android Application Interface]]
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_SearchDevice.png|thumb|right|400px|Figure 9. Device Connection Menu]]
 +
When opening up the application, the user must first connect to the PLX Kiwi by pressing on the button at the top right and selecting the device from the list (as shown in Figure 9). Once the tablet has successfully connected, you can start the gathering of parameter data by pressing on the toggleButton on the bottom left. The second button is to clear check engine codes (if any are present in the vehicle).
 +
 
 +
To make it easier for the user to read the current data of the vehicle, Android textViews were also inserted into the gauges to provide a numerical representation. This allows the user to quickly identify the value of each current parameter. There are also TX and RX field to display the information that the tablet is currently sending and receiving at that particular moment.
 +
 
 +
During the designing stage in the front end of the application, it was decided that the tablet would only have one screen to display the entire GUI. This was because implementing multiple screens would require the user to take his/her hands off the steering wheel, which could be potentially dangerous.
 +
 
 +
In terms of developing the front end of the application, there were two key elements to implement the GUI, creating the layout and creating the animations for the layout. There are many ways to make user interfaces as shown in Android's [http://developer.android.com/guide/topics/ui/index.html API Guides]. In the OBD-II Android Monitor, the application GUI used ImageView to create the background and gauges for the GUI.
 +
 
 +
Before creating the layout, the layout orientation for the application was fixed to landscape. Modified in the ''AndroidManifest.xml'' file, using a landscape orientation provided a lower device profile as well as wider viewing angle. Figure 10 below shows the modification to set the layout to "landscape." If the application was to be portrait or can switch from both, then the orientation would be changed to "portrait" or "auto" respectively.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_Hlayout.png|thumb|center|400px|Figure 10. Layout Orientation.]]
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_ImageView.png|thumb|right|300px|Figure 11. ImageView]]To create the GUI layout, the ''main.xml'' from the ''res'' folder must be selected. ImageView features allows using an external source to import images to the application. In this case, the background and needles were the external sources to implement the gauges. In order to implement the background, select the "ImageView" under the palette section once main.xml is opened as shown in Figure 11. Once selected, an external image from either project or system folder can be imported into the application. In Figure 12, the cf.png image was imported from the ''res/drawable'' project folder.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_ImageView2.png|thumb|center|325px|Figure 12. Importing External Image]]
 +
 
 +
 
 +
Once the file has been imported into the application, the image is then displayed into the workspace of the .xml file, as shown in Figure 13.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_ImageView3.png|thumb|center|500px|Figure 13. Android Workspace in Eclipse]]
 +
 
 +
 
 +
 
 +
In order to create our gauges that will be used to display the vehicle data in real time. We created a custom gauge background with all of the parameters that we have chosen for the project with their appropriate data ranges for each. Once we had implemented the gauge dial backgrounds, the next step as the create the moving part which was the gauge needle. In order to do this, the use of an Android API called ''RotateAnimation'' was used. ''RotateAnimation'' was chosen as to create the gauge because it provided us with more flexibility when creating custom gauges. Continuing with the sample code for the parsing of Intake Temperature from the back end development, we can see how to ''RotateAnimation'' API is used in the code below.
 +
 
 +
 
 +
[[File:CmpE146_F12_T6_RotateAnimation.png|thumb|center|500px|Figure 14. Using RotateAnimation for Intake Temperature Gauge]]
 +
 
 +
 
 +
From the sample code above, the Interpolator deals with the data rate of change. For circular gauges, we want the needles to move in a linear way. The setFillAfter(true) allows the gauge to stay at the final position. By default, RotateAnimation will rotate an image and then bring it back to it's previous position which isn't the desired behavior for gauges. More about the RotateAnimation API is detailed [http://developer.android.com/reference/android/view/animation/RotateAnimation.html here].
  
 
== Testing & Technical Challenges ==
 
== Testing & Technical Challenges ==
−
Describe the challenges of your project.  What advise would you give yourself or someone else if your project can be started from scratch again?
 
−
Make a smooth transition to testing section and described what it took to test your project.
 
  
−
Include sub-sections that list out a problem and solution, such as:
+
=== Testing the Android Application ===
  
−
=== Wifi Connection Issues ===
+
To test and debug the Android application during development, TeraTerm was used as a tool. TeraTerm is an open source terminal application program for Windows that can communicate with SPP devices. Figure 15. below shows a screenshot of the TeraTerm program.
−
Many wifi connection issues were encountered. To solve this problem, a dedicated task was created to re-connect to wifi if the connection was ever lost.
+
 
 +
[[File:CmpE146_F12_T6_TeraTerm.jpeg|400px|thumb|center|Figure 15. TeraTerm Serial Terminal]]
 +
 
 +
To test the Android application for it's functionality. TeraTerm was used to send messages to the Nexus 7 over SPP to test if obtain the desired result. This helped to ensure that our regular expressions was correct and that there weren't any issues calculating data to be displayed on the gauges. The testing and debugging was mostly done through TeraTerm and once the team felt that there was significant progress added to the application functionality, then we would go out and test the application with the vehicle. It seemed very tedious to go out to the vehicle after every build, so TeraTerm helped out the team a lot with testing.
 +
 
 +
=== Issues with Getting Data From the ELM327 ===
 +
A big challenge in this project was to parse the incoming data sent by the ELM327. It created a challenge for us due to the inconsistency of format in the data. Examples of inconsistencies would be random added spaces, newlines, null characters, or split messages. The typical operation of the ELM327 is to send a command byte followed by a parameter ID (PID) such as "01 00" followed by a carriage return ('\r') byte.
 +
 
 +
For example, if we were to send the message to obtain intake temperature, we would send ("01 0F" + '\r') to the ELM327. And get a typical response back of:
 +
:ELM327: 01 0F
 +
:ELM327: 41 0F 5C
 +
:ELM327:
 +
:ELM327: >
 +
 
 +
OR
 +
 
 +
:ELM327: 01
 +
:ELM327: 0F 4
 +
:ELM327: 1 5C >
 +
 
 +
From the sample output above, the desired data that we need is the "5C" for this example. As you can see, the "5C" doesn't appear in a predictable manner which makes this a challenge to obtain the data we need. Note that these are only two samples of the possible message format. 
 +
 
 +
To solve this problem, the use of Regular Expressions and built in Java String functions were used. The Java String functions that were utilized were trim(), split(), and matches(). The String.trim() allowed for us to remove any extra padded spaces in front and back of a string message received from the ELM327. String.split() allowed for us to split up the received string message into message bytes using space (" ") as a delimiter. It was desired to split up the received message since the data that follows the PID, is the data we want to retrieve. String.matches() functions by using Regular Expressions to check with selected data. If the data matches the corresponding regular expression then it is parsed, otherwise it is just simply ignored.
 +
 
 +
The regular expression pattern used to match for MPH, intake temperature, engine load, and coolant temperature was "\s*[0-9A-Fa-f]{2} [0-9A-Fa-f]{2}\s*\r?\n?".
 +
 
 +
A drawback of using String.matches() and regular expressions is that it is a "hit or miss" scenario. This is due to the fact that the message received will either match or not match with the given regular expression. To address this, all message possibilities must be addressed and accounted for with regular expressions. This is essential to the performance of our application because the more matches obtained will give the user a real time response.
  
 
== Conclusion ==
 
== Conclusion ==
−
Conclude your project here. You can recap your testing and problems. You should address the "so what" part here to indicate what you ultimately learnt from this project. How has this project increased your knowledge?
+
 
 +
Coming into this project, the team members had no experience with Java and Android application programming. With the 9 weeks given for the project, we were able to learn how to use the Android SDK to create an Android application. Our Android application is able to communicate with the PLX Kiwi Bluetooth and display the parameters in real time to the user. We were also able to create circular gauges from scratch to display information visually using the RotateAnimation API. Although we have had great success, we faced a lot of challenges through the implementation of the Android application. One of those challenges dealt with getting the BluetoothChat sample code to operate correctly with the tablet and an SPP device. Another challenge was to parse the data received from the PLX Kiwi which was solved using regular expressions. Lastly, the gauges needed to be constructed from scratch because after doing some research, the team found that there wasn't really any good APIs to use with the project.  
 +
 
 +
For future work on this project, we can move further by adding more features such as the ability to read diagnostic trouble codes and explain what each code means. Also, we can have the functionality for a user to customize their home screen to select which parameters to display on the gauges. There is a lot of room for improvement with the Android application and the team looks forward to upgrading the application. 
  
 
=== Project Video ===
 
=== Project Video ===
−
Upload a video of your project and post the link here.
+
[http://www.youtube.com/watch?v=tt57rSRN_as CmpE146 F12 T6 Demonstration Video]
  
 
=== Project Source Code ===
 
=== Project Source Code ===
−
Send me your zipped source code and I will upload this to SourceForge and link it for you.
+
*  [http://sourceforge.net/projects/sjsuf12/files Project source code is available at SourceForge]
  
 
== References ==
 
== References ==
 
=== Acknowledgement ===
 
=== Acknowledgement ===
−
Any acknowledgement that you may wish to provide can be included here.
+
We would like the thank the following people for their contributions during this project:
 +
:*Preet Kang
 +
:*Michael Cox
 +
:*Christopher Tugangui
 +
:*Ryan Branche
  
 
=== References Used ===
 
=== References Used ===
−
List any references used in project.
+
 
 +
*[http://developer.android.com/sdk/index.html Setting up Android SDK]
 +
*[http://en.wikipedia.org/wiki/OBD-II_PIDs OBD-II Parameter IDs]
 +
*[http://plxdevices.com/product_info.php?id=GSSTBLUETOOTH PLX Kiwi Bluetooth Device Page]
 +
*[http://en.wikipedia.org/wiki/Regular_expression Regular Expressions Wiki]
 +
*[http://www.regextester.com/ Regular Expressions Online Tester]
  
 
=== Appendix ===
 
=== Appendix ===
−
You can list the references you used.
+
*[http://plxdevices.com/ PLX Devices Company Website]
 +
*[http://www.google.com/nexus/7/ Google Nexus 7 Product Page]

Latest revision as of 22:03, 4 February 2013

OBD-II Android Monitor

Abstract

Interfacing a PLX Devices Kiwi Bluetooth to an Android mobile device. The PLX Devices Kiwi contains an ELM327 OBD-II to RS232 interpreter that gathers vehicle information. An Android application will be designed to gather real time information from the vehicle such as RPM, MPH, and intake temperature. The designed application will also be able to clear diagnostic trouble codes.

Features & Objectives

The OBD-II Android Monitor project establishes a wireless Bluetooth communication link between an Android mobile device and an automobile’s On-Board Diagnostics system (OBD). Information is transmitted between these components using an ELM Electronics ELM327 microcontroller. The ELM327 converts data from OBD-II protocols to RS-232, emulating the Bluetooth communication to run in serial port profile (SPP). To interface an Android device with the ELM327, an application will be designed. This application will have a graphical user interface (GUI) which will be able to display vehicle information such as MPH and RPM. The objectives for the OBD-II Android Monitor project is shown below.

  • Establish communication with vehicle on board diagnostics computer with Android device
  • Design and create Android Application with features of:
a) Gather real time vehicle engine information such as Intake temperature, Engine coolant temperature, MPH, RPM, Voltage, etc.
b) Clear check engine lights (CEL)

Team Members and Responsibilities

  • Ryan James Cristobal
    • Communication Link Between ELM327 and Android Application
    • Parsing Data from ELM327 for Gauges
  • Jonathan Luong
    • Application GUI (Animated Gauges)
    • Data Conversion

Schedule

Week Number Date Planned Tasks Actual

1

10/20 - 10/26

  • Gather and order parts
  • Install Android SDK and tools
  • Review component data sheets
  • Parts ordered on 10/25
  • Installed SDK on Eclipse and ADT (Android Emulator)
  • Obtained PDF of OBD-II datasheet

2

10/27 - 11/2

  • Gather and test components
  • Establish Android app requirements
  • Begin Android app design
  • ELM327 Controller Obtained, and tested.
  • User Interface Requirements Established
-ELM327 will use SPP to communicate between OBD-II and Android device
  • Android App functions:
-One screen to display data parameters
-Displayed data will be refreshed in real-time

3

11/3 - 11/9

  • Finalize Android app design
  • Begin Android app implementation
  • Establish App requirements
  • Purchased Android tablet
  • Implement app GUI
  • App can connect to ELM327

4

11/10 - 11/16

  • Establish communication link between OBD-II and Android phone
  • Develop UI design
  • Communication link established
  • Started UI design
  • Created simple gauge

5

11/17 - 11/23

  • Continue UI design
  • Prepare system testing
  • Determined data parameters to be obtained
  • Completed data parsing methods
  • Started system testing

6

11/24 - 11/30

  • Begin system testing
  • Begin project report
  • Implemented dataflow algorithm
  • Continued system testing of retrieving statistics
  • Six parameter gauge implementation in progress
  • Continued work on project report

7

12/1 - 12/7

  • Finish project report
  • Finish system testing
  • Demo project
  • Project report and Demo rescheduled for Dec 19th
  • Continued implementation of 6 gauges
  • Continued work of project report

8

12/8 - 12/14

  • Finish gauges implementation
  • Continue system testing for gauges
  • Prepare project demo material
  • Prepared powerpoint/video for presentation (uploaded to youtube)
  • Finished Gauge Implementation
  • Fixed needle rotation position bug
  • Continued Project Report

9

12/15 - 12/19

  • Finish project report
  • Finish system testing
  • Demo project
  • Project report completed
  • System testing completed
  • Presented Wednesday December 19

Parts List & Cost

Hardware

Figure 1. PLX Bluetooth Kiwi
  • PLX Devices Kiwi Bluetooth [$99.95]
  • ASUS Nexus 7 Tablet (running Android 4.2.1) [$249.95]

Software

  • Windows Vista / 7 (32 or 64-bit)
  • Eclipse IDE
a) Must be 3.6.2 (Helios) or higher
b) JDT Plugin (newer IDE packages will have this plugin included)
  • Android SDK
  • ADT Plugin (recommended but not required)
a) 20.0.0 or higher

Design & Implementation

Hardware Design

The OBD-II is a computer system built into modern vehicles. The OBD-II is responsible for monitoring and recording vehicle operating information such as temperatures and engine fault codes. Following different protocols such as SAE J1979, SAE J1850, ISO 9141-2, and etc, many users are using the OBD-II interface as a scan tool to diagnose the status of their vehicles. A pinout of the OBD-II connector is shown in Figure 2. There are many OBD-II adapter devices in the market that range from $25-$200. The OBD-II Android Monitor project uses the PLX Kiwi Bluetooth by PLX Devices.

Figure 2. OBD-II Pin Layout


Figure 3 is the block diagram for the OBD-II Android Monitor project. The Nexus 7 tablet communicates with the PLX Bluetooth Kiwi using serial over Bluetooth (SPP). Refer to the Hardware Interface section for details.


Figure 3. Hardware Block Diagram

Hardware Interface

The hardware interface for this project involved establishing a Bluetooth communication link for the Kiwi device. Specifically, it communicated with the Android tablet using the Serial Profile Port (SPP). SPP is based off of the RFCOMM which emulates the signals for RS-232 communication. By using SPP, the Kiwi Bluetooth device would be able to send and receive different ASCII values through the serial stream. Just like the RS-232 communication, the PLX Kiwi behaves like a transceiver which will send and receive data from the vehicle's ECU to the Android tablet.

Software Design

In preparation of the design for the OBD-II Android Monitor, Android Application Requirements were drafted and shown below.

Android Application Requirements:

R1. The Android OBD-II Monitor application shall have a graphical user interface.
R2. The Android OBD-II Monitor application shall use Bluetooth wireless communication to connect to the ELM327 microcontroller.
R3. The Android OBD-II Monitor application shall be able to clear engine trouble diagnostic codes.
R4. The Android OBD-II Monitor application shall display multiple vehicle parameters on screen.
R4-a. Parameters chosen are MPH, RPM, coolant temperature, intake temperature, engine load percentage, and voltage.

As seen in the requirements, an Android application must be created to interface with an ELM327 microcontroller to retrieve vehicle data. To start with the design, we first focused on how to we wanted our graphical interface to look like. The design in mind was to have gauges and the parameters to be changing as accurately as possible.

After the GUI, the next application design consideration was how to get the desired data from the vehicle. The design of the ELM327 software operates by servicing a single command. This gives our software design a performance drawback due to the fact that we cannot get all of the vehicle parameters simultaneously. To make our application seem "real time", we need to obtain data as efficiently as possible. To do this, we created the data flow algorithm discussed below:

1.) Send first command string
2.) Wait until ">" is received, (which indicates that the ELM327 is ready)
3.) Send next command string
4.) Go back to step 2 and repeat

From the algorithm, constant data flow between the Android application and the ELM327 has been established. The next thing to consider is the method of parsing each message to obtain the desired data. Parsing of data proved to be one of the big challenges faced in this project as the data was not in a consistent format. Data was received with extra spaces, newlines, and null characters. Messages were also often split up randomly when read. To solve our parsing problem, as discussed in the Technical Challenges section, the use of Java String functions and regular expressions was used. More information about the parsing solution will be discussed later.

Software Implementation

The main purpose of the software implementation was to create an Android application which established a wireless communication link via Bluetooth with the PLX Kiwi device. This was achieved by using the Eclipse IDE, Android Software Development Kit (SDK), and Android Virtual Device (AVD). In addition to having the application be written in Java and API 17, it was also created for Android OS 4.2 (Jelly Bean). Users who are new to the Android environment and would like to find more information can follow this link for a tutorial.

Android Application

Getting Started with BluetoothChat

Some basic features for the application such as enabling Bluetooth, scanning for nearby Bluetooth devices, and connecting to a Bluetooth device were referenced by Google's sample code, BluetoothChat. The Bluetooth Chat essentially allows devices to create a Bluetooth socket to communicate between itself and another Bluetooth enabled device. Once the Bluetooth communication link was achieved, the application can send PIDs to and receive data strings from the Kiwi device.

Before we are able to use the BluetoothChat sample code, a few modifications had to be made in order for it to run on our tablet. The first modification dealt with the AndroidManifest.xml file.


Figure 4. AndroidManifest.xml Original


From Figure 4, the original Android manifest file only stated a minimum SDK version allowed but not a target version. This is a problem for Android devices using versions 4.0 and up. To correct this, add a target version which is shown in Figure 5.


Figure 5. AndroidManifest.xml Modified


The next modification dealt with the Universally Unique Identifier (UUID) which is used by BluetoothChat to assign each connected device an ID. For our purposes of using BluetoothChat to connect to SPP devices, the UUID needed to be changed to a specific UUID used by all SPP devices which is shown in Figure 6.

Figure 6. UUID Code


This needed to be changed in the BluetoothChat sample code to enable the program to be used with an SPP device such as the PLX Kiwi Bluetooth. The reason for change is because BluetoothChat is used for communication between two Android devices rather than an Android and SPP device. Now that the modifications have been made, the BluetoothChat sample program will be able to connect and communicate with SPP devices.


Android Backend

In order for the gauges and textViews to display data, we first needed a way to parse the incoming data from the Kiwi Bluetooth. The sample code below shows how we parsed the data for Intake Temperature and calculated the actual value.


Figure 7. Intake Temperature Parsing Sample Code


As shown in the sample code, the use of regular expressions was used in order to parse the incoming data. The regular expression shown is to match incoming data of a two hex byte format such as "0F 5D." Once we are able to get a match with the incoming data, we then use String.trim() to remove any excess white space which will cause errors in calculations if not removed. Once we implemented the parsing code for Intake Temperature, we can apply the same methods to the other five parameters.

Given the nature of the ELM327 OBD to serial interpreter, it is hard to predict the incoming string format response. Therefore, many regular expression cases were implemented in order to match data more often. It is desired to match data as much as possible in order to display the change in values as real time as possible which was a goal of this project.

Once the incoming data has been retrieved, the data must be converted into different units based on parameters. Each PID based on the OBD-II have a specific conversion formula to give users the actual value. These formulas can be found here. After conversion has been complete, the data values will then be sent to the front end of the application.


Android Frontend

Figure 8 below displays the main page for the application.

Figure 8. Android Application Interface


Figure 9. Device Connection Menu

When opening up the application, the user must first connect to the PLX Kiwi by pressing on the button at the top right and selecting the device from the list (as shown in Figure 9). Once the tablet has successfully connected, you can start the gathering of parameter data by pressing on the toggleButton on the bottom left. The second button is to clear check engine codes (if any are present in the vehicle).

To make it easier for the user to read the current data of the vehicle, Android textViews were also inserted into the gauges to provide a numerical representation. This allows the user to quickly identify the value of each current parameter. There are also TX and RX field to display the information that the tablet is currently sending and receiving at that particular moment.

During the designing stage in the front end of the application, it was decided that the tablet would only have one screen to display the entire GUI. This was because implementing multiple screens would require the user to take his/her hands off the steering wheel, which could be potentially dangerous.

In terms of developing the front end of the application, there were two key elements to implement the GUI, creating the layout and creating the animations for the layout. There are many ways to make user interfaces as shown in Android's API Guides. In the OBD-II Android Monitor, the application GUI used ImageView to create the background and gauges for the GUI.

Before creating the layout, the layout orientation for the application was fixed to landscape. Modified in the AndroidManifest.xml file, using a landscape orientation provided a lower device profile as well as wider viewing angle. Figure 10 below shows the modification to set the layout to "landscape." If the application was to be portrait or can switch from both, then the orientation would be changed to "portrait" or "auto" respectively.


Figure 10. Layout Orientation.


Figure 11. ImageView
To create the GUI layout, the main.xml from the res folder must be selected. ImageView features allows using an external source to import images to the application. In this case, the background and needles were the external sources to implement the gauges. In order to implement the background, select the "ImageView" under the palette section once main.xml is opened as shown in Figure 11. Once selected, an external image from either project or system folder can be imported into the application. In Figure 12, the cf.png image was imported from the res/drawable project folder.


Figure 12. Importing External Image


Once the file has been imported into the application, the image is then displayed into the workspace of the .xml file, as shown in Figure 13.


Figure 13. Android Workspace in Eclipse


In order to create our gauges that will be used to display the vehicle data in real time. We created a custom gauge background with all of the parameters that we have chosen for the project with their appropriate data ranges for each. Once we had implemented the gauge dial backgrounds, the next step as the create the moving part which was the gauge needle. In order to do this, the use of an Android API called RotateAnimation was used. RotateAnimation was chosen as to create the gauge because it provided us with more flexibility when creating custom gauges. Continuing with the sample code for the parsing of Intake Temperature from the back end development, we can see how to RotateAnimation API is used in the code below.


Figure 14. Using RotateAnimation for Intake Temperature Gauge


From the sample code above, the Interpolator deals with the data rate of change. For circular gauges, we want the needles to move in a linear way. The setFillAfter(true) allows the gauge to stay at the final position. By default, RotateAnimation will rotate an image and then bring it back to it's previous position which isn't the desired behavior for gauges. More about the RotateAnimation API is detailed here.

Testing & Technical Challenges

Testing the Android Application

To test and debug the Android application during development, TeraTerm was used as a tool. TeraTerm is an open source terminal application program for Windows that can communicate with SPP devices. Figure 15. below shows a screenshot of the TeraTerm program.

Figure 15. TeraTerm Serial Terminal

To test the Android application for it's functionality. TeraTerm was used to send messages to the Nexus 7 over SPP to test if obtain the desired result. This helped to ensure that our regular expressions was correct and that there weren't any issues calculating data to be displayed on the gauges. The testing and debugging was mostly done through TeraTerm and once the team felt that there was significant progress added to the application functionality, then we would go out and test the application with the vehicle. It seemed very tedious to go out to the vehicle after every build, so TeraTerm helped out the team a lot with testing.

Issues with Getting Data From the ELM327

A big challenge in this project was to parse the incoming data sent by the ELM327. It created a challenge for us due to the inconsistency of format in the data. Examples of inconsistencies would be random added spaces, newlines, null characters, or split messages. The typical operation of the ELM327 is to send a command byte followed by a parameter ID (PID) such as "01 00" followed by a carriage return ('\r') byte.

For example, if we were to send the message to obtain intake temperature, we would send ("01 0F" + '\r') to the ELM327. And get a typical response back of:

ELM327: 01 0F
ELM327: 41 0F 5C
ELM327:
ELM327: >

OR

ELM327: 01
ELM327: 0F 4
ELM327: 1 5C >

From the sample output above, the desired data that we need is the "5C" for this example. As you can see, the "5C" doesn't appear in a predictable manner which makes this a challenge to obtain the data we need. Note that these are only two samples of the possible message format.

To solve this problem, the use of Regular Expressions and built in Java String functions were used. The Java String functions that were utilized were trim(), split(), and matches(). The String.trim() allowed for us to remove any extra padded spaces in front and back of a string message received from the ELM327. String.split() allowed for us to split up the received string message into message bytes using space (" ") as a delimiter. It was desired to split up the received message since the data that follows the PID, is the data we want to retrieve. String.matches() functions by using Regular Expressions to check with selected data. If the data matches the corresponding regular expression then it is parsed, otherwise it is just simply ignored.

The regular expression pattern used to match for MPH, intake temperature, engine load, and coolant temperature was "\s*[0-9A-Fa-f]{2} [0-9A-Fa-f]{2}\s*\r?\n?".

A drawback of using String.matches() and regular expressions is that it is a "hit or miss" scenario. This is due to the fact that the message received will either match or not match with the given regular expression. To address this, all message possibilities must be addressed and accounted for with regular expressions. This is essential to the performance of our application because the more matches obtained will give the user a real time response.

Conclusion

Coming into this project, the team members had no experience with Java and Android application programming. With the 9 weeks given for the project, we were able to learn how to use the Android SDK to create an Android application. Our Android application is able to communicate with the PLX Kiwi Bluetooth and display the parameters in real time to the user. We were also able to create circular gauges from scratch to display information visually using the RotateAnimation API. Although we have had great success, we faced a lot of challenges through the implementation of the Android application. One of those challenges dealt with getting the BluetoothChat sample code to operate correctly with the tablet and an SPP device. Another challenge was to parse the data received from the PLX Kiwi which was solved using regular expressions. Lastly, the gauges needed to be constructed from scratch because after doing some research, the team found that there wasn't really any good APIs to use with the project.

For future work on this project, we can move further by adding more features such as the ability to read diagnostic trouble codes and explain what each code means. Also, we can have the functionality for a user to customize their home screen to select which parameters to display on the gauges. There is a lot of room for improvement with the Android application and the team looks forward to upgrading the application.

Project Video

CmpE146 F12 T6 Demonstration Video

Project Source Code

References

Acknowledgement

We would like the thank the following people for their contributions during this project:

  • Preet Kang
  • Michael Cox
  • Christopher Tugangui
  • Ryan Branche

References Used

Appendix

Retrieved from "http://socialledge.com/sjsu/index.php?title=F12:_OBD-II_Android_Monitor&oldid=2945"