The Setup() method

Setup (IN  u sources,
       IN  b signal_location);

Configure the location sources to use when gathering location information. Adding new location sources may require to enable them in the device (e.g. the GNSS engine will need to be started explicitly if a GPS source is requested by the user). In the same way, removing location sources may require to disable them in the device (e.g. when no GPS sources are requested by the user, the GNSS engine will need to be stopped explicitly).

This method may require the client to authenticate itself.

When location signaling is enabled by the user, any client application (including malicious ones!) would be able to use the "Location" property to receive location updates. If further security is desired, the signal_location argument can be set to FALSE to disable location updates via D-Bus signals and require applications to call authenticated APIs (like GetLocation()) to get the location information.

By default location signaling is disabled, and therefore the "Location" property will not be usable until explicitly enabled by the user.

The optional MM_MODEM_LOCATION_SOURCE_AGPS_MSA and MM_MODEM_LOCATION_SOURCE_AGPS_MSB allow to request MSA/MSB A-GPS operation, and they must be given along with either MM_MODEM_LOCATION_SOURCE_GPS_RAW or MM_MODEM_LOCATION_SOURCE_GPS_NMEA.

Both MM_MODEM_LOCATION_SOURCE_AGPS_MSA and MM_MODEM_LOCATION_SOURCE_AGPS_MSB cannot be given at the same time, and if none given, standalone GPS is assumed.

The GetLocation() method

GetLocation (OUT a{uv} Location);

Return current location information, if any. If the modem supports multiple location types it may return more than one. See the "Location" property for more information on the dictionary returned at location.

This method may require the client to authenticate itself.

The SetSuplServer() method

SetSuplServer (IN  s supl);

Configure the SUPL server for A-GPS.

The InjectAssistanceData() method

InjectAssistanceData (IN  ay data);

Inject assistance data to the GNSS module, which will allow it to have a more accurate positioning information.

The data files should be downloaded using external means from the URLs specified in the AssistanceDataServers property. The user does not need to specify the assistance data type being given.

There is no maximum data size limit specified, default DBus system bus limits apply.

This method may be used when the device does not have a mobile network connection by itself, and therefore it cannot use any A-GPS server to improve the accuracy of the position. In this case, the user can instead download the assistance data files using a WiFi or LAN network, and inject them to the GNSS engine manually.

The SetGpsRefreshRate() method

SetGpsRefreshRate (IN  u rate);

Set the refresh rate of the GPS information in the API. If not explicitly set, a default of 30s will be used.

The refresh rate can be set to 0 to disable it, so that every update reported by the modem is published in the interface.

The "Capabilities" property

Capabilities  readable   u

Bitmask of MMModemLocationSource values, specifying the supported location sources.

The "SupportedAssistanceData" property

SupportedAssistanceData  readable   u

Bitmask of MMModemLocationAssistanceDataType values, specifying the supported types of assistance data.

The "Enabled" property

Enabled  readable   u

Bitmask specifying which of the supported MMModemLocationSource location sources is currently enabled in the device.

The "SignalsLocation" property

SignalsLocation  readable   b

TRUE if location updates will be emitted via D-Bus signals, FALSE if location updates will not be emitted.

See the Setup() method for more information.

The "Location" property

Location  readable   a{uv}

Dictionary of available location information when location information gathering is enabled. If the modem supports multiple location types it may return more than one here.

For security reasons, the location information updates via this property are disabled by default. Users can use this property to monitor location updates only if the location signals are enabled with Setup(), but considering that enabling the location signals would allow all users to receive property updates as well, not just the process that enabled them. For a finer grained access control, the user can use the GetLocation() method instead, which may require the client to authenticate itself on every call.

This dictionary is composed of a MMModemLocationSource key, with an associated data which contains type-specific location information:

The "SuplServer" property

SuplServer  readable   s

SUPL server configuration for A-GPS, given either as IP:PORT or FQDN:PORT.

The "AssistanceDataServers" property

AssistanceDataServers  readable   as

URLs from where the user can download assistance data files to inject with InjectAssistanceData().

The "GpsRefreshRate" property

GpsRefreshRate  readable   u

Rate of refresh of the GPS information in the interface.