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.

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.

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.

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.

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