.. pySerial documentation master file

Welcome to pySerial's documentation
===================================

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

Other pages (online)

- `project page on SourceForge`_
- `SVN repository`_
- `Download Page`_ with releases
- This page, when viewed online, is at http://pyserial.sf.net.

.. _`project page on SourceForge`: http://sourceforge.net/projects/pyserial/
.. _`SVN repository`: http://svn.code.sf.net/p/pyserial/code/trunk
.. _`Download Page`: http://pypi.python.org/pypi/pyserial


Contents:

.. toctree::
    :maxdepth: 2

    pyserial
    shortintro
    examples
    pyserial_api
    pyparallel
    appendix

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

