twisted.internet._posixserialport.SerialPort

class documentation

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

A select()able serial device, acting as a transport.

Method	`__init__`
Method	`connectionLost`	Called when the serial port disconnects.
Method	`doRead`	Some data's readable from serial device.
Method	`fileno`	File Descriptor number for select().
Method	`writeSomeData`	Write some data to the serial device.
Class Variable	`connected`	Undocumented
Instance Variable	`protocol`	Undocumented
Instance Variable	`reactor`	Undocumented
Instance Variable	`_serial`	Undocumented

Inherited from BaseSerialPort:

Method	`flushInput`	Undocumented
Method	`flushOutput`	Undocumented
Method	`getCD`	Undocumented
Method	`getCTS`	Undocumented
Method	`getDSR`	Undocumented
Method	`getRI`	Undocumented
Method	`inWaiting`	Undocumented
Method	`sendBreak`	Undocumented
Method	`setBaudRate`	Undocumented
Method	`setDTR`	Undocumented
Method	`setRTS`	Undocumented
Instance Variable	`_serialFactory`	a pyserial `serial.Serial` factory, used to create the instance stored in `self._serial`. Overrideable to enable easier testing.

Inherited from FileDescriptor:

Method	`doWrite`	Called when data can be written.
Method	`getHost`	Similar to getPeer, but returns an address describing this side of the connection.
Method	`getPeer`	Get the remote address of this connection.
Method	`loseConnection`	Close the connection at the next available opportunity.
Method	`loseWriteConnection`	Undocumented
Method	`pauseProducing`	Pause producing data.
Method	`readConnectionLost`	Indicates read connection was lost.
Method	`resumeProducing`	Resume producing data.
Method	`startReading`	Start waiting for read availability.
Method	`startWriting`	Start waiting for write availability.
Method	`stopConsuming`	Stop consuming data.
Method	`stopProducing`	Stop producing data.
Method	`stopReading`	Stop waiting for read availability.
Method	`stopWriting`	Stop waiting for write availability.
Method	`write`	Reliably write some data.
Method	`writeConnectionLost`	Indicates write connection was lost.
Method	`writeSequence`	Reliably write a sequence of data.
Constant	`SEND_LIMIT`	Undocumented
Class Variable	`bufferSize`	Undocumented
Class Variable	`disconnecting`	Undocumented
Instance Variable	`dataBuffer`	Undocumented
Instance Variable	`disconnected`	Undocumented
Instance Variable	`offset`	Undocumented
Instance Variable	`producer`	Undocumented
Instance Variable	`producerPaused`	Undocumented
Method	`_closeWriteConnection`	Undocumented
Method	`_isSendBufferFull`	Determine whether the user-space send buffer for this transport is full or not.
Method	`_maybePauseProducer`	Possibly pause a producer, if there is one and the send buffer is full.
Method	`_postLoseConnection`	Called after a loseConnection(), when all data has been written.
Class Variable	`_writeDisconnected`	Undocumented
Instance Variable	`_tempDataBuffer`	Undocumented
Instance Variable	`_tempDataLen`	Undocumented
Instance Variable	`_writeDisconnecting`	Undocumented

Inherited from _ConsumerMixin (via FileDescriptor):

Method	`registerProducer`	Register to receive data from a producer.
Method	`unregisterProducer`	Stop consuming data from a producer, without disconnecting.
Instance Variable	`streamingProducer`	`bool` or `int`

Inherited from _LogOwner (via FileDescriptor):

Method	`logPrefix`	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	`_getLogPrefix`	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, timeout=0, xonxoff=0, rtscts=0): (source)

overrides twisted.internet.abstract.FileDescriptor.__init__

Parameters
protocol	Undocumented
deviceNameOrPortNumber	Undocumented
reactor	An `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.
baudrate	Undocumented
bytesize	Undocumented
parity	Undocumented
stopbits	Undocumented
timeout	Undocumented
xonxoff	Undocumented
rtscts	Undocumented

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 doRead(self): (source)

from twisted.internet.interfaces.IReadDescriptor

overrides twisted.internet.abstract.FileDescriptor.doRead

Some data's readable from serial device.

def fileno(self): (source)

from twisted.internet.interfaces.IFileDescriptor

overrides twisted.internet.abstract.FileDescriptor.fileno

File Descriptor number for select().

This method must be overridden or assigned in subclasses to indicate a valid file descriptor for the operating system.

def writeSomeData(self, data): (source)

overrides twisted.internet.abstract.FileDescriptor.writeSomeData

Write some data to the serial device.

connected: int = (source)

overrides twisted.internet.abstract.FileDescriptor.connected

Undocumented

protocol = (source)

Undocumented

reactor = (source)

overrides twisted.internet.abstract.FileDescriptor.reactor

Undocumented

_serial = (source)

overrides twisted.internet.serialport.BaseSerialPort._serial

Undocumented