diff options
Diffstat (limited to '0.14/amb_8fidl.html')
| -rw-r--r-- | 0.14/amb_8fidl.html | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/0.14/amb_8fidl.html b/0.14/amb_8fidl.html new file mode 100644 index 00000000..c402068a --- /dev/null +++ b/0.14/amb_8fidl.html @@ -0,0 +1,181 @@ +<!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: amb.fidl File Reference</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><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 class="current"><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 id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +<!-- 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><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">amb.fidl File Reference<div class="ingroups"><a class="el" href="group__dbus__api__module.html">Dbus_api_module</a></div></div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionVariant.html">Variant</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:aea9b81502a85e8451cb2de497511ce5c"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unionVariant.html">Variant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="amb_8fidl.html#aea9b81502a85e8451cb2de497511ce5c">GetHistory</a> (Double beginTime, Double endTime)</td></tr> +<tr class="memdesc:aea9b81502a85e8451cb2de497511ce5c"><td class="mdescLeft"> </td><td class="mdescRight">HistoryObject is returned with GetHistory call. <a href="#aea9b81502a85e8451cb2de497511ce5c">More...</a><br /></td></tr> +<tr class="separator:aea9b81502a85e8451cb2de497511ce5c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><h1><a class="anchor" id="dbus_api"></a> +Automotive Message Broker DBus API Documentation</h1> +<dl class="section version"><dt>Version</dt><dd>0.14.0</dd></dl> +<h1><a class="anchor" id="dbus_api_intro"></a> +Introduction</h1> +<p>This document describes the DBus interfaces and data types for the Automotive Message Broker API. The data types are intended to as-close-as- possible be compatible with the W3C vehicle <a href="https://rawgit.com/w3c/automotive-bg/master/data_spec.html">data spec</a>.</p> +<p>AMB organizes the API into two general interface categories. First the Manager interface (see manager.txt) which includes tools for using the other interfaces. Second is a number of interfaces that represent vehicle data. The latter follows the schema of "org.automotive.DataType" and are contained in verious DBus paths. The DBus paths are generally organized by /{source}/{zone}/DataType. "source" refers to the AMB source that produces the data. "zone" refers to the zone in which the data type is located in the vehicle or "0" for no zone.</p> +<p>The interfaces and data types are documented in <a href="amb.fidl">amb.fidl</a>. Franca IDL tools can be used to generate DBus introspection xml which can be used to generate bindings for your language of choice. These interfaces types map to internal AMB properties. To understand the mappings, see the <a href="ambdbusmappings_8idl.html">mapping documentation</a></p> +<h1><a class="anchor" id="dbus_api_basic_usage"></a> +Basic Recommended Usage</h1> +<p>It is recommended that the Manager interface be used to find the DBus Object that contains the data type you need. This is done through the FindObject() call. It is expected that DBus Object Paths may change and so it is not appropriate to hard code DBus Object Paths.</p> +<p>Here is a pseudo-code example of how the api is to be used:</p> +<div class="fragment"><div class="line">var manager = dbus.interface(<span class="stringliteral">"org.automotive.Manager"</span>, <span class="stringliteral">"/"</span>);</div><div class="line"></div><div class="line">var speedObjectPaths = manager.FindObject(<span class="stringliteral">"VehicleSpeed"</span>);</div><div class="line"></div><div class="line">var speedObject = dbus.interface(<span class="stringliteral">"org.automotive.VehicleSpeed"</span>, speedObjectPaths[0]);</div><div class="line"></div><div class="line">console.log(<span class="stringliteral">"Vehicle Speed: "</span> + speedObject.Speed);</div></div><!-- fragment --> <h1><a class="anchor" id="dbus_api_automotive_manager"></a> +Automotive Manager</h1> +<p>Manager is a helper interface for discovering and finding available objects. Manager also helps users look up objects by zone and get additional information about a data type (ieorg.automotive.Manager.ZonesForObjectName). </p> +<h1><a class="anchor" id="dbus_api_zones"></a> +Zones</h1> +<p>'<a class="el" href="classZone.html">Zone</a>' describes the position in the vehicle where the object is located. The <a class="el" href="classZone.html">Zone</a> type is a bitfield of values that can be combined to describe a specific location. For example</p> +<div class="fragment"><div class="line"><a class="code" href="classZone.html">Zone</a>.Front | <a class="code" href="classZone.html">Zone</a>.Left</div></div><!-- fragment --><p>(which is '9') may represent the driver position.</p> +<div class="fragment"><div class="line">enumeration <a class="code" href="classZone.html">Zone</a> {</div><div class="line"> None = 0,</div><div class="line"> Front = 1,</div><div class="line"> Middle = 1 << 1,</div><div class="line"> Right = 1 << 2,</div><div class="line"> Left = 1 << 3,</div><div class="line"> Rear = 1 << 4,</div><div class="line"> Center = 1 << 5</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="dbus_api_vehicle_property_type"></a> +Vehicle Property Type</h1> +<p>Vehicle Property Type is the common interface which all Data types are derived. This interface is as follows:</p> +<div class="fragment"><div class="line"><span class="keyword">interface </span>VehiclePropertyType {</div><div class="line"> attribute Double Time readonly</div><div class="line"> attribute <a class="code" href="classZone.html">Zone</a> <a class="code" href="classZone.html">Zone</a> readonly</div><div class="line"> method <a class="code" href="amb_8fidl.html#aea9b81502a85e8451cb2de497511ce5c">GetHistory</a>(Double beginTime, Double endTime) {</div><div class="line"> out{ Dictionary result}</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="dbus_api_data_types"></a> +Data types</h1> +<p>The data types try to conform to the [<a href="http://w3c.github.io/automotive-bg/data_spec.html">http://w3c.github.io/automotive-bg/data_spec.html</a> W3C Automotive Business Group Vehicle Data Specification] as much as possible. There are differences in the <a class="el" href="classZone.html">Zone</a> type, and this vehicle API contains some additional data types that the W3C Business Group has not yet defined. 'Time' also represents relative time in seconds rather than time in ms since epoch (DOMTimeStamp). The names of the attributes are also different because of Web vs. DBus conventions. In this Vehicle API, DBus properties use CamelCase (ie Speed vs speed) vs lowerCamelCase. Units and types are the same where possible.</p> +<p>Also note that many types have been marked "deprecated" and replaced with the W3C version of the type. Deprecated types should not be used in new projects. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="aea9b81502a85e8451cb2de497511ce5c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">union <a class="el" href="unionVariant.html">Variant</a> GetHistory </td> + <td>(</td> + <td class="paramtype">Double </td> + <td class="paramname"><em>beginTime</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Double </td> + <td class="paramname"><em>endTime</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>HistoryObject is returned with GetHistory call. </p> +<p>Dictionary</p> +<p>Name of property</p> +<p>Value of property</p> +<p>Time in seconds since unix epoch.</p> +<p>VehiclePropertyType VehiclePropertyType is the base class for all Data types.</p> +<p>time in seconds since system start when a property in the interface updated.</p> +<p><a class="el" href="classZone.html">Zone</a> in which the interface is situated.</p> +<p>return dictionary of objectName and values for data between 'beginTime' and 'endTime' </p><ul> +<li>beginTime time stamp in Seconds since Unix Epoc </li> +<li>endTime time stamp in Seconds since Unix Epoc </li> +</ul> + +</div> +</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> |