plugins/gpsnmea/README

   1 # GPS NMEA plugin {#gpsnmea_plugin}
   2 Version: @PROJECT_VERSION@
   3
   4 This plugin uses NMEA-compatible devices to provide location information to AMB.
   5
   6 To enable the GPS NMEA plugin, run cmake and enable the gpsnmea_plugin option:
   7
   8 cmake -Dgpsnmea_plugin=On ..
   9
  10 To use the Database plugin, add the following to the "sources" array in /etc/ambd/config:
  11
  12 ~~~~~~~~~~~~~{.json}
  13 {
  14         "name" : "gpsnmea",
  15         "path" : "@PLUGIN_INSTALL_PATH@/gpsnmea.so",
  16         "device" : "/dev/ttyUSB0",
  17         "baudrate" : "4800",
  18         "bluetoothAdapter" : "00:00:00:00:00:00"
  19 }
  20 ~~~~~~~~~~~~~
  21
  22 ## Configuration Key Definitions:
  23
  24 "name"
  25 name of plugin.  This key is not used by the plugin at this moment.
  26
  27 "path"
  28 path to plugin on the filesystem.
  29
  30 "device"
  31 gps device.  This must be a serial device.  It can also be a bluetooth address.
  32
  33 Default: none
  34
  35 "baudrate"
  36 Baudrate for serial devices : 2400,4800,9600,19200 or 38400.
  37
  38 Default: 9600
  39
  40 "bluetoothAdapter"
  41 bluetooth adapter to use.  This is only used if "device" is also a bluetooth device.
  42 If left blank, the system default adapter will be used.
  43
  44 Default: none
  45
  46 ## AMB Properties:
  47
  48 GpsTime
  49 Timestamp in seconds from unix epoc (UTC) parsed from the NMEA output.
  50
  51 Type: double
  52 Access: readonly
  53
  54 GpsSpeed
  55 Speed as reported by GPS
  56
  57 Type: UInt16
  58 Access: readonly
  59
  60 GpsFix
  61 Fix status.
  62
  63 ~~~~~~~~~~~~(.cpp}
  64 enum FixType {
  65         NoFix = 1,
  66         Fix2D = 2,
  67         Fix3D = 3
  68 };
  69 ~~~~~~~~~~~~
  70
  71 Type: int
  72 Access: readonly
  73
  74 GpsSatsUsed {#GpsSatsUsed}
  75 How many satellites are being used in the fix
  76
  77 Type: UInt16
  78 Access: readonly
  79
  80 GpsNmea
  81 Raw NMEA message.  Useful for debugging
  82
  83 Type: String
  84 Access: readonly
  85
  86 ## DBus Interfaces:
  87
  88 ### org.automotive.GpsInfo
  89 **Properties**
  90 GpsTime - Corresponds with the GpsTime AMB Property
  91 Speed - Corresponds with the GpsSpeed AMB Property
  92 Fix - Corresponds with the GpsFix AMB Property
  93 SattelitesUsed - Corresponds with the GpsSatsUsed AMB Property
  94 RawNmea - Corresponds with the GpsNmea AMB Property
  95
  96 interface GpsInfo
  97 {
  98
  99 }