summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevron Rees <kevron.m.rees@intel.com>2015-01-06 18:46:42 -0800
committerKevron Rees <kevron.m.rees@intel.com>2015-01-06 18:46:42 -0800
commita117ec1bbc1a7f055d703169aa9f34c4c25066b9 (patch)
tree328d0c051e76ade4e18b0258bbc5b72ec1ca96ca
parente162b24f59f0fe68494cd98d2a944854f6584036 (diff)
downloadautomotive-message-broker-a117ec1bbc1a7f055d703169aa9f34c4c25066b9.tar.gz
[Documentation] - Added more content to the main page
-rw-r--r--docs/amb.in.fidl3
-rw-r--r--docs/libamb.in5
-rw-r--r--docs/mainpage.in.idl31
3 files changed, 35 insertions, 4 deletions
diff --git a/docs/amb.in.fidl b/docs/amb.in.fidl
index d0381900..0a63fe20 100644
--- a/docs/amb.in.fidl
+++ b/docs/amb.in.fidl
@@ -1,5 +1,8 @@
/*!
* \mainpage Automotive Message Broker DBus API Documentation
+* \version @PROJECT_VERSION@
+*
+* <a href="../../html/index.html">Back to AMB Documentation Main</a>
*
* \section intro Introduction
* AMB organizes the API into two general interface categories. First the Manager interface (see manager.txt)
diff --git a/docs/libamb.in b/docs/libamb.in
index ace28a9e..f2197dd5 100644
--- a/docs/libamb.in
+++ b/docs/libamb.in
@@ -1,6 +1,9 @@
-/**
+/*!
\mainpage Automotive Message Broker Library Documentation
\version @PROJECT_VERSION@
+
+ <a href="../../html/index.html">Back to AMB Documentation Main</a>
+
\section intro Introduction
Automotive Message Broker (AMB) Library documentation outlines the internal classes and structures for building
plugins for AMB.
diff --git a/docs/mainpage.in.idl b/docs/mainpage.in.idl
index 0e29a6f1..e36467f4 100644
--- a/docs/mainpage.in.idl
+++ b/docs/mainpage.in.idl
@@ -2,13 +2,38 @@
* \mainpage Automotive Message Broker Documentation
* \version @PROJECT_VERSION@
* \section links AMB Documentation Sections
-* - <a href="../dbus/html/index.html">DBus API documentation</a>
-* - <a href="../amb/html/index.html">libamb internal API documentation</a>
+* - <a href="../dbus/html/index.html">DBus API documentation</a> - Using AMB with your application
+* - <a href="../amb/html/index.html">libamb internal API documentation</a> - Developing AMB or AMB plugins
* - <a href="../plugins/bluemonkey/html/index.html">Bluemonkey Javascript API documentation</a>
-*
+* - <a href="../plugins/websocket/html/index.html">AMB Websocket protocol documentation</a>
* \section intro Introduction
* Automotive Message Broker (AMB) is a framework for providing applications with standardized access to vehicle data.
* It uses a plugin architecture to allow customization for different vehicles and devices. Here is a diagram of how
* AMB is architected:
* \image html AMBArchitecture.png
+* AMB works by passing "Properties" from "source" plugins to interested "sink" plugins. These properties represent
+* vehicle data, ie 'VehicleSpeed' represents the vehicle's ground velocity.
+*
+* In General, AMB "source" plugins produce data and AMB "sink" plugins consume them. However, it is possible that a
+* source can also consumes data. AMB supports multiple simultaneous source and sink plugins. This allows for aggregation
+* from multiple vehicle networks, the cloud, or even from other instances of AMB running elsewhere (via the websocket
+* plugins).
+*
+* More information about AMB plugins can be found in the <a href="../amb/html/index.html">library documentation</a>.
+* \section plugins AMB Plugins
+* AMB plugins each have their own usage documentation including any special Properties they define. Below is a description
+* of several AMB plugins and their documenation:
+* - <a href="../plugins/bluemonkey.README">Bluemonkey</a> - Extensible javascript engine plugin for defining plugin behavior in javascript
+* - <a href="../plugins/database.README">Database</a> - Plugin that logs data in a sqlite database and can play back logs
+* - <a href="../plugins/dbus.README">DBus</a> - Exposes AMB Properties on DBus
+* - <a href="../plugins/gpsnmea.README">GPSNmea</a> - GPS Plugin that provides location position data from NMEA compatible devices
+* - <a href="../plugins/obd2.README">OBD-II</a> - Plugin that provides data from OBD-II compatible vehicles
+* - <a href="../plugins/opencvlux.README">OpenCVLux</a> - Plugin that uses OpenCV to produce ADAS data and perform video logging
+* - <a href="../plugins/websocket.README">Websocket</a> - Both source and sink plugin that uses a websocket protocol to communicate
+* - <a href="../plugins/wheel.README">Wheel</a> - Plugin that generates data using the Logitech G27 racing wheel
+* \section crosswalk Crosswalk Vehicle Extension
+* AMB also comes with a <a href="http://crosswalk-project.org">crosswalk</a> extension that implements the W3C Automotive Business group
+* <a href="https://rawgit.com/w3c/automotive-bg/master/vehicle_spec.html">vehicle</a> and <a href="https://rawgit.com/w3c/automotive-bg/master/data_spec.html">data</a> specifications.
+* \section licensing Licensing
+* AMB is licensed LGPL v2. This allows the creation of proprietary plugins.
*/