Overview

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

This fork integrates RFC2217 relevant fixes which haven’t been accepted upstream. We used to install from git, but newer pip enforces that all packages installed from pypi also have all dependencies on pypi. Therefore this is now a proper fork which:

• converts to pyproject.toml

• integrates rfc2217 fixes

• will be available as pyserial-labgrid on pypi

• Project Homepage: https://github.com/pyserial/pyserial-labgrid

• Download Page: https://pypi.python.org/pypi/pyserial-labgrid

BSD license, (C) 2001-2020 Chris Liechti <cliechti@gmx.net> BSD license, (C) 2023-2023 Rouven Czerwinski <entwicklung@pengutronix.de>

Documentation

For API documentation, usage and examples see files in the “documentation” directory. The “.rst” files can be read in any text editor or being converted to HTML or PDF using Sphinx. An HTML version is online at https://pythonhosted.org/pyserial/

Examples

Examples and unit tests are in the directory examples.

Installation

pip install pyserial should work for most users.

Detailed information can be found in documentation/pyserial.rst.

The usual setup.py for Python libraries is used for the source distribution. Windows installers are also available (see download link above).

or

To install this package with conda run:

conda install -c conda-forge pyserial

conda builds are available for linux, mac and windows.