summaryrefslogtreecommitdiffstats
path: root/doc/location-reporting-api.txt
blob: 21e346d48f7ef0735d7b95b7f03a0ce13a31d1f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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.

		filedescriptor 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.