.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pio-uart/badge/?version=latest :target: https://docs.circuitpython.org/projects/pio-uart/en/latest/ :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/actions :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Code Style: Ruff

PIO implementation of CircuitPython UART API

Dependencies

This driver depends on:

• Adafruit CircuitPython <https://github.com/adafruit/circuitpython>_
• Adafruit CircuitPython PIOASM <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM>_

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle <https://circuitpython.org/libraries>_ or individual libraries can be installed using circup <https://github.com/adafruit/circup>_.

Works with the Raspberry Pi RP2040 Pico family.

Purchase one from the Adafruit shop <https://www.adafruit.com/category/875>_.

Installing from PyPI

.. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI <https://pypi.org/project/adafruit-circuitpython-pio-uart/>_. To install for current user:

.. code-block:: shell

pip3 install adafruit-circuitpython-pio-uart

To install system-wide (this may be required in some cases):

.. code-block:: shell

sudo pip3 install adafruit-circuitpython-pio-uart

To install in a virtual environment in your current project:

.. code-block:: shell

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-pio-uart

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

.. code-block:: shell

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

.. code-block:: shell

circup install adafruit_pio_uart

Or the following command to update an existing version:

.. code-block:: shell

circup update

Usage Example

.. code-block:: python

import board
import adafruit_pio_uart

uart = adafruit_pio_uart.UART(board.TX, board.RX)

uart.write(b"\x00")
print(uart.read(1))

Documentation

API documentation for this library can be found on Read the Docs <https://docs.circuitpython.org/projects/pio_uart/en/latest/>_.

For information on building library documentation, please check out this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>_.

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_PIO_UART/blob/HEAD/CODE_OF_CONDUCT.md>_ before contributing to help this project stay welcoming.