Introduction¶
A helper library for the Adafruit MacroPad RP2040.
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 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:
pip3 install circup
With circup
installed and your CircuitPython device connected use the
following command to install:
circup install adafruit_macropad
Or the following command to update an existing version:
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.
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.
Table of Contents¶
adafruit_macropad
MacroPad
MacroPad.ConsumerControlCode
MacroPad.ControlChange()
MacroPad.Keycode
MacroPad.Mouse
MacroPad.NoteOff()
MacroPad.NoteOn()
MacroPad.PitchBend()
MacroPad.ProgramChange()
MacroPad.consumer_control
MacroPad.display_image()
MacroPad.display_sleep
MacroPad.display_text()
MacroPad.encoder
MacroPad.encoder_switch
MacroPad.encoder_switch_debounced
MacroPad.keyboard
MacroPad.keyboard_layout
MacroPad.keys
MacroPad.midi
MacroPad.mouse
MacroPad.pixels
MacroPad.play_file()
MacroPad.play_tone()
MacroPad.red_led
MacroPad.rotate()
MacroPad.rotation
MacroPad.start_tone()
MacroPad.stop_tone()
keycodes