Works. Needs testing and docs.

Author: kattni

README.rst

@@ -36,8 +36,7 @@ This is easily achieved by downloading
 or individual libraries can be installed using
 `circup <https://github.com/adafruit/circup>`_.
 
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
+This library is designed to work withe the Adafruit MacroPad RP2040.
 
 `Purchase one from the Adafruit shop <http://www.adafruit.com/products/5100>`_
 
@@ -69,7 +68,6 @@ Usage Example
 =============
 
 .. todo:: Add a quick, simple example. It and other examples should live in the
-examples folder and be included in docs/examples.rst.
 
 Contributing
 ============

adafruit_macropad.py

@@ -1,4 +1,3 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2021 Kattni Rembor for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
@@ -16,22 +15,299 @@
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s).
-  Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
+* `Adafruit MacroPad RP2040 Bare Bones <https://www.adafruit.com/product/5100>`_
+* `Adafruit MacroPad RP2040 Starter Kit <https://www.adafruit.com/product/5128>`_
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
-  https://github.com/adafruit/circuitpython/releases
+  https://circuitpython.org/downloads
 
-.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies
-  based on the library's use of either.
+* Adafruit's CircuitPython NeoPixel library:
+  https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel
 
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
-# imports
+import board
+import digitalio
+import rotaryio
+import keypad
+import neopixel
+import usb_hid
+from adafruit_hid.keyboard import Keyboard
+from adafruit_hid.keycode import Keycode
+from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
+from adafruit_hid.consumer_control import ConsumerControl
+from adafruit_hid.consumer_control_code import ConsumerControlCode
+from adafruit_hid.mouse import Mouse
+import usb_midi
+import adafruit_midi
+from adafruit_midi.note_on import NoteOn
+from adafruit_midi.note_off import NoteOff
+from adafruit_midi.pitch_bend import PitchBend
+from adafruit_midi.control_change import ControlChange
+from adafruit_simple_text_display import SimpleTextDisplay
+
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MacroPad.git"
+
+
+class MacroPad:
+    """
+    Class representing a single MacroPad.
+
+    :param int rotation: The rotational position of the MacroPad. Allows for rotating the MacroPad
+                         in 90 degree increments to four different positions and rotates the keypad
+                         layout and display orientation to match. Keypad layout is always left to
+                         right, top to bottom, beginning with key number 0 in the top left, and
+                         ending with key number 11 in the bottom right. Supports ``0``, ``90``,
+                         ``180``, and ``270`` degree rotations. ``0`` is when the USB port is at
+                         the top, ``90`` is when the USB port is to the left, ``180`` is when the
+                         USB port is at the bottom, and ``270`` is when the USB port is to the
+                         right. Defaults to ``0``.
+    :param int or tuple midi_in_channel: The MIDI input channel. This can either be an integer for
+                                         one channel, or a tuple of integers to listen on multiple
+                                         channels. Defaults to 0.
+    :param int midi_out_channel: The MIDI output channel. Defaults to 0.
+
+    """
+
+    # pylint: disable=invalid-name, too-many-instance-attributes
+    def __init__(self, rotation=0, midi_in_channel=0, midi_out_channel=0):
+        if rotation not in (0, 90, 180, 270):
+            raise ValueError("Only 90 degree rotations are supported.")
+
+        # Define keys:
+        if rotation == 0:
+            self._key_pins = (
+                board.KEY1,
+                board.KEY2,
+                board.KEY3,
+                board.KEY4,
+                board.KEY5,
+                board.KEY6,
+                board.KEY7,
+                board.KEY8,
+                board.KEY9,
+                board.KEY10,
+                board.KEY11,
+                board.KEY12,
+            )
+
+        if rotation == 90:
+            self._key_pins = (
+                board.KEY3,
+                board.KEY6,
+                board.KEY9,
+                board.KEY12,
+                board.KEY2,
+                board.KEY5,
+                board.KEY8,
+                board.KEY11,
+                board.KEY1,
+                board.KEY4,
+                board.KEY7,
+                board.KEY10,
+            )
+
+        if rotation == 180:
+            self._key_pins = (
+                board.KEY12,
+                board.KEY11,
+                board.KEY10,
+                board.KEY9,
+                board.KEY8,
+                board.KEY7,
+                board.KEY6,
+                board.KEY5,
+                board.KEY4,
+                board.KEY3,
+                board.KEY2,
+                board.KEY1,
+            )
+
+        if rotation == 270:
+            self._key_pins = (
+                board.KEY10,
+                board.KEY7,
+                board.KEY4,
+                board.KEY1,
+                board.KEY11,
+                board.KEY8,
+                board.KEY5,
+                board.KEY2,
+                board.KEY12,
+                board.KEY9,
+                board.KEY6,
+                board.KEY3,
+            )
+
+        self._keys = keypad.Keys(self._key_pins, value_when_pressed=False, pull=True)
+
+        # Define rotary encoder:
+        self._encoder = rotaryio.IncrementalEncoder(board.ROTA, board.ROTB)
+        self._encoder_switch = digitalio.DigitalInOut(board.BUTTON)
+        self._encoder_switch.switch_to_input(pull=digitalio.Pull.UP)
+
+        # Define display:
+        self._display = board.DISPLAY
+        self._display.rotation = rotation
+
+        # Define audio:
+        # Audio functionality will be added soon.
+
+        # Define LEDs:
+        self._pixels = neopixel.NeoPixel(board.NEOPIXEL, 12, brightness=0.5)
+        self._led = digitalio.DigitalInOut(board.LED)
+        self._led.switch_to_output()
+
+        # Define HID:
+        self._keyboard = Keyboard(usb_hid.devices)
+        # This will need to be updated if we add more keyboard layouts. Currently there is only US.
+        self._keyboard_layout = KeyboardLayoutUS(self._keyboard)
+        self._consumer_control = ConsumerControl(usb_hid.devices)
+        self._mouse = Mouse(usb_hid.devices)
+
+        # Define MIDI:
+        self._midi = adafruit_midi.MIDI(
+            midi_in=usb_midi.ports[0],
+            # MIDI uses channels 1-16. CircuitPython uses 0-15. Ergo +1.
+            in_channel=midi_in_channel + 1,
+            midi_out=usb_midi.ports[1],
+            out_channel=midi_out_channel + 1,
+        )
+
+    @property
+    def pixels(self):
+        """Sequence-like object representing the twelve NeoPixel LEDs in a 3 x 4 grid on the
+        MacroPad. Each pixel is at a certain index in the sequence, numbered 0-11. Colors can be an
+        RGB tuple like (255, 0, 0) where (R, G, B), or an RGB hex value like 0xFF0000 for red where
+        each two digits are a color (0xRRGGBB). Set the global brightness using any number from 0
+        to 1 to represent a percentage, i.e. 0.3 sets global brightness to 30%. Brightness defaults
+        to 1.
+
+        See `neopixel.NeoPixel` for more info.
+
+        The following example turns all the pixels green at 50% brightness.
+
+        .. code-block:: python
+
+            from adafruit_macropad import MacroPad
+
+            macropad = MacroPad()
+
+            macropad.pixels.brightness = 0.5
+
+            while True:
+                macropad.pixels.fill((0, 255, 0))
+
+        The following example sets the first pixel red and the twelfth pixel blue.
+
+        .. code-block:: python
+
+            from adafruit_macropad import MacroPad
+
+            macropad = MacroPad()
+
+            while True:
+                macropad.pixels[0] = (255, 0, 0)
+                macropad.pixels[11] = (0, 0, 255)
+        """
+        return self._pixels
+
+    @property
+    def red_led(self):
+        """The red led next to the USB port.
+
+        The following example blinks the red LED every 0.5 seconds.
+
+        .. code-block:: python
+
+            import time
+            from adafruit_macropad import MacroPad
+
+            macropad = MacroPad()
+
+            while True:
+              macropad.red_led = True
+              time.sleep(0.5)
+              macropad.red_led = False
+              time.sleep(0.5)
+        """
+        return self._led.value
+
+    @red_led.setter
+    def red_led(self, value):
+        self._led.value = value
+
+    @property
+    def keys(self):
+        return self._keys
+
+    @property
+    def encoder(self):
+        return self._encoder.position * -1
+
+    @property
+    def encoder_switch(self):
+        return not self._encoder_switch.value
+
+    @property
+    def keyboard(self):
+        return self._keyboard
+
+    @staticmethod
+    def Keycode():
+        return Keycode
+
+    @property
+    def keyboard_layout(self):
+        return self._keyboard_layout
+
+    @property
+    def consumer_control(self):
+        return self._consumer_control
+
+    @staticmethod
+    def ConsumerControlCode():
+        return ConsumerControlCode
+
+    @property
+    def mouse(self):
+        return self._mouse
+
+    @property
+    def midi(self):
+        return self._midi
+
+    @staticmethod
+    def NoteOn():
+        return NoteOn
+
+    @staticmethod
+    def NoteOff():
+        return NoteOff
+
+    @staticmethod
+    def PitchBend():
+        return PitchBend
+
+    @staticmethod
+    def ControlChange():
+        return ControlChange
+
+    @staticmethod
+    def text_display(
+        title=None, title_scale=1, title_length=80, text_scale=1, font=None
+    ):
+        return SimpleTextDisplay(
+            title=title,
+            title_color=SimpleTextDisplay.WHITE,
+            title_scale=title_scale,
+            title_length=title_length,
+            text_scale=text_scale,
+            font=font,
+            colors=(SimpleTextDisplay.WHITE,),
+            display=board.DISPLAY,
+        )

docs/conf.py

@@ -25,7 +25,9 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["board", "digitalio", "rotaryio", "keypad", "neopixel", "usb_hid",
+                        "usb_midi", "adafruit_hid", "adafruit_midi", "adafruit_simple_text_display"
+                        ]
 
 
 intersphinx_mapping = {

examples/macropad_simpletest.py

@@ -1,4 +1,6 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2021 Kattni Rembor for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
+from adafruit_macropad import MacroPad
+
+macropad = MacroPad()

requirements.txt

@@ -4,7 +4,8 @@
 # SPDX-License-Identifier: MIT
 
 Adafruit-Blinka
-adafruit-circuitpython-displayio-sh1106
 adafruit-circuitpython-hid
 adafruit-circuitpython-midi
 adafruit-circuitpython-neopixel
+adafruit-circuitpython-display-text
+adafruit-circuitpython-simple-display-text