Merge pull request #2524 from kattni/neokey-breakout-code

Add NeoKey breakouts guide code

Author: TheKitty

NeoKey_MX_and_CHOC_Breakouts/Arduino/NeoKey_NeoPixel_Rainbow_and_HID/.qt_py_rp2040.test.only

@@ -0,0 +1,64 @@
+// SPDX-FileCopyrightText: 2023 Kattni Rembor for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#include <Adafruit_NeoPixel.h>
+
+#define NEOPIXEL_PIN A3
+#define NUM_PIXELS 2
+
+#define SWITCHA_PIN A1
+#define SWITCHB_PIN A2
+
+Adafruit_NeoPixel strip = Adafruit_NeoPixel(NUM_PIXELS, NEOPIXEL_PIN, NEO_GRB + NEO_KHZ800);
+
+void setup() {
+  Serial.begin(115200);
+  //while (!Serial);
+  strip.begin();
+  strip.setBrightness(25);
+  strip.show(); // Initialize all pixels to 'off'
+  pinMode(SWITCHA_PIN, INPUT_PULLUP);
+  pinMode(SWITCHB_PIN, INPUT_PULLUP);
+}
+
+uint8_t j=0;
+void loop() {
+  for(int i=0; i< strip.numPixels(); i++) {
+    strip.setPixelColor(i, Wheel(((i * 256 / strip.numPixels()) + j) & 255));
+  }
+
+  // turn off LED if not pressed!
+  if (!digitalRead(SWITCHA_PIN)) {
+    Serial.println("A");
+    strip.setPixelColor(0, 0);
+  }
+  if (!digitalRead(SWITCHB_PIN)) {
+    Serial.println("B");
+    strip.setPixelColor(1, 0);
+  }
+  
+  strip.show();
+
+  j++; // go to next color
+  delay(10);
+}
+
+// Slightly different, this makes the rainbow equally distributed throughout
+void rainbowCycle(uint8_t wait) {
+
+}
+
+// Input a value 0 to 255 to get a color value.
+// The colours are a transition r - g - b - back to r.
+uint32_t Wheel(byte WheelPos) {
+  if(WheelPos < 85) {
+   return strip.Color(WheelPos * 3, 255 - WheelPos * 3, 0);
+  } else if(WheelPos < 170) {
+   WheelPos -= 85;
+   return strip.Color(255 - WheelPos * 3, 0, WheelPos * 3);
+  } else {
+   WheelPos -= 170;
+   return strip.Color(0, WheelPos * 3, 255 - WheelPos * 3);
+  }
+}

