README.md

   1 # Automotive Message Broker Daemon {#ambd}
   2
   3 Version 0.13.803
   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 ## Packaging
  51
  52 To generate packaging, you must first run cmake to generate the necessary packaging files:
  53
  54 ~~~~~~~~~~~~~{.bash}
  55 mkdir build
  56 cd build && cmake ..
  57 cd ..
  58 ~~~~~~~~~~~~~
  59
  60 After running cmake, to create a debian package run:
  61
  62 ~~~~~~~~~~~~~{.bash}
  63 debuild
  64 ~~~~~~~~~~~~~
  65
  66 To create an RPM package, run:
  67
  68 ~~~~~~~~~~~~~{.bash}
  69 rpmbuild [options] packaging/automotive-message-broker.spec
  70 ~~~~~~~~~~~~~
  71
  72 ## Running with the Qt mainloop:
  73
  74 Some source and sink plugins may want to use the Qt-based mainloop to take advantage of Qt features. To enable
  75 the Qt mainloop, run cmake with -Dqtmainloop=On:
  76
  77 ~~~~~~~~~~~~~{.bash}
  78 cmake .. -Dqtmainloop=On
  79 ~~~~~~~~~~~~~
  80
  81 You will also need to edit your config to enable the Qt-based mainloop:
  82
  83 ~~~~~~~~~~~~~{.json}
  84 {
  85         "mainloop" : "/usr/lib/i386-linux-gnu/automotive-message-broker/qtmainloopplugin.so",
  86         "plugins" : "/etc/ambd/plugins.d"
  87 }
  88 ~~~~~~~~~~~~~
  89
  90 NOTE: by default the glib mainloop will be used.
  91
  92 ## Questions/Issues/Comments:
  93
  94 Questions or Comments can be emailed to the amb mailing list:
  95 **amb at lists.01.org**
  96
  97 Issues and Feature requests can be submitted on our github page:
  98 https://github.com/otcshare/automotive-message-broker/issues