GPS Provider

The GPS Provider gets location coordinates from the integrated GNSS receiver.
If present, this provider determines location using GNSS satellites. The responsiveness and accuracy of location fixes may depend on GNSS signal conditions.
Locations returned from this provider are with respect to the primary GNSS antenna position within the device.

Configuration

  • Interval
    The refresh interval as time value like 30s, 5m or 4h.
    Default in one minute 60s, shorter interval times may increase power usage.

  • Speed Unit
    Select the unit of the speed results:

    Unit Meaning

    km/h

    Kilometers per hour

    mph

    Miles per hour

    kn

    Knots

    m/s

    Metre per second

  • Ignore Sleep
    True to continue receiving GPS data during device sleep (in Ambient Mode), false to stop GPS requests while the device is sleeping.
    Default is false.

    Caution
    Ignoring sleep may lead to higher power consumption and might drain the battery faster.
    If no GPS dependent information is needed in Ambient/Standby Mode, this option should be turned off.

Query

  • Status
    Get the GNSS status.

    Text Numeric

    N/A

    0

    Location is not yet available (init) or permission is missing

    Excellent

    1

    Location is available

    Fail

    5

  • Latitude, Longitude (Coordinates)
    GPS Coordinates in Decimal degrees (DD) or Degrees Minutes Seconds (DMS) format.

    • Param1
      Select the output format.

      DD

      Format as "latitude, longitude", e.g. 41.40338, 2.17403.
      Decimal separator is a dot.

      DMS

      Format as "latitude N longitude W", e.g. 32° 34' 56" N 9° 18' 15" E.

  • Latitude
    Latitude in Decimal degrees (DD) format like 41.40338.

  • Longitude
    Longitude in Decimal degrees (DD) format like 2.17403.

  • Altitude
    The altitude of this location in meters above the WGS84 reference ellipsoid.

  • Speed
    Returns the speed at the time in the selected unit.

  • Bearing
    Returns the bearing at the time of this location in degrees.
    Bearing is the horizontal direction of travel of this device and is unrelated to the device orientation.

  • Accuracy
    Returns the estimated horizontal accuracy radius in meters of this location at the 68th percentile confidence level.
    This means that there is a 68% chance that the true location of the device is within a distance of this uncertainty of the reported location.

  • Fix Time
    Returns the UTC time of the last location fix.
    There is no guarantee that different locations have times set from the same clock. The time originates from the clock in use by the satellite constellation that provided the fix.

    Text Numeric

    Time in UTC in the format specified by Param 1

    Milliseconds since epoch 1970-01-01 00:00:00 UTC

    • Param 1
      The time format of the text representation. See Time Format for details.
      If empty, the default ISO format "yyyy-MM-dd’T’HH:mm:ss.SSS" is used.

  • Is Fix Valid
    Returns 1 if the location fix is valid, 0 if the location is inaccurate or invalid.

  • Sat Count
    The number of received satellites.