twisted.positioning.nmea.NMEASentence

class documentation

class twisted.positioning.nmea.NMEASentence(_sentence._BaseSentence): (source)

View In Hierarchy

An object representing an NMEA sentence.

The attributes of this objects are raw NMEA protocol data, which are all ASCII bytestrings.

This object contains all the raw NMEA protocol data in a single sentence. Not all of these necessarily have to be present in the sentence. Missing attributes are None when accessed.

Instance Variable type The sentence type ("GPGGA", "GPGSV"...).
Instance Variable numberOfGSVSentences The total number of GSV sentences in a sequence.
Instance Variable GSVSentenceIndex The index of this GSV sentence in the GSV sequence.
Instance Variable timestamp A timestamp. ("123456" -> 12:34:56Z)
Instance Variable datestamp A datestamp. ("230394" -> 23 Mar 1994)
Instance Variable latitudeFloat Latitude value. (for example: "1234.567" -> 12 degrees, 34.567 minutes).
Instance Variable latitudeHemisphere Latitudinal hemisphere ("N" or "S").
Instance Variable longitudeFloat Longitude value. See latitudeFloat for an example.
Instance Variable longitudeHemisphere Longitudinal hemisphere ("E" or "W").
Instance Variable altitude The altitude above mean sea level.
Instance Variable altitudeUnits Units in which altitude is expressed. (Always "M" for meters.)
Instance Variable heightOfGeoidAboveWGS84 The local height of the geoid above the WGS84 ellipsoid model.
Instance Variable heightOfGeoidAboveWGS84Units The units in which the height above the geoid is expressed. (Always "M" for meters.)
Instance Variable trueHeading The true heading.
Instance Variable magneticVariation The magnetic variation.
Instance Variable magneticVariationDirection The direction of the magnetic variation. One of "E" or "W".
Instance Variable speedInKnots The ground speed, expressed in knots.
Instance Variable fixQuality The quality of the fix.
Instance Variable dataMode Signals if the data is usable or not.
Instance Variable numberOfSatellitesSeen The number of satellites seen by the receiver.
Instance Variable numberOfSatellitesUsed The number of satellites used in computing the fix.
Instance Variable horizontalDilutionOfPrecision The dilution of the precision of the position on a plane tangential to the geoid. (HDOP)
Instance Variable verticalDilutionOfPrecision As horizontalDilutionOfPrecision, but for a position on a plane perpendicular to the geoid. (VDOP)
Instance Variable positionDilutionOfPrecision Euclidean norm of HDOP and VDOP.
Instance Variable satellitePRN The unique identifcation number of a particular satellite. Optionally suffixed with _N if multiple satellites are referenced in a sentence, where N in range(4).
Instance Variable elevation The elevation of a satellite in decimal degrees. Optionally suffixed with _N, as with satellitePRN.
Instance Variable azimuth The azimuth of a satellite in decimal degrees. Optionally suffixed with _N, as with satellitePRN.
Instance Variable signalToNoiseRatio The SNR of a satellite signal, in decibels. Optionally suffixed with _N, as with satellitePRN.
Instance Variable usedSatellitePRN_N Where int(N) in range(12). The PRN of a satellite used in computing the fix.
Class Variable ALLOWED_ATTRIBUTES Undocumented
Method _isFirstGSVSentence Tests if this current GSV sentence is the first one in a sequence.
Method _isLastGSVSentence Tests if this current GSV sentence is the final one in a sequence.

Inherited from _BaseSentence:

Property presentAttributes An iterable containing the names of the attributes that are present in this sentence.
Method __init__ Initializes a sentence with parsed sentence data.
Method __getattr__ Gets an attribute of this sentence.
Method __repr__ Returns a textual representation of this sentence.
Instance Variable _sentenceData Undocumented
type = (source)
The sentence type ("GPGGA", "GPGSV"...).
numberOfGSVSentences = (source)
The total number of GSV sentences in a sequence.
GSVSentenceIndex = (source)
The index of this GSV sentence in the GSV sequence.
timestamp = (source)
A timestamp. ("123456" -> 12:34:56Z)
datestamp = (source)
A datestamp. ("230394" -> 23 Mar 1994)
latitudeFloat = (source)
Latitude value. (for example: "1234.567" -> 12 degrees, 34.567 minutes).
latitudeHemisphere = (source)
Latitudinal hemisphere ("N" or "S").
longitudeFloat = (source)
Longitude value. See latitudeFloat for an example.
longitudeHemisphere = (source)
Longitudinal hemisphere ("E" or "W").
altitude = (source)
The altitude above mean sea level.
altitudeUnits = (source)
Units in which altitude is expressed. (Always "M" for meters.)
heightOfGeoidAboveWGS84 = (source)
The local height of the geoid above the WGS84 ellipsoid model.
heightOfGeoidAboveWGS84Units = (source)
The units in which the height above the geoid is expressed. (Always "M" for meters.)
trueHeading = (source)
The true heading.
magneticVariation = (source)
The magnetic variation.
magneticVariationDirection = (source)
The direction of the magnetic variation. One of "E" or "W".
speedInKnots = (source)
The ground speed, expressed in knots.
fixQuality = (source)
The quality of the fix.
(type: One of GPGGAFixQualities.)
dataMode = (source)
Signals if the data is usable or not.
(type: One of GPGLLGPRMCFixQualities.)
numberOfSatellitesSeen = (source)
The number of satellites seen by the receiver.
numberOfSatellitesUsed = (source)
The number of satellites used in computing the fix.
horizontalDilutionOfPrecision = (source)
The dilution of the precision of the position on a plane tangential to the geoid. (HDOP)
verticalDilutionOfPrecision = (source)
As horizontalDilutionOfPrecision, but for a position on a plane perpendicular to the geoid. (VDOP)
positionDilutionOfPrecision = (source)
Euclidean norm of HDOP and VDOP.
satellitePRN = (source)
The unique identifcation number of a particular satellite. Optionally suffixed with _N if multiple satellites are referenced in a sentence, where N in range(4).
elevation = (source)
The elevation of a satellite in decimal degrees. Optionally suffixed with _N, as with satellitePRN.
azimuth = (source)
The azimuth of a satellite in decimal degrees. Optionally suffixed with _N, as with satellitePRN.
signalToNoiseRatio = (source)
The SNR of a satellite signal, in decibels. Optionally suffixed with _N, as with satellitePRN.
usedSatellitePRN_N = (source)
Where int(N) in range(12). The PRN of a satellite used in computing the fix.
ALLOWED_ATTRIBUTES = (source)
overrides twisted.positioning._sentence._BaseSentence.ALLOWED_ATTRIBUTES

Undocumented

def _isFirstGSVSentence(self): (source)

Tests if this current GSV sentence is the first one in a sequence.

ReturnsTrue if this is the first GSV sentence. (type: bool)
def _isLastGSVSentence(self): (source)

Tests if this current GSV sentence is the final one in a sequence.

ReturnsTrue if this is the last GSV sentence. (type: bool)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.