Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`serialport`.`SerialPort``

class documentation

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

Constructor: `SerialPort(protocol, deviceNameOrPortNumber, reactor, baudrate, ...)`

View In Hierarchy

A serial device, acting as a transport, that uses a win32 event.

Method | `__init__` | No summary
Method | `connectionLost` | Called when the serial port disconnects.
Method | `serialReadEvent` | Undocumented
Method | `serialWriteEvent` | Undocumented
Method | `write` | Reliably write some data.
Instance Variable | `closed` | Undocumented
Instance Variable | `closedNotifies` | Undocumented
Instance Variable | `connected` | Undocumented
Instance Variable | `outQueue` | Undocumented
Instance Variable | `protocol` | Undocumented
Instance Variable | `reactor` | Undocumented
Instance Variable | `read_buf` | Undocumented
Instance Variable | `writeInProgress` | Undocumented
Method | `_clearCommError` | Undocumented
Method | `_finishPortSetup` | Finish setting up the serial port.
Instance Variable | `_overlappedRead` | Undocumented
Instance Variable | `_overlappedWrite` | 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` (via `BaseSerialPort`):

Method | `doRead` | Called when data is available for reading.
Method | `doWrite` | Called when data can be written.
Method | `fileno` | File Descriptor number for select().
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 | `writeConnectionLost` | Indicates write connection was lost.
Method | `writeSequence` | Reliably write a sequence of data.
Method | `writeSomeData` | Write as much as possible of the given data, immediately.
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 `BaseSerialPort`, `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 `BaseSerialPort`, `FileDescriptor`, `_ConsumerMixin`):

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

closed: `int` = (source)

Undocumented

closedNotifies: `int` = (source)

Undocumented

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

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