https://github.com/pyserial/pyserial

Python serial port access library
https://github.com/pyserial/pyserial

python serial

Last synced: 14 days ago
JSON representation

Python serial port access library

• Host: GitHub
• URL: https://github.com/pyserial/pyserial
• Owner: pyserial
• License: other
• Created: 2015-08-02T22:05:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-24T16:52:54.000Z (4 months ago)
• Last Synced: 2024-10-14T13:40:51.079Z (28 days ago)
• Topics: python, serial
• Language: Python
• Homepage:
• Size: 1.76 MB
• Stars: 3,219
• Watchers: 137
• Forks: 1,118
• Open Issues: 410
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome_photonics - PySerial - Issue simple serial commands (RS-232, RS485) to instruments (and read data). (lab automation)

README

        
=================================

 pySerial  |build-status| |docs|

=================================

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.

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

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

BSD license, (C) 2001-2020 Chris Liechti 

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.

.. _`documentation/pyserial.rst`: https://github.com/pyserial/pyserial/blob/master/documentation/pyserial.rst#installation

.. _examples: https://github.com/pyserial/pyserial/blob/master/examples

.. _Python: http://python.org/

.. _Sphinx: http://sphinx-doc.org/

.. |build-status| image:: https://travis-ci.org/pyserial/pyserial.svg?branch=master

   :target: https://travis-ci.org/pyserial/pyserial

   :alt: Build status

.. |docs| image:: https://readthedocs.org/projects/pyserial/badge/?version=latest

   :target: http://pyserial.readthedocs.io/

   :alt: Documentation