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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-qualia-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f2ed570954fb9e9f0bc1c149a7d0d19b514e5ec1d7d2d2e6a842d50ca672d080
MD5 da6b91f69e89e8722d792f82db073b2d
BLAKE2b-256 fc38293d71f65ec2f84e4e348f70f19af200a858dbeb9ec348199cc8bc5e0cd1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_qualia-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4bf919beb540997295b790b2bb627fa9f6efff658b1a5da4dfcd8a1b11e6f32
MD5 be61ce473f69b87e09628456c4492a8b
BLAKE2b-256 21c4f938399ec4bc7668227ad665f3a53bbfda07fd342292054a480bcce07bcf

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