2 * \mainpage Automotive Message Broker DBus API Documentation
4 * \section intro Introduction
5 * AMB organizes the API into two general interface categories. First the Manager interface (see manager.txt)
6 * which includes tools for using the other interfaces. Second is a number of interfaces that
7 * represent vehicle data. The latter follows the schema of "org.automotive.DataType" and are
8 * contained in verious DBus paths. The DBus paths are generally organized by
9 * /{source}/{zone}/DataType. "source" refers to the AMB source that produces the data. "zone"
10 * refers to the zone in which the data type is located in the vehicle or "0" for no zone.
12 * The interfaces and data types are documented in <a href="amb.fidl">amb.fidl</a>. Franca IDL
13 * tools can be used to generate DBus introspection xml which can be used to generate bindings
14 * for your language of choice.
16 * \section basic_usage Basic Recommended Usage
18 * It is recommended that the Manager interface be used to find the DBus Object that contains the
19 * data type you need. This is done through the FindObject() call. It is expected that DBus
20 * Object Paths may change and so it is not appropriate to hard code DBus Object Paths.
22 * \section example Usage Example
23 * Here is a pseudo-code example of how the api is to be used:
26 * var manager = dbus.interface("org.automotive.Manager", "/");
28 * var speedObjectPaths = manager.FindObject("VehicleSpeed");
30 * var speedObject = dbus.interface("org.automotive.VehicleSpeed", speedObjectPaths[0]);
32 * console.log("Vehicle Speed: " + speedObject.Speed);