summaryrefslogtreecommitdiff
path: root/plugins/obd2plugin/README
blob: c8bdf2edf360b7de637722c888974af36ac5870e (plain)
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
48
49
50
51
52
53
54
55
56
# OBD-II Source Plugin {#obd2_plugin}
Version: @PROJECT_VERSION@

The OBD-II Source plugin uses ELM compatible scantools to get vehicle information.
It is known to work with a number of commercial scantools including:

OBDLink MX
OBDLink S
OBDPro USB

To use the OBD-II Source plugin, add the following config to your /etc/ambd/config:

~~~~~~~~~~~~~{.json}
{
	"name" : "OBD2Source",
	"path" : "@PLUGIN_INSTALL_PATH@/obd2sourceplugin.so",
	"device" : "/dev/ttyUSB0",
	"baud" : "9600",
	"bluetoothAdapter" : ""
}
~~~~~~~~~~~~~

## Configuration Key Definitions:

"name"
name of plugin.  This key is not used by the plugin at this moment.

"path"
path to plugin on the filesystem.

"device"
OBD-II Scantool device.  This is usually a serial device.  For bluetooth devices, use the bluetooth address for example:
"00:00:11:aa:bb:cc".

"baud"
baud rate for OBD-II scantool.  OBDLink *-style scantool usually default to 115200.  Refer to your scantool
docutmentation for the correct baud rate.  Note also that some bluetooth scantools, like the OBDLink MX have automatic baud selection and will ignore this value.

"bluetoothAdapter"
Hardware address of the bluetooth adapter to use.  If value is blank (ie "bluetoothAdapter" : ""), the system default
adapter will be used.  The bluetoothAdapter key is only used if the "device" key is also set to a bluetooth device address.


## Performance

Performance will vary with the scantool and the vehicle.  Here are the current performance numbers per tested scantool
using the ECUSim2000 from scantool.net:

scantool - properties/second = (pids/s) - baud

OBDLink MX - 120 pids/s - N/A (varies with bluetooth radio)
OBDLink S - 100 pids/s - 115200
OBDPro USB - 43 pids/s - 9600