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.2.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.2.tar.gz
Algorithm Hash digest
SHA256 641ccf3b535c092f6c20098ff341e572f36242da347d572bb7338579c8b33654
MD5 20a3cc32197ba9f6e3d1627a64fe330c
BLAKE2b-256 46a6a0f45f3e0fee697506903b883b2820c1e729d392d22f140f4a84f0830c6d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e71799775cf08dcc6fe73e558b155933238aa6b4e797b37c9d091afc43ea08b2
MD5 56af219d57272b7cb6e484254e03abf6
BLAKE2b-256 ae19429972fec8f44516fcdf282ef7552c47fc002cb646fd95b66c16bd744c63

See more details on using hashes here.

Supported by

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