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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-pybadger-3.7.9.tar.gz
Algorithm Hash digest
SHA256 27e4a15254438ad95178443639cdab259e1a14686f82cf36cfa5b6d1b8a128b8
MD5 3e656122e24c4533ab47889b35ee73df
BLAKE2b-256 62908fe5511bd03aeade47e18945ca111bb1d232d0719135f429bab27de30828

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-3.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 da510112150a871c4f2d6d189f2f23d5b4bdc0be76a05663fa6d3472358a4923
MD5 e616aa13c373a923ba3091e36a9f9d48
BLAKE2b-256 4d1137536eb324a011da710f2dae07f16b423e6df61f5005d329d35a2fefcacc

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