blob: 8291ecf620c02d4069a564fc95fb0d7f1107486f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>automotive-message-broker: Automotive Message Broker Documentation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">automotive-message-broker
 <span id="projectnumber">0.14.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Automotive Message Broker Documentation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="section version"><dt>Version</dt><dd>0.14.0 </dd></dl>
<h1><a class="anchor" id="links"></a>
AMB Documentation Sections</h1>
<ul>
<li><a class="el" href="ambd.html">Automotive Message Broker Daemon</a></li>
<li><a class="el" href="amb_8fidl.html#dbus_api">Automotive Message Broker DBus API Documentation</a> - Using AMB with your application</li>
<li><a class="el" href="libamb_8h.html#libamb">Automotive Message Broker Library Documentation</a> - Developing AMB or AMB plugins</li>
<li><a class="el" href="plugins_8idl.html#plugins">AMB Plugin documentation</a> - Using Built in AMB plugins</li>
<li><a class="el" href="release_notes.html">AMB Release Notes</a> - Current release notes</li>
</ul>
<h1><a class="anchor" id="intro"></a>
Introduction</h1>
<p>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: </p><div class="image">
<img src="AMBArchitecture.png" alt="AMBArchitecture.png"/>
</div>
<p> AMB works by passing "Properties" from "source" plugins to interested "sink" plugins. These properties represent vehicle data, ie '<a class="el" href="interfaceVehicleSpeed.html" title="Corresponds with DBus Interface org.automotive.VehicleSpeed. ">VehicleSpeed</a>' represents the vehicle's ground velocity.</p>
<p>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).</p>
<p>More information about AMB plugins can be found in the <a href="../amb/html/index.html">library documentation</a>. </p>
<h1><a class="anchor" id="crosswalk"></a>
Crosswalk Vehicle Extension</h1>
<p>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. </p>
<h1><a class="anchor" id="licensing"></a>
Licensing</h1>
<p>AMB is licensed LGPL v2. This allows the creation of proprietary plugins. </p>
<h1><a class="anchor" id="previous_versions"></a>
Previous Versions</h1>
<ul>
<li><a href="../../0.13/index.html">0.13</a></li>
<li><a href="../../0.12/docs/amb/html/index.html">0.12 library Documentation</a></li>
<li><a href="../../0.12/docs/dbus/html/index.html">0.12 DBus API Documentation</a> </li>
</ul>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|
