adafruit-circuitpython-qualia 2.2.1

Portal Style Library for the Adafruit Qualia ESP32-S3

Introduction

Portal Style Library for the Adafruit Qualia ESP32-S3

Dependencies

This driver depends on:

• Adafruit CircuitPython

• Adafruit CircuitPython Connection Manager

• Adafruit CircuitPython CST8XX

• Adafruit CircuitPython FocalTouch

• Adafruit CircuitPython MiniMQTT

• Adafruit CircuitPython MiniQR

• Adafruit CircuitPython PCA9554

• Adafruit CircuitPython PortalBase

• Adafruit CircuitPython Requests

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.

• Adafruit Qualia ESP32-S3 for TTL RGB-666 Displays

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-qualia

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

sudo pip3 install adafruit-circuitpython-qualia

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-qualia

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_qualia

Or the following command to update an existing version:

circup update

Usage Example

from adafruit_qualia import Qualia
from adafruit_qualia.graphics import Displays

# Set a data source URL
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"

# Create the PyPortal object
qualia = Qualia(Displays.SQUARE34, url=TEXT_URL)

# Go get that data
print("Fetching text from", TEXT_URL)
data = qualia.fetch()

# Print out what we got
print("-" * 40)
print(data)
print("-" * 40)

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.