Welcome to pySerial’s documentation

This module encapsulates the access for the serial port. It provides backends for Python running on Windows, macOS, Linux, and BSD (possibly any POSIX compliant system). The module named “serial” automatically selects the appropriate backend.

Other pages (online)

• project page on GitHub

• Download Page with releases

• This page, when viewed online, is at https://pyserial.readthedocs.io/en/latest/.

Contents:

• pySerial
  • Overview
  • Features
  • Requirements
  • Installation
  • References
  • Older Versions
• Short introduction
  • Opening serial ports
  • Configuring ports later
  • Readline
  • Testing ports
• pySerial API
  • Classes
  • Exceptions
  • Constants
  • Module functions and attributes
  • Threading
  • asyncio
• Tools
  • serial.tools.list_ports
  • serial.tools.miniterm
• URL Handlers
  • Overview
  • rfc2217://
  • socket://
  • loop://
  • hwgrep://
  • spy://
  • alt://
  • cp2110://
  • Examples
• Examples
  • Miniterm
  • TCP/IP - serial bridge
  • Single-port TCP/IP - serial bridge (RFC 2217)
  • Multi-port TCP/IP - serial bridge (RFC 2217)
  • wxPython examples
  • Unit tests
• Appendix
  • How To
  • FAQ
  • Related software
  • License

• Changelog

Indices and tables

• Index

• Module Index

• Search Page