location-reporting: add documentation

diff --git a/Makefile.am b/Makefile.am
index b0056f0..5bf4fbc 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -423,7 +423,8 @@ doc_files = doc/overview.txt doc/ofono-paper.txt doc/release-faq.txt \
                        doc/phonebook-api.txt doc/radio-settings-api.txt \
                        doc/sim-api.txt doc/stk-api.txt \
                        doc/audio-settings-api.txt doc/text-telephony-api.txt \
-                       doc/calypso-modem.txt doc/message-api.txt
+                       doc/calypso-modem.txt doc/message-api.txt \
+                       doc/location-reporting-api.txt
 
 
 test_scripts = test/backtrace \

diff --git a/doc/location-reporting-api.txt b/doc/location-reporting-api.txt
new file mode 100644 (file)
index 0000000..b8ce840
--- /dev/null
+++ b/doc/location-reporting-api.txt
@@ -0,0 +1,39 @@
+Location Reporting Hierarchy [experimental]
+=================
+
+Service                org.ofono
+Interface      org.ofono.LocationReporting
+Object path    [variable prefix]/{modem0,modem1,...}
+
+Methods                dict GetProperties()
+
+                       Returns all LocationReporting properties. See the
+                       properties section for available properties.
+
+               byte Request()
+
+                       Asks to turn ON the NMEA stream and supplies the
+                       gps device file descriptor. The external cliend should
+                       use the file descriptor to receive the NMEA data.
+
+                       Possible Errors: [service].Error.InProgress
+                                        [service].Error.InUse
+                                        [service].Error.Failed
+
+               void Release()
+
+                       Releases the gps device file descriptor and turns
+                       OFF the NMEA stream.
+
+                       Possible Errors: [service].Error.InProgress
+                                        [service].Error.NotAvailable
+                                        [service].Error.Failed
+
+Properties     boolean Enabled [readonly]
+
+                        Boolean representing the state of the NMEA stream.
+
+               string Type [readonly]
+
+                       Holds the type of the device. Currently only NMEA is
+                       supported.