doc: AssistedSatelliteNavigation and Agent API
authorSimon Lethbridge <simon.lethbridge@stericsson.com>
Sat, 29 Jan 2011 23:44:43 +0000 (00:44 +0100)
committerDenis Kenzior <denkenz@gmail.com>
Thu, 3 Feb 2011 16:21:42 +0000 (10:21 -0600)
This patch introduces support for Global Satellite Navigation System (GNSS),
using the AT commands AT+CPOS and +CPOSR as specified 3GPP 27.007.

doc/assisted-sattelite-navigation.txt [new file with mode: 0644]

diff --git a/doc/assisted-sattelite-navigation.txt b/doc/assisted-sattelite-navigation.txt
new file mode 100644 (file)
index 0000000..296fde8
--- /dev/null
@@ -0,0 +1,56 @@
+Assisted Satellite Navigation hierarchy [experimental]
+==========================================================
+
+Service                org.ofono
+Interface      org.ofono.AssistedSatelliteNavigation
+Object path    [variable prefix]/{modem0,modem1,...}
+
+Methods                void SendPositioningElement(string xml_element)
+
+                       Send an XML element conforming to the XML DTD for <pos>
+                       as defined in 3GPP 27.007 Table 8.55-2. This xml is
+                       used for transferring data associated with positioning
+                       requests received via control plane from the network.
+                       This includes assistance data requests and the results
+                       of positioning procedures. This method maps directly to
+                       the 3GPP 27.007 AT+CPOS command.
+
+               void RegisterPositioningRequestAgent(object path)
+
+                       Registers an agent which will be called whenever a
+                       CPOSR AT response is received. The Agent must respond
+                       to requests using SendPositioningElement.
+
+               void UnregisterPositioningRequestAgent(object path)
+
+                       Un-registers the agent.
+
+PositioningRequestAgent hierarchy
+==================================
+
+Service                unique name
+Interface      org.ofono.PositioningRequestAgent
+Object path    freely definable
+
+Methods                void Request(string xml_element)
+
+                       Receive an XML element conforming to the XML DTD for
+                       <pos> in 3GPP 27.007. This xml is used for transferring
+                       data associated with positioning requests received, via
+                       control plane, from the network. This includes
+                       measurement requests and assistance data. This method
+                       maps directly to the 3GPP defined +CPOSR unsolicited
+                       result code.
+
+               void ResetAssistanceData()
+
+                       A request has been received from the network that all
+                       assistance data should be reset.  This is used for 3gpp
+                       performance tests.
+
+               void Release()
+
+                       Agent is being released, possibly because of oFono
+                       terminating, AssistedSatelliteNavigation interface
+                       is being torn down or modem off.
+                       No UnregisterPositioningRequestAgent call is needed.