NeoKey_MX_and_CHOC_Breakouts/Arduino/NeoKey_NeoPixel_Rainbow_and_HID/NeoKey_NeoPixel_Rainbow_and_HID.ino

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: 2023 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""NeoKey Breakout HID Demo"""
+
+import time
+import board
+import keypad
+import usb_hid
+import neopixel
+from adafruit_hid.keyboard import Keyboard
+from adafruit_hid.keycode import Keycode
+
+# --- CONFIGURATION ---
+# Keycode to send on key press.
+SEND_ON_PRESS = (
+    Keycode.B,
+    Keycode.THREE,
+)
+
+# NeoPixel colors for each key when pressed.
+COLORS = (
+    (255, 255, 0),  # Yellow
+    (0, 255, 255),  # Cyan
+)
+
+# NeoPixel brightness. Must be a float or integer between 0.0 and 1.0, where 0 is off and
+# 1 is maximum brightness. Defaults to 0.3.
+BRIGHTNESS = 0.3
+
+# NeoPixel and key switch pins. Update to match your wiring setup.
+PIXEL_PIN = board.A3
+KEY_PINS = (
+    board.A1,
+    board.A2,
+)
+
+# --- SETUP AND CODE ---
+# Number of NeoPixels. This will always match the number of breakouts and
+# therefore the number of key pins listed.
+NUM_PIXELS = len(KEY_PINS)
+
+# Create keyboard object.
+time.sleep(1)  # Delay to avoid a race condition on some systems.
+keyboard = Keyboard(usb_hid.devices)
+
+# Create NeoPixel object.
+pixels = neopixel.NeoPixel(PIXEL_PIN, NUM_PIXELS, brightness=BRIGHTNESS)
+
+# Create keypad object.
+keys = keypad.Keys(KEY_PINS, value_when_pressed=False, pull=True)
+
+while True:
+    # Begin getting key events.
+    event = keys.events.get()
+
+    # If there is a key press event, run this block.
+    if event and event.pressed:
+        # Save the number of the key pressed to `key_number` to use in multiple places.
+        key_number = event.key_number
+        # Light up the corresponding NeoPixel to the appropriate color in the `COLORS` tuple.
+        pixels[key_number] = COLORS[key_number]
+        # Send the appropriate `Keycode` as identified in the `SEND_ON_PRESS` tuple.
+        keyboard.press(SEND_ON_PRESS[key_number])
+
+    # If there is a key released event, run this block.
+    if event and event.released:
+        # Turn off the LEDs.
+        pixels.fill((0, 0, 0))
+        # Report that the key switch has been released.
+        keyboard.release_all()

NeoKey_MX_and_CHOC_Breakouts/CircuitPython/HID/code.py

@@ -0,0 +1,59 @@
+# SPDX-FileCopyrightText: 2023 Kattni Rembor for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Dan Halbert for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""NeoKey Breakout NeoPixel Rainbow Cycle Demo"""
+
+import time
+import board
+import keypad
+import neopixel
+from rainbowio import colorwheel
+
+# --- CONFIGURATION ---
+# NeoPixel brightness. Must be a float or integer between 0.0 and 1.0, where 0 is off and
+# 1 is maximum brightness. Defaults to 0.3.
+BRIGHTNESS = 0.3
+
+# NeoPixel and key switch pins. Update to match your wiring setup. If adding more
+# NeoKey breakouts, add the pins to `KEY_PINS` in the same format as the two shown.
+PIXEL_PIN = board.A3
+KEY_PINS = (
+    board.A1,
+    board.A2,
+)
+
+# --- SETUP AND CODE ---
+# Number of NeoPixels. This will always match the number of breakouts and
+# therefore the number of key pins listed.
+NUM_PIXELS = len(KEY_PINS)
+
+# Create NeoPixel object.
+pixels = neopixel.NeoPixel(PIXEL_PIN, NUM_PIXELS, brightness=BRIGHTNESS)
+
+# Create keypad object.
+keys = keypad.Keys(KEY_PINS, value_when_pressed=False, pull=True)
+
+# Create two lists.
+# The `pressed` list is used to track the key press state.
+pressed = [False] * NUM_PIXELS
+# The `color_value` list is used to track the current color value for a specific NeoPixel.
+color_value = [0] * NUM_PIXELS
+
+while True:
+    # Begin getting key events.
+    event = keys.events.get()
+    if event:
+        # Remember the last state of the key when pressed.
+        pressed[event.key_number] = event.pressed
+
+    # Advance the rainbow for the key that is currently pressed.
+    for index in range(NUM_PIXELS):
+        if pressed[index]:
+            # Increase the color value by 1.
+            color_value[index] += 1
+            # Set the pixel color to the current color value.
+            pixels[index] = colorwheel(color_value[index])
+
+    time.sleep(0.01)

NeoKey_MX_and_CHOC_Breakouts/CircuitPython/NeoPixel_Rainbow_Press/code.py

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: 2023 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""NeoKey Breakout Random NeoPixel Color Demo"""
+
+import random
+import board
+import keypad
+import neopixel
+from rainbowio import colorwheel
+
+# --- CONFIGURATION ---
+# NeoPixel brightness. Must be a float or integer between 0.0 and 1.0, where 0 is off and
+# 1 is maximum brightness. Defaults to 0.3.
+BRIGHTNESS = 0.3
+
+# NeoPixel and key switch pins. Update to match your wiring setup.
+PIXEL_PIN = board.A3
+KEY_PINS = (
+    board.A1,
+    board.A2,
+)
+
+# --- SET UP AND CODE ---
+# Number of NeoPixels. This will always match the number of breakouts and
+# therefore the number of key pins listed.
+NUM_PIXELS = len(KEY_PINS)
+
+# Create NeoPixel object.
+pixels = neopixel.NeoPixel(PIXEL_PIN, NUM_PIXELS, brightness=BRIGHTNESS)
+
+# Create keypad object.
+keys = keypad.Keys(KEY_PINS, value_when_pressed=False, pull=True)
+
+while True:
+    # Begin getting key events.
+    event = keys.events.get()
+    # If there is a key press event, run this block.
+    if event and event.pressed:
+        # Print the key number of the pressed key.
+        print(f"Key {event.key_number} pressed!")
+        # Light up the corresponding NeoPixel to a random color.
+        pixels[event.key_number] = colorwheel(random.randint(0, 255))