Class: QgsGpsInformation

class qgis.core.QgsGpsInformation

Bases: sip.wrapper

Encapsulates information relating to a GPS position fix.

Enums

FixStatus

alias of GpsFixStatus

Methods

bestFixStatus

Returns the best fix status and corresponding constellation.

componentValue

Returns the value of the corresponding GPS information component.

constellationFixStatus

Returns a map of GNSS constellation to fix status.

fixStatus

Returns the fix status

isValid

Returns whether the connection information is valid

navigationStatus

Returns the navigation status.

qualityDescription

Returns a descriptive string for the signal quality.

setNavigationStatus

Sets the navigation status.

Signals

Attributes

FixStatus

alias of GpsFixStatus

bestFixStatus(self)

Returns the best fix status and corresponding constellation.

Returns:

  • best current fix status

  • constellation: will be set to the constellation with best fix status

Added in version 3.30.

componentValue(self, component: Qgis.GpsInformationComponent) Any

Returns the value of the corresponding GPS information component.

Added in version 3.30.

Parameters:

component (Qgis.GpsInformationComponent)

Return type:

Any

constellationFixStatus(self) Dict[Qgis.GnssConstellation, Qgis.GpsFixStatus]

Returns a map of GNSS constellation to fix status.

Added in version 3.30.

Return type:

Dict[Qgis.GnssConstellation, Qgis.GpsFixStatus]

direction
elevation
elevation_diff
fixMode
fixStatus(self) Qgis.GpsFixStatus

Returns the fix status

Deprecated since version ,: use constellationFixStatus() or bestFixStatus() instead.

Return type:

Qgis.GpsFixStatus

fixType
hacc
hdop
hvacc
isValid(self) bool

Returns whether the connection information is valid

Added in version 3.10.

Return type:

bool

latitude
longitude
navigationStatus(self) Qgis.GpsNavigationStatus

Returns the navigation status.

Added in version 3.38.

Return type:

Qgis.GpsNavigationStatus

pdop
quality
qualityDescription(self) str

Returns a descriptive string for the signal quality.

Added in version 3.16.

Return type:

str

qualityIndicator
satInfoComplete
satPrn
satellitesInView
satellitesUsed
setNavigationStatus(self, status: Qgis.GpsNavigationStatus)

Sets the navigation status.

Added in version 3.38.

Parameters:

status (Qgis.GpsNavigationStatus)

speed
status
utcDateTime
utcTime
vacc
vdop