File: //usr/lib/python3/dist-packages/twisted/positioning/test/__pycache__/test_nmea.cpython-38.pyc
U
W[�� � @ sN d Z ddlmZmZ ddlZddlmZ ddlmZ ddl m
Z
m Z ddl m
Z
mZmZ ddlmZ dd lmZ dd
lmZ d Zd Zd
ZdZdZdZdZ dZ d� � Z \Z Z!Z"eej#�G dd� de$��Z%G dd� de�Z&G dd� de�Z'G dd� de�Z(G d d � d e�Z)G d d � d e$�Z*G d d!� d!e*e�Z+G d"d#� d#e*e�Z,G d$d%� d%e*e�Z-G d&d'� d'e*e�Z.G d(d)� d)e�Z/G d*d+� d+e$�Z0G d,d-� d-e0e�Z1G d.d/� d/e0e�Z2d0d1� Z3d2d3� Z4d4d5� Z5G d6d7� d7e0e�Z6G d8d9� d9e0e�Z7G d:d;� d;e0e�Z8G d<d=� d=e0e�Z9G d>d?� d?e0e�Z:G d@dA� dAe0e�Z;G dBdC� dCe0e�Z<G dDdE� dEe�Z=dS )Fz&
Test cases for using NMEA sentences.
� )�absolute_import�divisionN)�
attrgetter)� implementer)� iteritems�
intToBytes)�base�nmea� ipositioning)�MockPositioningReceiver)�TestCase)�AnglessA $GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47sD $GPRMC,123519,A,4807.038,N,01131.000,E,022.4,084.4,230394,003.1,W*6As5 $GPGSA,A,3,19,28,14,18,27,22,31,39,,,,,1.7,1.0,1.3*34s $GPHDT,038.005,T*3Bs' $GPGLL,4916.45,N,12311.12,W,225444,A*31s $GPGLL,3751.65,S,14507.36,E*77s; $GPGSV,1,1,11,03,03,111,00,04,15,270,00,06,01,010,00,,,,*4bs2 $GPGSV,1,1,11,03,03,111,00,,,,,,,,,13,06,292,00*75s�
$GPGSV,3,1,11,03,03,111,00,04,15,270,00,06,01,010,00,13,06,292,00*74
$GPGSV,3,2,11,14,25,170,00,16,57,208,39,18,67,296,40,19,40,246,00*74
$GPGSV,3,3,11,22,42,067,42,24,14,311,43,27,05,244,00,,,,*4D
c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �NMEATestReceiverzY
An NMEA receiver for testing.
Remembers the last sentence it has received.
c C s | � � d S �N)�clear��self� r �D/usr/lib/python3/dist-packages/twisted/positioning/test/test_nmea.py�__init__- s zNMEATestReceiver.__init__c C s
d| _ dS )zq
Forgets the received sentence (if any), by setting
C{self.receivedSentence} to L{None}.
N��receivedSentencer r r r r 1 s zNMEATestReceiver.clearc C s
|| _ d S r r �r �sentencer r r �sentenceReceived9 s z!NMEATestReceiver.sentenceReceivedN)�__name__�
__module__� __qualname__�__doc__r r r r r r r r & s r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
CallbackTestsaO
Tests if the NMEA protocol correctly calls its sentence callback.
@ivar protocol: The NMEA protocol under test.
@type protocol: L{nmea.NMEAProtocol}
@ivar sentenceTypes: The set of sentence types of all sentences the test's
sentence callback function has been called with.
@type sentenceTypes: C{set}
c C s" t � }t�|| j�| _t� | _d S r )r r � NMEAProtocol�_sentenceCallback�protocol�set�
sentenceTypes�r �receiverr r r �setUpH s zCallbackTests.setUpc C s | j �|j� dS )zC
Remembers that a sentence of this type was fired.
N)r$ �add�typer r r r r! N s z CallbackTests._sentenceCallbackc C sh dgdgdgdgdgdgd�}t |�D ]<\}}|D ].}| j�|� | �| jt|g�� | j�� q2q&dS ) zI
The correct callbacks fire, and that *only* those fire.
� $GPGGA*56s $GPGLL*50s $GPGSA*42s $GPGSV*55s $GPHDT*4fs $GPRMC*4b)�GPGGA�GPGLL�GPGSA�GPGSV�GPHDT�GPRMCN)r r" � lineReceived� assertEqualr$ r# r )r ZsentencesByTypeZ sentenceType� sentencesr r r r �test_callbacksCalledU s � z"CallbackTests.test_callbacksCalledN)r r r r r' r! r4 r r r r r > s r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �BrokenSentenceCallbackTestsz3
Tests for broken NMEA sentence callbacks.
c C s t � }t�|| j�| _d S r )r r r r! r" r% r r r r' n s z!BrokenSentenceCallbackTests.setUpc C s t d��dS )z+
Raises C{AttributeError}.
zERROR!!!N)�AttributeErrorr r r r r! s s z-BrokenSentenceCallbackTests._sentenceCallbackc C s | j j}| �t|d� dS )zt
An C{AttributeError} in the sentence callback of an C{NMEAProtocol}
doesn't get swallowed.
r* N)r" r1 � assertRaisesr6 )r r1 r r r �"test_dontSwallowCallbackExceptionsz s z>BrokenSentenceCallbackTests.test_dontSwallowCallbackExceptionsN)r r r r r' r! r8 r r r r r5 j s r5 c @ s e Zd ZdZdd� Zdd� ZdS )�
SplitTestsz-
Checks splitting of NMEA sentences.
c C s t �d�}| �|dddg� dS )zH
An NMEA sentence with a checksum gets split correctly.
s $GPGGA,spam,eggs*00� GPGGA� spam� eggsN�r Z_splitr2 �r Z
splitSentencer r r �test_withChecksum� s
z SplitTests.test_withChecksumc C s t �d�}| �|dddg� dS )zK
An NMEA sentence without a checksum gets split correctly.
s $GPGGA,spam,eggs*r: r; r< Nr= r> r r r �test_noCheckum� s
zSplitTests.test_noCheckumN)r r r r r? r@ r r r r r9 � s r9 c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
ChecksumTestsz4
NMEA sentence checksum verification tests.
c C s t �t� dS )z?
Sentences with valid checksums get validated.
N�r �_validateChecksumr+ r r r r �
test_valid� s zChecksumTests.test_validc C s t �tdd� � dS )zA
Sentences with missing checksums get validated.
N���rB r r r r � test_missing� s zChecksumTests.test_missingc C sR t j}t�d�\}}tt|d�d �}|d | g}|D ]}| �tj||� q8dS )zw
Sentences with a bad checksum raise L{base.InvalidChecksum} when
attempting to validate them.
� *� � N) r rC r+ �splitr �intr7 r ZInvalidChecksum)r ZvalidateZ bareSentenceZchecksumZ badChecksumr3 �sr r r � test_invalid� s zChecksumTests.test_invalidN)r r r r rD rF rM r r r r rA � s rA c @ s e Zd ZdZdd� ZdS )�NMEAReceiverSetupaG
A mixin for tests that need an NMEA receiver (and a protocol attached to
it).
@ivar receiver: An NMEA receiver that remembers the last sentence.
@type receiver: L{NMEATestReceiver}
@ivar protocol: An NMEA protocol attached to the receiver.
@type protocol: L{twisted.positioning.nmea.NMEAProtocol}
c C s t � | _t�| j�| _dS )z+
Sets up an NMEA receiver.
N)r r& r r r" r r r r r' � s zNMEAReceiverSetup.setUpN)r r r r r' r r r r rN � s rN c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �GSVSequenceTestsz8
Tests for the interpretation of GSV sequences.
c C s4 | j �t� | jj}| �|�� � | �|�� � dS )zO
The first sentence in a GSV sequence is correctly identified.
N) r" r1 � GPGSV_FIRSTr& r �
assertTrue�_isFirstGSVSentence� assertFalse�_isLastGSVSentencer r r r �test_firstSentence� s z#GSVSequenceTests.test_firstSentencec C s4 | j �t� | jj}| �|�� � | �|�� � dS )z�
A sentence in the middle of a GSV sequence is correctly
identified (as being neither the last nor the first).
N)r" r1 � GPGSV_MIDDLEr& r rS rR rT r r r r �test_middleSentence� s z$GSVSequenceTests.test_middleSentencec C s4 | j �t� | jj}| �|�� � | �|�� � dS )zN
The last sentence in a GSV sequence is correctly identified.
N) r" r1 �
GPGSV_LASTr& r rS rR rQ rT r r r r �test_lastSentence� s z"GSVSequenceTests.test_lastSentenceN)r r r r rU rW rY r r r r rO � s rO c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �BogusSentenceTestszK
Tests for verifying predictable failure for bogus NMEA sentences.
c C s | � || jj|� dS )a=
Asserts that the protocol raises C{exceptionClass} when it receives
C{sentence}.
@param exceptionClass: The exception class expected to be raised.
@type exceptionClass: C{Exception} subclass
@param sentence: The (bogus) NMEA sentence.
@type sentence: C{str}
N)r7 r" r1 )r �exceptionClassr r r r �assertRaisesOnSentence� s z)BogusSentenceTests.assertRaisesOnSentencec C s | � td� dS )z`
Receiving a well-formed sentence of unknown type raises
C{ValueError}.
s $GPBOGUS*5bN)r\ �
ValueErrorr r r r � test_raiseOnUnknownSentenceType s z2BogusSentenceTests.test_raiseOnUnknownSentenceTypec C s | � tjd� dS )zP
Receiving a malformed sentence raises L{base.InvalidSentence}.
ZGPBOGUSN)r\ r ZInvalidSentencer r r r � test_raiseOnMalformedSentences s z1BogusSentenceTests.test_raiseOnMalformedSentencesN)r r r r r\ r^ r_ r r r r rZ � s rZ c @ s e Zd ZdZdd� ZdS )�NMEASentenceTestsz1
Tests for L{nmea.NMEASentence} objects.
c C s@ t dfg}|D ],\}}| j�|� | jj}| �t|�|� qdS )zI
The C{repr} of L{nmea.NMEASentence} objects is correct.
aX <NMEASentence (GPGSA) {dataMode: A, fixType: 3, horizontalDilutionOfPrecision: 1.0, positionDilutionOfPrecision: 1.7, usedSatellitePRN_0: 19, usedSatellitePRN_1: 28, usedSatellitePRN_2: 14, usedSatellitePRN_3: 18, usedSatellitePRN_4: 27, usedSatellitePRN_5: 22, usedSatellitePRN_6: 31, usedSatellitePRN_7: 39, verticalDilutionOfPrecision: 1.3}>N)r- r" r1 r& r r2 �repr)r ZsentencesWithExpectedReprr Z expectedRepr�receivedr r r � test_repr s �� zNMEASentenceTests.test_reprN)r r r r rc r r r r r` s r` c @ sX e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dS )� ParsingTestsz�
Tests if raw NMEA sentences get parsed correctly.
This doesn't really involve any interpretation, just turning ugly raw NMEA
representations into objects that are more pleasant to work with.
c C s& | j �|� | jj}| �||j� dS )z�
Passes a sentence to the protocol and gets the parsed sentence from
the receiver. Then verifies that the parsed sentence contains the
expected data.
N)r" r1 r& r r2 �
_sentenceData)r r �expectedrb r r r � _parserTest@ s zParsingTests._parserTestc
C s. ddddddddd d
d d d
� }| � t|� dS )z:
A full RMC sentence is correctly parsed.
r0 �4807.038�N� 01131.000�Ez003.1�Wz022.4�123519Z230394z084.4�A) r) �
latitudeFloat�latitudeHemisphere�longitudeFloat�longitudeHemisphere�magneticVariation�magneticVariationDirection� speedInKnots� timestamp� datestamp� trueHeading�dataModeN)rg r0 �r rf r r r � test_fullRMCK s �zParsingTests.test_fullRMCc C s0 dddddddddd d
d d d
�
}| � t|� dS )z:
A full GGA sentence is correctly parsed.
r+ �545.4�M�46.9z0.9rh ri rj rk Z08rm �1)
r) �altitudeZ
altitudeUnits�heightOfGeoidAboveWGS84Z heightOfGeoidAboveWGS84Units� horizontalDilutionOfPrecisionro rp rq rr �numberOfSatellitesSeenrv �
fixQualityN)rg r+ rz r r r � test_fullGGA` s �zParsingTests.test_fullGGAc C s$ dddddddd�}| � t|� d S )
z:
A full GLL sentence is correctly parsed.
r, z4916.45ri z12311.12rl Z225444rn )r) ro rp rq rr rv ry N)rg r, rz r r r � test_fullGLLz s � zParsingTests.test_fullGLLc C s dddddd�}| � t|� dS )z=
A partial GLL sentence is correctly parsed.
r, z3751.65�Sz14507.36rk )r) ro rp rq rr N)rg �
GPGLL_PARTIALrz r r r �test_partialGLL� s �z ParsingTests.test_partialGLLc C s> ddddddddd d
d d d d
d dddddd�}| � t|� dS )z:
A full GSV sentence is correctly parsed.
r. r �3�11Z111Z270Z010Z292Z03Z15Z01Z06Z04Z13�00)r) �GSVSentenceIndex�numberOfGSVSentencesr� � azimuth_0� azimuth_1� azimuth_2Z azimuth_3� elevation_0� elevation_1� elevation_2Z elevation_3�satellitePRN_0�satellitePRN_1�satellitePRN_2ZsatellitePRN_3�signalToNoiseRatio_0�signalToNoiseRatio_1�signalToNoiseRatio_2ZsignalToNoiseRatio_3N)rg rP rz r r r � test_fullGSV� s, �zParsingTests.test_fullGSVc C s6 dddddddddd d
d d dd
dd�}| � t|� dS )z=
A partial GSV sentence is correctly parsed.
r. r� r� Z067Z311Z244Z42�14Z05�22Z24�27Z43r� )r) r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� N)rg rX rz r r r �test_partialGSV� s$ �z ParsingTests.test_partialGSVc C s ddd�}| � t|� dS )z:
A full HDT sentence is correctly parsed.
r/ z038.005)r) rx N)rg r/ rz r r r � test_fullHDT� s �zParsingTests.test_fullHDTc C s2 ddddddddd d
d d d
dd�}| � t|� dS )z=
A typical GSA sentence is correctly parsed.
r- rn r� Z19Z28r� Z18r� r� Z31Z39z1.7z1.0z1.3)r) ry �fixTypeZusedSatellitePRN_0ZusedSatellitePRN_1ZusedSatellitePRN_2ZusedSatellitePRN_3ZusedSatellitePRN_4ZusedSatellitePRN_5ZusedSatellitePRN_6ZusedSatellitePRN_7�positionDilutionOfPrecisionr� �verticalDilutionOfPrecisionN)rg r- rz r r r �test_typicalGSA� s �z ParsingTests.test_typicalGSAN)
r r r r rg r{ r� r� r� r� r� r� r� r r r r rd 9 s ! rd c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �
FixUnitsTestsz�
Tests for the generic unit fixing method, L{nmea.NMEAAdapter._fixUnits}.
@ivar adapter: The NMEA adapter.
@type adapter: L{nmea.NMEAAdapter}
c C s t �t�� �| _d S r �r � NMEAAdapterr ZBasePositioningReceiver�adapterr r r r r' s zFixUnitsTests.setUpc C sB G dd� dt �}|� | j_| jjddd� | �| jjd d� dS ) zv
Tests that when no C{valueKey} is provided, C{unitKey} is used, minus
C{"Units"} at the end.
c @ s e Zd ZdZdd� ZdS )z3FixUnitsTests.test_noValueKey.<locals>.FakeSentencezJ
A fake sentence that just has a "foo" attribute.
c S s
d| _ d S )NrI )�foor r r r r s z<FixUnitsTests.test_noValueKey.<locals>.FakeSentence.__init__N�r r r r r r r r r � FakeSentence s r� �fooUnitsri )�unitKey�unitr� rI N��objectr� ZcurrentSentence� _fixUnits�assertNotEqualre �r r� r r r �test_noValueKey
s
z FixUnitsTests.test_noValueKeyc C s@ G dd� dt �}|� | j_| jjdd� | �| jjd d� dS )z�
Tests that if a unit key is provided but the unit isn't, the unit is
automatically determined from the unit key.
c @ s e Zd ZdZdd� ZdS )z9FixUnitsTests.test_unitKeyButNoUnit.<locals>.FakeSentencezX
A fake sentence that just has "foo" and "fooUnits" attributes.
c S s d| _ d| _d S )NrI ri )r� r� r r r r r $ s zBFixUnitsTests.test_unitKeyButNoUnit.<locals>.FakeSentence.__init__Nr� r r r r r� s r� r� )r� r� rI Nr� r� r r r �test_unitKeyButNoUnit s
z#FixUnitsTests.test_unitKeyButNoUnitc C s | j t| jjdd� dS )z�
Tests that when a unit is specified but neither C{valueKey} nor
C{unitKey} is provided, C{ValueError} is raised.
�K)r� N)r7 r] r� r� r r r r �test_noValueKeyAndNoUnitKey- s z)FixUnitsTests.test_noValueKeyAndNoUnitKeyN)r r r r r' r� r� r� r r r r r� � s
r� c @ s" e Zd ZdZdd� Zddd�ZdS )�FixerTestMixinz�
Mixin for tests for the fixers on L{nmea.NMEAAdapter} that adapt
from NMEA-specific notations to generic Python objects.
@ivar adapter: The NMEA adapter.
@type adapter: L{nmea.NMEAAdapter}
c C s t �t�� �| _d S r r� r r r r r' > s zFixerTestMixin.setUpNc sR t �|��� �fdd�}|dkr8|� � �� jj|� n � �||� � j�� dS )a�
A generic adapter fixer test.
Creates a sentence from the C{sentenceData} and sends that to the
adapter. If C{exceptionClass} is not passed, this is assumed to work,
and C{expected} is compared with the adapter's internal state.
Otherwise, passing the sentence to the adapter is checked to raise
C{exceptionClass}.
@param sentenceData: Raw sentence content.
@type sentenceData: C{dict} mapping C{str} to C{str}
@param expected: The expected state of the adapter.
@type expected: C{dict} or L{None}
@param exceptionClass: The exception to be raised by the adapter.
@type exceptionClass: subclass of C{Exception}
c s � j ��� d S r )r� r r r r r �receiveSentenceV s z2FixerTestMixin._fixerTest.<locals>.receiveSentenceN)r Z NMEASentencer2 r� �_stater7 r )r � sentenceDatarf r[ r� r r r �
_fixerTestB s
zFixerTestMixin._fixerTest)NN)r r r r r' r� r r r r r� 6 s r� c @ s e Zd ZdZdd� Zdd� ZdS )�TimestampFixerTestszL
Tests conversion from NMEA timestamps to C{datetime.time} objects.
c C s* ddi}dt �ddd�i}| �||� dS )z<
A simple timestamp is converted correctly.
rv Z123456Z_time� �" �8 N)�datetime�timer� )r �datarf r r r � test_simpleg s z TimestampFixerTests.test_simplec C s$ d}|D ]}| j d|itd� qdS )z:
A broken timestamp raises C{ValueError}.
)Z993456Z129956Z123499rv �r[ N�r� r] )r Z
badTimestamps�tr r r � test_brokenp s z TimestampFixerTests.test_brokenN)r r r r r� r� r r r r r� c s r� c @ s4 e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd S ) �DatestampFixerTestsc C s | � | jjd� dS )z5
The default year threshold is 1980.
i� N)r2 r� Z
yearThresholdr r r r �test_defaultYearThreshold| s z-DatestampFixerTests.test_defaultYearThresholdc C s, dt �ddd� }}| �d|id|i� dS )z�
Dates before the threshold are interpreted as being in the century
after the threshold. (Since the threshold is the earliest possible
date.)
Z010115i� rI rw �_dateN�r� �dater� �r Z
datestringr� r r r �test_beforeThreshold� s z(DatestampFixerTests.test_beforeThresholdc C s, dt �ddd� }}| �d|id|i� dS )zr
Dates after the threshold are interpreted as being in the same century
as the threshold.
Z010195i� rI rw r� Nr� r� r r r �test_afterThreshold� s z'DatestampFixerTests.test_afterThresholdc C s | j dditd� dS )zQ
A datestring with an invalid month (> 12) raises C{ValueError}.
rw Z011301r� Nr� r r r r �test_invalidMonth� s z%DatestampFixerTests.test_invalidMonthc C s( | j dditd� | j dditd� dS )zy
A datestring with an invalid day (more days than there are in that
month) raises C{ValueError}.
rw Z320101r� Z300201Nr� r r r r �test_invalidDay� s z#DatestampFixerTests.test_invalidDayN)r r r r� r� r� r� r� r r r r r� { s
r� c C s d| |f S )a^
Builds an NMEA float representation for a given angle in degrees and
decimal minutes.
@param degrees: The integer degrees for this angle.
@type degrees: C{int}
@param minutes: The decimal minutes value for this angle.
@type minutes: C{float}
@return: The NMEA float representation for this angle.
@rtype: C{str}
z%i%0.3fr )ZdegreesZminutesr r r �
_nmeaFloat� s r� c C s | dkr dS dS )a8
Return the sign of a coordinate.
This is C{1} if the coordinate is in the northern or eastern hemispheres,
C{-1} otherwise.
@param hemisphere: NMEA shorthand for the hemisphere. One of "NESW".
@type hemisphere: C{str}
@return: The sign of the coordinate value.
@rtype: C{int}
ZNErI ���r �Z
hemispherer r r �_coordinateSign� s
r� c C s | dkrt jS t jS )ao
Return the type of a coordinate.
This is L{Angles.LATITUDE} if the coordinate is in the northern or
southern hemispheres, L{Angles.LONGITUDE} otherwise.
@param hemisphere: NMEA shorthand for the hemisphere. One of "NESW".
@type hemisphere: C{str}
@return: The type of the coordinate (L{Angles.LATITUDE} or
L{Angles.LONGITUDE})
ZNS)r
�LATITUDE� LONGITUDEr� r r r �_coordinateType� s
r� c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dS )�CoordinateFixerTestszO
Tests turning NMEA coordinate notations into something more pleasant.
c C s, ddd�}dt �dtj�i}| �||� dS )zg
NMEA coordinate representations in the northern hemisphere
convert correctly.
�1030.000ri �ro rp �latitude� %@N�r �
Coordinater
r� r� �r r� �stater r r �
test_north� s
z CoordinateFixerTests.test_northc C s, ddd�}dt �dtj�i}| �||� dS )zg
NMEA coordinate representations in the southern hemisphere
convert correctly.
r� r� r� r� � %�Nr� r� r r r �
test_south� s
z CoordinateFixerTests.test_southc C s, ddd�}dt �dtj�i}| �||� dS )zf
NMEA coordinate representations in the eastern hemisphere
convert correctly.
r� rk �rq rr � longituder� N�r r� r
r� r� r� r r r � test_east� s
z CoordinateFixerTests.test_eastc C s, ddd�}dt �dtj�i}| �||� dS )zf
NMEA coordinate representations in the western hemisphere
convert correctly.
r� rl r� r� r� Nr� r� r r r � test_west� s
z CoordinateFixerTests.test_westc C s ddi}| j |td� dS )z�
NMEA coordinate representations for nonexistent hemispheres
raise C{ValueError} when you attempt to parse them.
rr �Qr� Nr� �r r� r r r �test_badHemisphere s z'CoordinateFixerTests.test_badHemispherec s � fdd�}� � t|� dS )z�
NMEA coordinate repesentation parsing fails predictably
when you pass nonexistent coordinate types (not latitude or
longitude).
c s � j �d�S )NZ BOGUS_VALUE)r� Z_getHemisphereSignr r r r �<lambda> � z=CoordinateFixerTests.test_badHemisphereSign.<locals>.<lambda>N)r7 r] )r ZgetSignr r r �test_badHemisphereSign s z+CoordinateFixerTests.test_badHemisphereSignN)
r r r r r� r� r� r� r� r� r r r r r� � s
r� c @ s e Zd ZdZdd� Zdd� ZdS )�AltitudeFixerTestszO
Tests that NMEA representations of altitudes are correctly converted.
c C s. d\}}t �t|��}| �||i||i� dS )zo
The NMEA representation of an altitude (above mean sea level)
is correctly converted.
)r� r| N�r �Altitude�floatr� �r �key�valuer� r r r �test_fixAltitude s z#AltitudeFixerTests.test_fixAltitudec C s. d\}}t �t|��}| �||i||i� dS )z�
The NMEA representation of an altitude of the geoid (above the
WGS84 reference level) is correctly converted.
)r� r~ Nr� r� r r r � test_heightOfGeoidAboveWGS84% s z/AltitudeFixerTests.test_heightOfGeoidAboveWGS84N)r r r r r� r� r r r r r� s
r� c @ s e Zd ZdZdd� ZdS )�SpeedFixerTestszL
Tests that NMEA representations of speeds are correctly converted.
c C s6 d\}}}t �t|�t j �}| �||i||i� dS )z`
Speeds reported in knots correctly get converted to meters per
second.
)ru Z10�speedN)r ZSpeedr� Z MPS_PER_KNOTr� )r r� r� Z targetKeyr� r r r �test_speedInKnots4 s
z!SpeedFixerTests.test_speedInKnotsN)r r r r r� r r r r r� 0 s r� c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �VariationFixerTestsz�
Tests if the absolute values of magnetic variations on the heading
and their sign get combined correctly, and if that value gets
combined with a heading correctly.
c C s< d\}}t jjdt|� d�}||d�}| �|d|i� dS )z?
Tests westward (negative) magnetic variation.
)�1.34rl r� �ZvariationValue�rs rt �headingN�r ZHeadingZ
fromFloatsr� r� �r � variation� directionr r� r r r r� E s �z VariationFixerTests.test_westc C s8 d\}}t jjt|�d�}||d�}| �|d|i� dS )z?
Tests eastward (positive) magnetic variation.
)r� rk r� r r Nr r r r r r� Q s �z VariationFixerTests.test_eastc C sB d\}}}|||d�}t jjt|�t|�d�}| �|d|i� dS )zH
Variation values get combined with headings correctly.
)z123.12r� rk )rx rs rt r� r Nr )r rx r r r� r r r r �test_withHeading] s
� �z$VariationFixerTests.test_withHeadingN)r r r r r� r� r r r r r r� ? s r� c @ s e Zd ZdZdd� Zdd� ZdS )�PositionErrorFixerTestsa�
Position errors in NMEA are passed as dilutions of precision (DOP). This
is a measure relative to some specified value of the GPS device as its
"reference" precision. Unfortunately, there are very few ways of figuring
this out from just the device (sans manual).
There are two basic DOP values: vertical and horizontal. HDOP tells you
how precise your location is on the face of the earth (pretending it's
flat, at least locally). VDOP tells you how precise your altitude is
known. PDOP (position DOP) is a dependent value defined as the Euclidean
norm of those two, and gives you a more generic "goodness of fix" value.
c C s | � ddidtjdd�i� d S )Nr� r� �
positionErrorg &@)�hdop)r� r �
PositionErrorr r r r r� x s �z#PositionErrorFixerTests.test_simplec C sF d\}}}t jt|�t|�t|�d�}|||d�}| �|d|i� d S )N)r r r )�pdopr �vdop)r� r� r� r )r r
r� r� )r r r r r r� r r r � test_mixing~ s
��z#PositionErrorFixerTests.test_mixingN)r r r r r� r
r r r r r k s r c @ s e Zd ZdZdd� Zdd� ZdS )�
ValidFixTestsz<
Tests that data reported from a valid fix is used.
c C s. ddt jjd�}dt�d�i}| �||� dS )z4
GGA data with a valid fix is used.
r+ r| �r) r� r� r� �33333 �@N)r �GPGGAFixQualitiesZGPS_FIXr r� r� �r r� Z
expectedStater r r �test_GGA� s �zValidFixTests.test_GGAc C s. ddt jjd�}dt�d�i}| �||� dS )z:
GLL data with a valid data mode is used.
r, r| �r) r� ry r� r N)r �GPGLLGPRMCFixQualities�ACTIVEr r� r� r r r r �test_GLL� s �zValidFixTests.test_GLLN)r r r r r r r r r r r � s r c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dS )�InvalidFixTestsa:
Tests that data being reported from a bad or incomplete fix isn't
used. Although the specification dictates that GPSes shouldn't produce
NMEA sentences with real-looking values for altitude or position in them
unless they have at least some semblance of a GPS fix, this is widely
ignored.
c C s | � |i � dS )zu
Sentences with an invalid fix or data mode result in empty
state (ie, the data isn't used).
N)r� r� r r r �_invalidFixTest� s z InvalidFixTests._invalidFixTestc C s ddt jjd�}| �|� dS )zC
GGA sentence data is unused when there is no fix.
r+ r| r N)r r Z INVALID_FIXr r� r r r r � s
�zInvalidFixTests.test_GGAc C s ddt jjd�}| �|� dS )zO
GLL sentence data is unused when the data is flagged as void.
r, r| r N)r r �VOIDr r� r r r r � s
�zInvalidFixTests.test_GLLc C s$ ddt jjt jjd�}| �|� dS )z�
GSA sentence data is not used when there is no GPS fix, but
the data mode claims the data is "active". Some GPSes do
this, unfortunately, and that means you shouldn't use the
data.
r- r| �r) r� ry r� N)r r r �
GPGSAFixTypes�
GSA_NO_FIXr r� r r r �test_badGSADataMode� s �z#InvalidFixTests.test_badGSADataModec C s$ ddt jjt jjd�}| �|� dS )z�
GSA sentence data is not used when the fix claims to be valid
(albeit only 2D), but the data mode says the data is void.
Some GPSes do this, unfortunately, and that means you
shouldn't use the data.
r- r| r N)r r r r Z
GSA_2D_FIXr r� r r r �test_badGSAFixType� s �z"InvalidFixTests.test_badGSAFixTypec C s$ ddt jjt jjd�}| �|� dS )zj
GSA sentence data is not use when neither the fix nor the data
mode is any good.
r- r| r N)r r r r r r r� r r r � test_badGSADataModeAndFixType� s �z-InvalidFixTests.test_badGSADataModeAndFixTypeN)
r r r r r r r r r r r r r r r � s r c @ s� e Zd ZdZdd� Zdd� Zd$dd �Zd
d � Zd d
� Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� ZdS )%�NMEAReceiverTestsz&
Tests for the NMEA receiver.
c C s( t � | _t�| j�| _t�| j�| _d S r )r r& r r� r� r r" r r r r r' � s zNMEAReceiverTests.setUpc C s~ | j �t� tdddg�}| �t| jj�� �|� | j�� | � | j
j i � | j �t � tdg�}| �t| jj�� �|� dS )z�
If the current sentence does not contain any new fields for a
particular callback, that callback is not called; even if all
necessary information is still in the state from one or more
previous messages.
�positionReceived�positionErrorReceived�altitudeReceived�headingReceivedN)
r" r1 r+ r# r2 r& �called�keysr r� r� r� r/ )r ZgpggaCallbacksZgphdtCallbacksr r r �1test_onlyFireWhenCurrentSentenceHasNewInformation s �
zCNMEAReceiverTests.test_onlyFireWhenCurrentSentenceHasNewInformationr Nc C s\ |D ]}| j �|� q| jj�� }| �t|�t|�� |dk rD|� | j�� | j�� dS )a�
A generic test for NMEA receiver behavior.
@param sentences: The sequence of sentences to simulate receiving.
@type sentences: iterable of C{str}
@param expectedFired: The names of the callbacks expected to fire.
@type expectedFired: iterable of C{str}
@param extraTest: An optional extra test hook.
@type extraTest: nullary callable
N) r" r1 r& r& r' r2 r# r r� )r r3 Z
expectedFiredZ extraTestr Z
actuallyFiredr r r �
_receiverTest s
z NMEAReceiverTests._receiverTestc s: t gt }ddg}dd� � � �fdd�}��|||� dS )zJ
The positioning error is updated across multiple states.
r# �beaconInformationReceivedc S s t ttd�| ��S )N�
identifier)�sorted�mapr )Zbeaconsr r r �_getIdentifiers9 s zONMEAReceiverTests.test_positionErrorUpdateAcrossStates.<locals>._getIdentifiersc s` �j jd } � | j�}dddddddd d
d d g }��||� � | j�}��|ddd d
d g� d S )
N�beaconInformation� � � �
� rH � � � � � )r� r� � seenBeaconsr2 Z usedBeacons)r/ ZseenIdentifiersrf ZusedIdentifiers�r. r r r �checkBeaconInformation< s
zVNMEAReceiverTests.test_positionErrorUpdateAcrossStates.<locals>.checkBeaconInformationN)r- � GPGSV_SEQr) �r r3 �callbacksFiredr< r r; r �$test_positionErrorUpdateAcrossStates2 s
z6NMEAReceiverTests.test_positionErrorUpdateAcrossStatesc s* t g}dg}� fdd�}� �|||� dS )z�
A GSV sentence with empty entries in any position does not mean that
entries in subsequent positions of the same GSV sentence are ignored.
r* c s< � j jd } | j}� �t|�d� � �ddd� |D �� d S )Nr/ � r3 c S s g | ]
}|j �qS r )r+ )�.0�br r r �
<listcomp>Z s zYNMEAReceiverTests.test_emptyMiddleGSV.<locals>.checkBeaconInformation.<locals>.<listcomp>)r� r� r: r2 �lenZassertIn)r/ r: r r r r< U s zENMEAReceiverTests.test_emptyMiddleGSV.<locals>.checkBeaconInformationN��GPGSV_EMPTY_MIDDLEr) r> r r r �test_emptyMiddleGSVM s z%NMEAReceiverTests.test_emptyMiddleGSVc C s t g}dddg}| �||� dS )z�
A sequence of GGA sentences fires C{positionReceived},
C{positionErrorReceived} and C{altitudeReceived}.
r" r# r$ N)r+ r) �r r3 r? r r r �test_GGASentences_ s �z#NMEAReceiverTests.test_GGASentencesc C s8 t �ddd�| jjd< tg}ddddg}| �||� dS ) z�
When receiving a GPGGA sentence and a date was already in the
state, the new time (from the GPGGA sentence) is combined with
that date.
i� rI r� r" r# r$ � timeReceivedN)r� r� r� r� r+ r) rI r r r �test_GGAWithDateInStatel s �z)NMEAReceiverTests.test_GGAWithDateInStatec C s" t g}ddddg}| �||� dS )z�
A sequence of RMC sentences fires C{positionReceived},
C{speedReceived}, C{headingReceived} and C{timeReceived}.
r% �
speedReceivedr" rK N)r0 r) rI r r r �test_RMCSentences} s �z#NMEAReceiverTests.test_RMCSentencesc s. t ttg}dg}� fdd�}� �|||� dS )zb
A complete sequence of GSV sentences fires
C{beaconInformationReceived}.
r* c s � � d� jj� d S )NZ_partialBeaconInformation)Z assertNotInr� r� r r r r �checkPartialInformation� s zDNMEAReceiverTests.test_GSVSentences.<locals>.checkPartialInformationN)rP rV rX r) )r r3 r? rO r r r �test_GSVSentences� s
z#NMEAReceiverTests.test_GSVSentencesc C s t g}| �|dg� dS )z�
A complete sequence of GSV sentences with empty entries in the
middle still fires C{beaconInformationReceived}.
r* NrF �r r3 r r r �"test_emptyMiddleEntriesGSVSequence� s z4NMEAReceiverTests.test_emptyMiddleEntriesGSVSequencec C s t g}| �|� dS )zV
An incomplete sequence of GSV sentences does not fire any callbacks.
N)rP r) rQ r r r �test_incompleteGSVSequence� s z,NMEAReceiverTests.test_incompleteGSVSequencec C s t g}| �|dg� dS )z�
The parser does not fail badly when the sequence consists of
only one sentence (but is otherwise complete).
r* N)� GPGSV_SINGLEr) rQ r r r � test_singleSentenceGSVSequence� s z0NMEAReceiverTests.test_singleSentenceGSVSequencec C s t tg}| �|dg� dS )z9
GLL sentences fire C{positionReceived}.
r" N)r� r, r) rQ r r r �test_GLLSentences� s z#NMEAReceiverTests.test_GLLSentencesc C s t g}| �|dg� dS )z8
HDT sentences fire C{headingReceived}.
r% N)r/ r) rQ r r r �test_HDTSentences� s z#NMEAReceiverTests.test_HDTSentencesc s6 t tg}ddddddg}� fdd�}� �|||� d S )
zA
A mix of sentences fires the correct callbacks.
r$ rM r" r# rK r% c s, t � dddddd�} � �� jjd | � d S )Ni� r0 � r� �# r6 r� )r� r2 r� r� )ZexpectedDateTimer r r � checkTime� s z8NMEAReceiverTests.test_mixedSentences.<locals>.checkTimeN)r0 r+ r) )r r3 r? rZ r r r �test_mixedSentences� s � z%NMEAReceiverTests.test_mixedSentencesc C s6 t gt tttg }dddddddg}| �||� dS ) a#
Sends an entire gamut of sentences and verifies the
appropriate callbacks fire. These are more than you'd expect
from your average consumer GPS device. They have most of the
important information, including beacon information and
visibility.
r% r* rM r" rK r$ r# N)r- r= r0 r+ r, r) rI r r r �test_lotsOfMixedSentences� s �z+NMEAReceiverTests.test_lotsOfMixedSentences)r N)r r r r r' r( r) r@ rH rJ rL rN rP rR rS rU rV rW r[ r\ r r r r r! � s"
r! )>r Z
__future__r r r� �operatorr Zzope.interfacer Ztwisted.python.compatr r Ztwisted.positioningr r r
Z!twisted.positioning.test.receiverr Ztwisted.trial.unittestr Ztwisted.positioning.baser
r+ r0 r- r/ r, r� rT rG rJ r= rP rV rX Z
INMEAReceiverr� r r r5 r9 rA rN rO rZ r` rd r� r� r� r� r� r� r� r� r� r� r� r r r r! r r r r �<module> sZ ,"'"" G7-,@, Q