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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.6.tar.gz
Algorithm Hash digest
SHA256 f54fe0ad3f86ba58f009462ebf194845ca012aef5b55b2eae518558f3692dc85
MD5 bac3012879ee16dc58a0333e27e220a4
BLAKE2b-256 82ad930af879b51e3383da618ad34e3d05950ed9ca5dd675fe5d50ae3290187b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1463cf85d00eca3435e044cfbcda70e2a3312c99af38fa5c34c808fc0b97cf6e
MD5 9b6287ed46d776457b0a85e967185d44
BLAKE2b-256 46d688da02dfcdb2dfaa3b290ad73f338a55c85cdc3fe9ce1ba67cb20365eef8

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