Class: QgsGpsInformation¶

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.

Attributes

`direction`	The bearing measured in degrees clockwise from true north to the direction of travel.
`elevation`	Altitude (in meters) above or below the mean sea level.
`elevation_diff`	Geoidal separation (in meters).
`fixMode`	Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)
`fixType`	Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix
`hacc`
`hdop`	Horizontal dilution of precision.
`hvacc`	3D RMS
`latitude`	Latitude in decimal degrees, using the WGS84 datum.
`longitude`	Longitude in decimal degrees, using the WGS84 datum.
`pdop`	Dilution of precision.
`quality`	GPS quality indicator (0 = Invalid; 1 = Fix; 2 = Differential, 3 = Sensitive, etc.)
`qualityIndicator`	Returns the signal quality indicator
`satInfoComplete`	`True` if satellite information is complete.
`satPrn`	IDs of satellites used in the position fix.
`satellitesInView`	Contains a list of information relating to the current satellites in view.
`satellitesUsed`	Count of satellites used in obtaining the fix.
`speed`	Ground speed, in km/h.
`status`	Status (A = active or V = void)
`utcDateTime`	The date and time at which this position was reported, in UTC time.
`utcTime`	The time at which this position was reported, in UTC time.
`vacc`
`vdop`	Vertical dilution of precision.

class qgis.core.QgsGpsInformation[source]¶

Bases: object

FixStatus¶: alias of GpsFixStatus

bestFixStatus(self)[source]¶

Returns the best fix status and corresponding constellation.

Returns:

best current fix status
constellation: the constellation with best fix status

Added in version 3.30.

componentValue(self, component: Qgis.GpsInformationComponent) → Any[source]¶

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¶: The bearing measured in degrees clockwise from true north to the direction of travel.

elevation¶: Altitude (in meters) above or below the mean sea level.

elevation_diff¶

Geoidal separation (in meters).

The difference between the WGS-84 Earth ellipsoid and the mean sea level (geoid).

Negative values indicate that mean sea level is below the ellipsoid.

This value can be added to the elevation value to obtain the geoidal elevation.

Added in version 3.18.

fixMode¶: Fix mode (where M = Manual, forced to operate in 2D or 3D or A = Automatic, 3D/2D)

fixStatus(self) → Qgis.GpsFixStatus[source]¶

Returns the fix status

Deprecated since version 3.40: Use constellationFixStatus() or bestFixStatus() instead.

Return type:: Qgis.GpsFixStatus

fixType¶: Contains the fix type, where 1 = no fix, 2 = 2d fix, 3 = 3d fix

Deprecated since version 3.40: Use constellationFixStatus() or bestFixStatus() instead.

hacc¶

hdop¶: Horizontal dilution of precision.

hvacc¶: 3D RMS

Added in version 3.18.

isValid(self) → bool[source]¶

Returns whether the connection information is valid

Added in version 3.10.

Return type:: bool

latitude¶: Latitude in decimal degrees, using the WGS84 datum. A positive value indicates the Northern Hemisphere, and a negative value indicates the Southern Hemisphere.

longitude¶: Longitude in decimal degrees, using the WGS84 datum. A positive value indicates the Eastern Hemisphere, and a negative value indicates the Western Hemisphere.

navigationStatus(self) → Qgis.GpsNavigationStatus[source]¶

Returns the navigation status.