twisted.positioning.nmea.NMEAProtocol(LineReceiver, _sentence._PositioningSentenceProducerMixin) class documentation

Part of twisted.positioning.nmea (View In Hierarchy)

A protocol that parses and verifies the checksum of an NMEA sentence (in string form, not NMEASentence), and delegates to a receiver.

It receives lines and verifies these lines are NMEA sentences. If they are, verifies their checksum and unpacks them into their components. It then wraps them in NMEASentence objects and calls the appropriate receiver method with them.

Parameters_receiverA receiver for NMEAProtocol sentence objects. (type: INMEAReceiver)
_sentenceCallbackA function that will be called with a new NMEASentence when it is created. Useful for massaging data from particularly misbehaving NMEA receivers. (type: unary callable)
Method __init__ Initializes an NMEAProtocol.
Method lineReceived Parses the data from the sentence and validates the checksum.
Class Variable _SENTENCE_CONTENTS Has the field names in an NMEA sentence for each sentence type (in order, obviously). (type: dict of bytestrings to lists of str)

Inherited from LineReceiver:

Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Class Variable MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from Protocol (via LineReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from _PositioningSentenceProducerMixin:

Class Method getSentenceAttributes Returns a set of all attributes that might be found in the sentences produced by this protocol.
_SENTENCE_CONTENTS =
Has the field names in an NMEA sentence for each sentence type (in order, obviously). (type: dict of bytestrings to lists of str)
def __init__(self, receiver, sentenceCallback=None):

Initializes an NMEAProtocol.

ParametersreceiverA receiver for NMEAProtocol sentence objects. (type: INMEAReceiver)
sentenceCallbackA function that will be called with a new NMEASentence when it is created. Useful for massaging data from particularly misbehaving NMEA receivers. (type: unary callable)
def lineReceived(self, rawSentence):
overrides twisted.protocols.basic.LineReceiver.lineReceived

Parses the data from the sentence and validates the checksum.

ParametersrawSentenceThe NMEA positioning sentence. (type: bytes)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.