twisted.internet.serialport.SerialPort : API documentation

Method	__init__
Method	serialReadEvent	Undocumented
Method	write	Reliably write some data.
Method	serialWriteEvent	Undocumented
Method	connectionLost	Called when the serial port disconnects.
Method	_finishPortSetup	Finish setting up the serial port.
Method	_clearCommError	Undocumented

Inherited from BaseSerialPort:

Method	setBaudRate	Undocumented
Method	inWaiting	Undocumented
Method	flushInput	Undocumented
Method	flushOutput	Undocumented
Method	sendBreak	Undocumented
Method	getDSR	Undocumented
Method	getCD	Undocumented
Method	getRI	Undocumented
Method	getCTS	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.
Instance Variable	_serial	a pyserial `serial.Serial` instance used to manage the options on the serial port.

Inherited from FileDescriptor:

Method	writeSomeData	Write as much as possible of the given data, immediately.
Method	doRead	Called when data is available for reading.
Method	doWrite	Called when data can be written.
Method	writeConnectionLost	Indicates write connection was lost.
Method	readConnectionLost	Indicates read connection was lost.
Method	writeSequence	Reliably write a sequence of data.
Method	loseConnection	Close the connection at the next available opportunity.
Method	loseWriteConnection	Undocumented
Method	stopReading	Stop waiting for read availability.
Method	stopWriting	Stop waiting for write availability.
Method	startReading	Start waiting for read availability.
Method	startWriting	Start waiting for write availability.
Method	stopConsuming	Stop consuming data.
Method	resumeProducing	Resume producing data.
Method	pauseProducing	Pause producing data.
Method	stopProducing	Stop producing data.
Method	fileno	File Descriptor number for select().
Method	_postLoseConnection	Called after a loseConnection(), when all data has been written.
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.

Inherited from _ConsumerMixin (via FileDescriptor):

Instance Variable	producer	`None` if no producer is registered, otherwise the registered producer.
Instance Variable	producerPaused	A flag indicating whether the producer is currently paused. (type: `bool`)
Instance Variable	streamingProducer 0	A flag indicating whether the producer was registered as a streaming (ie push) producer or not (ie a pull producer). This will determine whether the consumer may ever need to pause and resume it, or if it can merely call `resumeProducing` on it when buffer space is available.
Instance Variable	streamingProducer	`bool` or `int`
Method	registerProducer	Register to receive data from a producer.
Method	unregisterProducer	Stop consuming data from a producer, without disconnecting.

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, xonxoff=0, rtscts=0): (source)

overrides twisted.internet.abstract.FileDescriptor.__init__

Parameters 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.

def _finishPortSetup(self): (source)

Finish setting up the serial port.

This is a separate method to facilitate testing.

def _clearCommError(self): (source)

Undocumented

def serialReadEvent(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.

def serialWriteEvent(self): (source)

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.

twisted.internet.serialport.SerialPort(BaseSerialPort, abstract.FileDescriptor) class documentation

`twisted.internet.serialport.SerialPort(BaseSerialPort, abstract.FileDescriptor)` class documentation