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: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-pybadger-3.7.13.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-pybadger-3.7.13.tar.gz
Algorithm Hash digest
SHA256 9636e09c3f2d3f0ebde791488e793ae24693ef82efda0414c62df208d01bc111
MD5 4fe389a4feb1609bbbdf49f703e760fe
BLAKE2b-256 74e51e1329de65b4162febb1fe5bc4b6b05d960db191bdbe53232886878d466d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-3.7.13-py3-none-any.whl
Algorithm Hash digest
SHA256 c8aed9dcc65a06b313986a738ede0e0ed0e40337989ebaea4f619833be1e7ef4
MD5 2570daa8d6fdbf6e2652f5a5dfd8f5fb
BLAKE2b-256 43df3aef9cc3a656db160e3a9196ae4a98ee5591b06cd1c295e283a394417120

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