Skip to main content

Portal Style Library for the Adafruit Qualia ESP32-S3

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Portal Style Library for the Adafruit Qualia ESP32-S3

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.

  • 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.

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-qualia-1.1.0.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-qualia-1.1.0.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-qualia-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ee14a952310384a8d7cdc3300234a79d0add33ba7af2bc335add7bef8575eecd
MD5 6de8275e275577c02eab4607fd5b4d9a
BLAKE2b-256 c0c838bae8d0696cf7748b15e44826dcf035f0e4e1a4141b8627fb49418e6f19

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_qualia-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_qualia-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a32ea95ab70bafb5558be9deec437df9896013b41519adcc52c78f565c423aa9
MD5 626eb516fe8d2e45f9a188f709ae294e
BLAKE2b-256 730b9f3ce1f67a08b312353edf06bb7dc2d9f1fa137b8b5a7e0003262a683d60

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