twisted.internet.serialport.SerialPort

class documentation

class SerialPort(BaseSerialPort, abstract.FileDescriptor): (source)

View In Hierarchy

A serial device, acting as a transport, that uses a win32 event.
Method __init__
Method connection​Lost Called when the serial port disconnects.
Method serial​Read​Event Undocumented
Method serial​Write​Event Undocumented
Method write Reliably write some data.
Class Variable connected Undocumented
Instance Variable closed Undocumented
Instance Variable closed​Notifies Undocumented
Instance Variable out​Queue Undocumented
Instance Variable protocol Undocumented
Instance Variable reactor Undocumented
Instance Variable read​_buf Undocumented
Instance Variable write​In​Progress Undocumented
Method _clear​Comm​Error Undocumented
Method _finish​Port​Setup Finish setting up the serial port.
Instance Variable _overlapped​Read Undocumented
Instance Variable _overlapped​Write Undocumented
Instance Variable _serial Undocumented

Inherited from BaseSerialPort:

Method flush​Input Undocumented
Method flush​Output Undocumented
Method get​CD Undocumented
Method get​CTS Undocumented
Method get​DSR Undocumented
Method get​RI Undocumented
Method in​Waiting Undocumented
Method send​Break Undocumented
Method set​Baud​Rate Undocumented
Method set​DTR Undocumented
Method set​RTS Undocumented
Instance Variable _serial​Factory a pyserial serial.Serial factory, used to create the instance stored in self._serial. Overrideable to enable easier testing.

Inherited from FileDescriptor:

Method do​Read Called when data is available for reading.
Method do​Write Called when data can be written.
Method fileno File Descriptor number for select().
Method get​Host Similar to getPeer, but returns an address describing this side of the connection.
Method get​Peer Get the remote address of this connection.
Method lose​Connection Close the connection at the next available opportunity.
Method lose​Write​Connection Undocumented
Method pause​Producing Pause producing data.
Method read​Connection​Lost Indicates read connection was lost.
Method resume​Producing Resume producing data.
Method start​Reading Start waiting for read availability.
Method start​Writing Start waiting for write availability.
Method stop​Consuming Stop consuming data.
Method stop​Producing Stop producing data.
Method stop​Reading Stop waiting for read availability.
Method stop​Writing Stop waiting for write availability.
Method write​Connection​Lost Indicates write connection was lost.
Method write​Sequence Reliably write a sequence of data.
Method write​Some​Data Write as much as possible of the given data, immediately.
Constant SEND​_LIMIT Undocumented
Class Variable buffer​Size Undocumented
Class Variable disconnecting Undocumented
Instance Variable data​Buffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producer​Paused Undocumented
Method _close​Write​Connection Undocumented
Method _is​Send​Buffer​Full Determine whether the user-space send buffer for this transport is full or not.
Method _maybe​Pause​Producer Possibly pause a producer, if there is one and the send buffer is full.
Method _post​Lose​Connection Called after a loseConnection(), when all data has been written.
Class Variable _write​Disconnected Undocumented
Instance Variable _temp​Data​Buffer Undocumented
Instance Variable _temp​Data​Len Undocumented
Instance Variable _write​Disconnecting Undocumented

Inherited from _ConsumerMixin (via FileDescriptor):

Method register​Producer Register to receive data from a producer.
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Instance Variable streaming​Producer bool or int

Inherited from _LogOwner (via FileDescriptor):

Method log​Prefix Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method _get​Log​Prefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.
def __init__(self, protocol, deviceNameOrPortNumber, reactor, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, xonxoff=0, rtscts=0): (source)
overrides twisted.internet.abstract.FileDescriptor.__init__
Parameters
protocolUndocumented
device​Name​Or​Port​NumberUndocumented
reactorAn IReactorFDSet provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used.
baudrateUndocumented
bytesizeUndocumented
parityUndocumented
stopbitsUndocumented
xonxoffUndocumented
rtsctsUndocumented
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.abstract.FileDescriptor.connectionLost

Called when the serial port disconnects.

Will call connectionLost on the protocol that is handling the serial data.

def serialReadEvent(self): (source)

Undocumented

def serialWriteEvent(self): (source)

Undocumented

def write(self, data): (source)
from twisted.internet.interfaces.IConsumer
overrides twisted.internet.abstract.FileDescriptor.write

Reliably write some data.

The data is buffered until the underlying file descriptor is ready for writing. If there is more than self.bufferSize data in the buffer and this descriptor has a registered streaming producer, its pauseProducing() method will be called.

connected: int = (source)
overrides twisted.internet.abstract.FileDescriptor.connected

Undocumented

closed: int = (source)

Undocumented

closedNotifies: int = (source)

Undocumented

outQueue: list = (source)

Undocumented

protocol = (source)

Undocumented

reactor = (source)
overrides twisted.internet.abstract.FileDescriptor.reactor

Undocumented

read_buf = (source)

Undocumented

writeInProgress: int = (source)

Undocumented

def _clearCommError(self): (source)

Undocumented

def _finishPortSetup(self): (source)

Finish setting up the serial port.

This is a separate method to facilitate testing.

_overlappedRead = (source)

Undocumented

_overlappedWrite = (source)

Undocumented

_serial = (source)
overrides twisted.internet.serialport.BaseSerialPort._serial

Undocumented