https://github.com/adafruit/adafruit_circuitpython_macropad
A helper library for the Adafruit MacroPad RP2040
https://github.com/adafruit/adafruit_circuitpython_macropad
hacktoberfest
Last synced: 3 months ago
JSON representation
A helper library for the Adafruit MacroPad RP2040
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_macropad
- Owner: adafruit
- License: mit
- Created: 2021-06-29T18:51:42.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T19:56:23.000Z (over 1 year ago)
- Last Synced: 2025-04-11T19:07:29.742Z (over 1 year ago)
- Topics: hacktoberfest
- Language: Python
- Size: 259 KB
- Stars: 96
- Watchers: 24
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-macropad/badge/?version=latest
:target: https://docs.circuitpython.org/projects/macropad/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MacroPad/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MacroPad/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
A helper library for the Adafruit MacroPad RP2040.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
* `Adafruit's CircuitPython NeoPixel library
`_
* `Adafruit's CircuitPython HID library
`_
* `Adafruit's CircuitPython MIDI library
`_
* `Adafruit's CircuitPython Display Text library
`_
* `Adafruit's CircuitPython Simple Text Display library
`_
* `Adafruit's CircuitPython Debouncer library
`_
* `Adafruit's CircuitPython Ticks library
`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`circup `_.
This library is designed to work withe the Adafruit MacroPad RP2040. Consider
purchasing one from the Adafruit shop:
`Adafruit MacroPad RP2040 Bare Bones `_
`Adafruit MacroPad RP2040 Starter Kit `_
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_macropad
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
This example prints out the key pressed, the relative position of the rotary encoder and the
state of the rotary encoder switch.
.. code-block:: python
from adafruit_macropad import MacroPad
import time
macropad = MacroPad()
while True:
key_event = macropad.keys.events.get()
if key_event and key_event.pressed:
print("Key pressed: {}".format(key_event.key_number))
print("Encoder: {}".format(macropad.encoder))
print("Encoder switch: {}".format(macropad.encoder_switch))
time.sleep(0.4)
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.