README

   1 Automotive Message Broker is a vehicle network abstraction system.  It brokers information from the vehicle
   2 to applications.  It provides application with a rich API for accessing vehicle data.
   3
   4 Automotive Message Broker is built using CMake and requires libltdl (libtool), libjson-c, and boost packages.
   5
   6
   7 About the Git Tree:
   8 master is expected to be unstable and may not even compile.  If you want something more stable, checkout one of the
   9 release branches (ie, 0.9.0, 0.10, etc)
  10
  11
  12 To build:
  13
  14 cd automotive-message-broker
  15 mkdir build
  16 cd build
  17 cmake ..
  18 make
  19
  20 To install:
  21
  22 sudo make install
  23
  24 To run:
  25
  26 ambd
  27
  28 ambd can load different plugins.  The config file specifies what plugins to use.  The default config located in
  29 /etc/ambd/config.  You can change this or use your own config to have ambd use your own plugins.  For example:
  30
  31 # copy the config to your own config
  32 cp /etc/ambd/config myconfig
  33
  34 # edit myconfig and specify the path to your plugin:
  35 # change the line:
  36 "sources" : [ { "path" : "../plugins/examplesourceplugin.so" } ],
  37 # to:
  38 "sources" : [ { "path" : "/path/to/mysourceplugin.so" } ],
  39
  40 Now you can run ambd with:
  41
  42 ambd -c /path/to/myconfig
  43
  44 also see ambd -h
  45
  46 Typically, AMB will be used with the DBus plugin.  The DBus plugin automatically makes internal AMB properties
  47 available over DBus.  See the DBus plugin documentation for more information (plugins/dbus/README).
  48
  49
  50 Running with other plugins
  51
  52 To learn about running AMB with other plugins, please see the plugins/*/README.
  53
  54
  55 Running with the Qt mainloop:
  56
  57 Some source and sink plugins may want to use the Qt-based mainloop to take advantage of Qt features. To enable
  58 the Qt mainloop, run cmake with -Duse_qtcore=On:
  59
  60 cmake .. -Dqtmainloop=On
  61
  62 You will also need to edit your config to enable the Qt-based mainloop:
  63
  64 {
  65         "mainloop" : "/usr/lib/automotive-message-broker/qtmainloopplugin.so",
  66         "sources" : [...],
  67         "sinks" : [...]
  68 }
  69
  70 NOTE: by default the glib mainloop will be used.
  71
  72
  73
  74 Questions/Issues/Comments:
  75
  76 Questions or Comments can be emailed to:
  77 tripzero.kev@gmail.com
  78
  79 Issues can be submitted on our github page:
  80 https://github.com/otcshare/automotive-message-broker/issues