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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-pybadger-3.8.1.tar.gz
Algorithm Hash digest
SHA256 5ef0611fdce86bc74521e9d6e0895108b1b2c92ff2ec2e1637cef4f633bb3c6f
MD5 32d058fc045e54b9202e996ab0b18f9f
BLAKE2b-256 38a50a4615b58a697a6933dda8c7a59efd21e0a7514cf0425da20508c6a8d02b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-3.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 910ec2c3443bd1eb8f21cac658b0ef74c297f578e3a08987db13f8c4c758de58
MD5 d038572756cd2b619c0cca225684a990
BLAKE2b-256 7551c4f02518ff7fcd527fbe583bad406f37ee7b949d4343da2a94bebc9ac8a9

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