plugins/testplugin/README

   1 OBD-II Source Plugin
   2
   3 The OBD-II Source plugin uses ELM compatible scantools to get vehicle information.
   4 It is known to work with a number of commercial scantools including:
   5
   6 OBDLink MX
   7 OBDLink S
   8 OBDPro USB
   9
  10 To use the OBD-II Source plugin, add the following config to your /etc/ambd/config:
  11
  12
  13 "sources" : [
  14                 {
  15                         "name" : "OBD2Source",
  16                         "path" : "/usr/lib/automotive-message-broker/obd2sourceplugin.so",
  17                         "device" : "/dev/ttyUSB0",
  18                         "baud" : "9600",
  19                         "bluetoothAdapter" : ""
  20                 }
  21         ]
  22
  23 Configuration Key Definitions:
  24
  25 "name"
  26 name of plugin.  This key is not used by the plugin at this moment.
  27
  28 "path"
  29 path to plugin on the filesystem.
  30
  31 "device"
  32 OBD-II Scantool device.  This is usually a serial device.  For bluetooth devices, use the bluetooth address for example:
  33 "00:00:11:aa:bb:cc".
  34
  35 "baud"
  36 baud rate for OBD-II scantool.  OBDLink *-style scantool usually default to 115200.  Refer to your scantool
  37 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.
  38
  39 "bluetoothAdapter"
  40 Hardware address of the bluetooth adapter to use.  If value is blank (ie "bluetoothAdapter" : ""), the system default
  41 adapter will be used.  The bluetoothAdapter key is only used if the "device" key is also set to a bluetooth device address.
  42
  43
  44 Performance
  45
  46 Performance will vary with the scantool and the vehicle.  Here are the current performance numbers per tested scantool
  47 using the ECUSim2000 from scantool.net:
  48
  49 scantool - properties/second = (pids/s) - baud
  50
  51 OBDLink MX - 120 pids/s - N/A (varies with bluetooth radio)
  52 OBDLink S - 100 pids/s - 115200
  53 OBDPro USB - 43 pids/s - 9600
  54
  55
  56