Skip to main content

Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag.

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.

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

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

sudo pip3 install adafruit-circuitpython-pybadger

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-pybadger

Usage Example

from adafruit_pybadger import pybadger

pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3)

while True:
    pybadger.auto_dim_display(delay=10)
    if pybadger.button.a:
        pybadger.show_business_card(image_name="Blinka.bmp", name_string="Blinka", name_scale=2,
                                    email_string_one="blinka@", email_string_two="adafruit.com")
    elif pybadger.button.b:
        pybadger.show_qr_code(data="https://circuitpython.org")
    elif pybadger.button.start:
        pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3)

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_pybadger-4.0.5.tar.gz (82.6 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_pybadger-4.0.5-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_pybadger-4.0.5.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.5.tar.gz
Algorithm Hash digest
SHA256 1c1f63c102cb2d7c7a8d9cf3e869b7b3263b67df0bc3ba7106894283e7b2fd3c
MD5 cdd0ff6324ae9310f2cfe6bdc1880589
BLAKE2b-256 63638ee4af6387d99581c28567b7358b3cc8e4bef2e34481c81071a91a73d1dc

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_pybadger-4.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b24c5c16d57d5e67a4a67267653214930401d4340b56cf61362b8c41571ba513
MD5 33d98737cdb4162b169f9f2e6bd443e7
BLAKE2b-256 003dd059ceca54b8f688da6854799f45849e73500f59c4d056c84ab4ffc6b152

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page