pyserial/pyserial
Pyserial
pyserial is a cross-platform Python library for reading and writing binary data to serial ports and hardware devices. It provides a serial port enumeration tool for identifying available hardware and retrieving device path metadata.
The project includes a network implementation for controlling remote serial port functions and signal lines over TCP/IP via the RFC 2217 standard. It also features a serial-to-TCP bridge for forwarding raw data between local ports and network sockets, as well as a specialized interface for managing half-duplex RS485 communication and RTS toggling.
The library covers broad hardware integration capabilities, including port configuration for baud rates and parity, binary data transmission using file-like interfaces, and port discovery via hardware IDs or regular expressions. It further provides tools for serial traffic interception, loopback connection simulation for testing, and an interactive serial terminal for device communication.
Features
- Hardware Communication - Establishes stable data links with external hardware by configuring baud rates, parity, and stop bits.
- Serial Port Interfaces - Provides a cross-platform library for reading and writing binary data to serial ports and hardware devices.
- Binary Stream Interfaces - Provides a binary stream interface that preserves null bytes and line endings during serial I/O.
- Port Enumeration - Identifies available serial ports on the system and retrieves hardware IDs and device path metadata.
- Stream Abstractions - Provides a standard file-like read and write interface that treats hardware ports as binary streams.
- Serial Communication Interfaces - Provides a cross-platform library to open and manage connections to serial hardware across different operating systems.
- Serial Data Streamers - Sends raw byte strings to connected serial devices to transmit commands or data.
- Serial Parameter Configurations - A feature of the project that adjusts baud rate, byte size, and flow control for external hardware communication.
- Serial Binary Transmission - Transmits and receives raw binary data through a serial port using a file-like interface.
- Serial Data Buffers - Retrieves data from serial ports by reading specific byte counts, single lines, or buffered data.
- Platform Backend Dispatchers - Selects the appropriate platform-specific driver implementation at runtime to handle low-level system calls across different operating systems.
- Runtime Parameter Tuning - Adjusts byte size, parity, and flow control to match the requirements of external hardware during execution.
- Serial-to-Network Converters - Forwards raw data between a local serial port and a network socket to allow remote hardware access.
- RS485 Communication - Manages half-duplex serial communication and RTS toggling for hardware devices operating on the RS485 standard.
- Hardware Filter Patterns - A feature of the project that finds available serial ports on the host system and filters them using regular expressions.
- Timeout Management - Sets the duration the system waits for incoming data to prevent application hangs.
- Interactive Terminals - Provides a console-based terminal emulator for interactive communication with connected serial devices.
- Embedded Device Debugging - Enables reading and writing raw binary data to embedded devices to monitor traffic and send commands.
- Hardware Device Discovery - Searches for available serial ports by matching regular expressions against device descriptions or hardware IDs.
- HID Device Communication - Implements a software-based communication stack to interact with USB HID hardware without kernel drivers.
- RS485 Communication Management - Manages RS485 settings and RTS toggling to support half-duplex serial communication on compatible hardware.
- RFC 2217 Clients - Provides a network client to manage remote serial port settings and signal lines via the RFC 2217 standard.
- RFC 2217 Implementations - Implements the RFC 2217 standard to manage remote serial port settings and signal lines over TCP/IP.
- RFC 2217 Servers - Implements an RFC 2217 server to handle protocol negotiation and control commands for network-to-serial conversion.
- Remote Management Access - Connects to hardware ports over a network using TCP sockets or the RFC 2217 protocol.
- RFC 2217 Implementations - Provides a network implementation for controlling remote serial port functions and signal lines over TCP/IP.
