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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_pybadger-4.0.8-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.8.tar.gz
Algorithm Hash digest
SHA256 69b2e39aba00a7a1b80451df1101f6de1a5bf6fb61497c2c3fac966107d6cb84
MD5 b79973831bb5563958613c6a0c166a64
BLAKE2b-256 00f90eb8743f936b47e3b06641aa2eb05cd7b3fe874d6f2714e33405d941e7b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_pybadger-4.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e7874f006179e4e9feb7dc6b6e275ce4eaceec91df0b224b577fd2544f8ee2ac
MD5 40f616a9f24c54657414e354e62ef1fe
BLAKE2b-256 3084f0eae03300fb04a770a8693bbb6e0869449e16d44536dd3069e7c68d8520

See more details on using hashes here.

Supported by

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