README.md

   1 # Automotive Message Broker Daemon {#ambd}
   2
   3 Version 0.15
   4
   5 ## Introduction
   6
   7 Automotive Message Broker is a vehicle network abstraction system.  It brokers information from the vehicle
   8 to applications.  It provides application with a rich API for accessing vehicle data.
   9
  10 Automotive Message Broker is built using CMake and requires libltdl (libtool), libjson-c, and boost packages.
  11
  12 ## Git
  13 About the Git Tree:
  14 'master' is expected to be unstable and may not even compile.  If you want something more stable, checkout one of the
  15 release branches (ie, 0.9.0, 0.10, etc)
  16
  17 ## Building
  18
  19 To build:
  20
  21 ~~~~~~~~~~~~~{.bash}
  22 cd automotive-message-broker
  23 mkdir build
  24 cd build
  25 cmake ..
  26 make
  27 ~~~~~~~~~~~~~
  28
  29 ## Installing
  30
  31 To install:
  32
  33 ~~~~~~~~~~~~~{.bash}
  34 sudo make install
  35 ~~~~~~~~~~~~~
  36
  37 ## Running
  38 To run:
  39
  40 ~~~~~~~~~~~~~{.bash}
  41 ambd
  42 ~~~~~~~~~~~~~
  43
  44 *also see **ambd -h** for additional command line options*
  45
  46 ## Configuration
  47
  48 For information on ambd's configuration, please see ambd-configuration.idl.
  49
  50 ## Running with the Qt mainloop:
  51
  52 Some source and sink plugins may want to use the Qt-based mainloop to take advantage of Qt features. To enable
  53 the Qt mainloop, run cmake with -Duse_qtcore=On:
  54
  55 ~~~~~~~~~~~~~{.bash}
  56 cmake .. -Dqtmainloop=On
  57 ~~~~~~~~~~~~~
  58
  59 You will also need to edit your config to enable the Qt-based mainloop:
  60
  61 ~~~~~~~~~~~~~{.json}
  62 {
  63         "mainloop" : "/PLUGIN_INSTALL_PATH/qtmainloopplugin.so",
  64         "plugins" : "/etc/ambd/plugins.d"
  65 }
  66 ~~~~~~~~~~~~~
  67
  68 NOTE: by default the glib mainloop will be used.
  69
  70 ## Questions/Issues/Comments:
  71
  72 Questions or Comments can be emailed to the amb mailing list:
  73 **amb at lists.01.org**
  74
  75 Issues and Feature requests can be submitted on our github page:
  76 https://github.com/otcshare/automotive-message-broker/issues