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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-qualia-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6132b0412b854815bd98c20aa60ce84f953ae122e17a2fe596ece20678f3486e
MD5 a030dd126536ba688f203c1adf557fa1
BLAKE2b-256 b21b4d1d1f56c89f8ee519ab0b3980211a5bb06315cf51eca74845710fa6bfd9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_qualia-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef49e2ad1e5582347cbd1eb54334be42fa9bfd4f0382c08568dcf82c71ad2420
MD5 60f8c44ac113fa1d7f9f26748484f064
BLAKE2b-256 e9da4e0553ded3b6f1e7c379f0434264e95448ddbabac6d25a3c2d00743de6ff

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