From 98099941d293845e88f70953e1e57786a6a38432 Mon Sep 17 00:00:00 2001 From: Kevron Rees Date: Thu, 26 Jun 2014 08:54:05 -0700 Subject: [PATCH] updated docs --- docs/amb.fidl | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/amb.fidl b/docs/amb.fidl index 9a7b655..26860e2 100644 --- a/docs/amb.fidl +++ b/docs/amb.fidl @@ -3,8 +3,10 @@ Automotive Message Broker DBus API Documentation AMB organizes the API into two general interfaces. First a Manager interface (see manager.txt) which includes tools for using the other interfaces. Second is a series of interfaces that -represent vehicle data. The later follows the schema of "org.automotive.DataType" and are -contained in verious DBus paths. +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. The data types are documented in the various *.txt files in this document folder. The manager interface is documented in the manager.txt document. @@ -18,11 +20,14 @@ DBus paths in the various documents are examples of paths and are not gauranteed Here is a pseudo-code example of how the api is to be used: -\example Array vehicleSpeedObjects = manager.FindObject("VehicleSpeed"); +\example +var manager = dbus.interface("org.automotive.Manager", "/"); -/// interact with the 'VehicleSpeed' property on the vehicleSpeed object +var speedObjectPaths = manager.FindObject("VehicleSpeed"); -log(vehicleSpeedObjects[0].VehicleSpeed); +var speedObject = dbus.interface("org.automotive.VehicleSpeed", speedObjectPaths[0]); + +console.log("Vehicle Speed: " + speedObject.Speed); \brief AMB DBus API describes the API to access vehicle information over DBus **/ @@ -144,7 +149,7 @@ interface org.automotive.Manager { String objectName } out { - UInt16[] zones + UInt32[] zones } } -- 2.7.4