sdkagent

pyserial API reference

87 public APIs from pyserial (pyserial/pyserial) — 20 classes, 3 functions, 64 methods. Signatures extracted by static analysis of the actual source.

Repository: pyserial/pyserial

KindCount
Classes20
Functions3
Methods64

API list

classserial.rfc2217.PortManager
This class manages the state of Telnet and RFC 2217.
methodserial.rfc2217.PortManager.filter(data)
Handle a bunch of incoming bytes.
methodserial.rfc2217.PortManager.telnet_send_option(action, option)
Send DO, DONT, WILL, WONT.
classserial.rfc2217.Serial
Serial port implementation for RFC 2217 remote serial ports.
methodserial.rfc2217.Serial.cd()
Read terminal status line: Carrier Detect.
methodserial.rfc2217.Serial.close()
Close port
methodserial.rfc2217.Serial.cts()
Read terminal status line: Clear To Send.
methodserial.rfc2217.Serial.dsr()
Read terminal status line: Data Set Ready.
methodserial.rfc2217.Serial.get_modem_state()
get last modem state (cached value.
methodserial.rfc2217.Serial.open()
Open port with current settings.
methodserial.rfc2217.Serial.read(size=1)
Read size bytes from the serial port.
methodserial.rfc2217.Serial.rfc2217_send_purge(value)
Send purge request to the remote.
methodserial.rfc2217.Serial.rfc2217_send_subnegotiation(option, value=b'')
Subnegotiation of RFC2217 parameters.
methodserial.rfc2217.Serial.ri()
Read terminal status line: Ring Indicator.
methodserial.rfc2217.Serial.telnet_send_option(action, option)
Send DO, DONT, WILL, WONT.
methodserial.rfc2217.Serial.timeout()
Get the current timeout setting.
classserial.rfc2217.TelnetOption
Manage a single telnet option, keeps track of DO/DONT WILL/WONT.
classserial.rfc2217.TelnetSubnegotiation
A object to handle subnegotiation of options.
methodserial.rfc2217.TelnetSubnegotiation.set(value)
Request a change of the value.
classserial.serialposix.PosixPollSerial
Poll based read implementation.
classserial.serialposix.Serial
Serial port class POSIX implementation.
methodserial.serialposix.Serial.cd()
Read terminal status line: Carrier Detect
methodserial.serialposix.Serial.close()
Close port
methodserial.serialposix.Serial.cts()
Read terminal status line: Clear To Send
methodserial.serialposix.Serial.dsr()
Read terminal status line: Data Set Ready
methodserial.serialposix.Serial.flush()
Flush of file like objects.
methodserial.serialposix.Serial.nonblocking()
DEPRECATED - has no use
methodserial.serialposix.Serial.open()
Open port with current settings.
methodserial.serialposix.Serial.read(size=1)
Read size bytes from the serial port.
methodserial.serialposix.Serial.ri()
Read terminal status line: Ring Indicator
methodserial.serialposix.Serial.send_break(duration=0.25)
Send break condition.
classserial.serialutil.PortNotOpenError
Port is not open
classserial.serialutil.SerialBase
Serial port base class.
methodserial.serialutil.SerialBase.baudrate()
Get the current baud rate setting.
methodserial.serialutil.SerialBase.bytesize()
Get the current byte size setting.
methodserial.serialutil.SerialBase.parity()
Get the current parity setting.
methodserial.serialutil.SerialBase.port()
Get the current port setting.
methodserial.serialutil.SerialBase.send_break(duration=0.25)
Send break condition.
methodserial.serialutil.SerialBase.stopbits()
Get the current stop bits setting.
methodserial.serialutil.SerialBase.timeout()
Get the current timeout setting.
methodserial.serialutil.SerialBase.write_timeout()
Get the current timeout setting.
methodserial.serialutil.SerialBase.xonxoff()
Get the current XON/XOFF setting.
classserial.serialutil.SerialException
Base class for serial port related exceptions.
classserial.serialutil.SerialTimeoutException
Write timeouts give an exception
classserial.serialutil.Timeout
Abstraction for timeout operations.
methodserial.serialutil.Timeout.expired() -> bool
Return a boolean, telling if the timeout has expired.
methodserial.serialutil.Timeout.restart(duration:int | float) -> None
Restart a timeout.
methodserial.serialutil.Timeout.time_left() -> float | None
Calculate how many seconds are left until the timeout expires.
funcserial.serialutil.to_bytes(seq)
convert a sequence to a bytes type
classserial.serialwin32.Serial
Serial port implementation for Win32 based on ctypes.
methodserial.serialwin32.Serial.cd()
Read terminal status line: Carrier Detect
methodserial.serialwin32.Serial.close()
Close port
methodserial.serialwin32.Serial.cts()
Read terminal status line: Clear To Send
methodserial.serialwin32.Serial.dsr()
Read terminal status line: Data Set Ready
methodserial.serialwin32.Serial.exclusive(exclusive)
Change the exclusive access setting.
methodserial.serialwin32.Serial.flush()
Flush of file like objects.
methodserial.serialwin32.Serial.open()
Open port with current settings.
methodserial.serialwin32.Serial.read(size=1)
Read size bytes from the serial port.
methodserial.serialwin32.Serial.ri()
Read terminal status line: Ring Indicator
classserial.threaded.FramedPacket
Read binary packets.
methodserial.threaded.FramedPacket.connection_lost(exc)
Forget transport
methodserial.threaded.FramedPacket.connection_made(transport)
Store transport
classserial.threaded.LineReader
Read and write (Unicode) lines from/to serial port.
methodserial.threaded.LineReader.flush()
Flush the underlying transport
methodserial.threaded.LineReader.write_line(text)
Write text to the transport.
classserial.threaded.Packetizer
Read binary packets from serial port.
methodserial.threaded.Packetizer.connection_lost(exc)
Forget transport
methodserial.threaded.Packetizer.connection_made(transport)
Store transport
classserial.threaded.Protocol
Protocol as used by the ReaderThread.
methodserial.urlhandler.protocol_loop.Serial.open()
Open port with current settings.
classserial.urlhandler.protocol_socket.Serial
Serial port implementation for plain sockets.
methodserial.urlhandler.protocol_socket.Serial.close()
Close port
methodserial.urlhandler.protocol_socket.Serial.open()
Open port with current settings.
methodserial.urlhandler.protocol_socket.Serial.send_break(duration=0.25)
Send break condition.
classserial.urlhandler.protocol_spy.FormatLog
Write data to logging module.
methodserial.urlhandler.protocol_spy.FormatLog.control(name, value)
show control calls
methodserial.urlhandler.protocol_spy.FormatLog.rx(data)
show received data
methodserial.urlhandler.protocol_spy.FormatLog.tx(data)
show transmitted data
classserial.urlhandler.protocol_spy.FormatLogHex
Write data to logging module.
methodserial.urlhandler.protocol_spy.FormatLogHex.rx(data)
show received data
methodserial.urlhandler.protocol_spy.FormatLogHex.tx(data)
show transmitted data
classserial.urlhandler.protocol_spy.FormatRaw
Forward only RX and TX data to output.
methodserial.urlhandler.protocol_spy.FormatRaw.control(name, value)
(do not) show control calls
methodserial.urlhandler.protocol_spy.FormatRaw.rx(data)
show received data
methodserial.urlhandler.protocol_spy.FormatRaw.tx(data)
show transmitted data
funcserial.urlhandler.protocol_spy.hexdump(data)
yield lines with hexdump of data
funcserial.win32.is_64bit()
Returns true when running on a 64 bit system

About this data

These signatures were extracted from the public source of pyserial/pyserial using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries