Skip to main content

PIO implementation of CircuitPython UART API

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

PIO implementation of CircuitPython UART API

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Works with the Raspberry Pi RP2040 Pico family.

Purchase one from the Adafruit shop.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-pio-uart

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

sudo pip3 install adafruit-circuitpython-pio-uart

To install in a virtual environment in your current project:

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:

pip3 install circup

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

circup install adafruit_pio_uart

Or the following command to update an existing version:

circup update

Usage Example

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_pio_uart-1.0.3.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_pio_uart-1.0.3.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.3.tar.gz
Algorithm Hash digest
SHA256 200d29cad92c3c267de995242d5e5c6da3ca3a3d1e718340761bc2cb77cf2d26
MD5 5d44ec0d6a3fb3e26fce684eeefbd825
BLAKE2b-256 48e11d8a5a20c050bbabcf99784c966abf10f04c4c7c552fb8164b9db9cdf5b8

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_pio_uart-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 de444359f3b235f479fca44165c94159405bf7d2207344ecce82ceaa32da7669
MD5 a64c9a5c33934044155e3a03de7574dc
BLAKE2b-256 3bd32408e281a46ab74021ed5a237c6099ee49a3f3320771cd216c78f1e20f31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page