diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/location-reporting-api.txt | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/location-reporting-api.txt b/doc/location-reporting-api.txt new file mode 100644 index 00000000..b8ce840b --- /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. |