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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2f9568f70bfe8bce9b73f6db698600115050af0ea97a8b6fde1bfc72439bd882
MD5 c6e6723d847b509e190040111b26769c
BLAKE2b-256 581553f3d465b229c9964ea3369b3bc45cb77640bb8cf943fb6ff6a6fcd882c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pio_uart-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f8e0d0752b4f010d08221ba882ffe49b6bc8edbf829ad28439c2a13704f39b5
MD5 8066ef8e4dd39d59b9cfb9e8da32df6b
BLAKE2b-256 6d15b3d7071cd7e4117441824a6f59411550b124975a18f884543f4e12288249

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