update hid_boot_keyboard to support neopixel with power pin, button active high boards such as cpx, cpb and funhouse

also use built-in buttons if defined

Author: hathach

examples/HID/hid_boot_keyboard/hid_boot_keyboard.ino

@@ -10,11 +10,12 @@
 *********************************************************************/
 
 #include "Adafruit_TinyUSB.h"
+#include <Adafruit_NeoPixel.h>
 
 /* This sketch demonstrates USB HID keyboard.
  * - PIN A0-A5 is used to send digit '0' to '5' respectively
  *   (On the RP2040, pins D0-D5 used)
- * - LED will be used as Caplock indicator
+ * - LED and/or Neopixels will be used as Capslock indicator
  */
 
 // HID report descriptor using TinyUSB's template
@@ -24,20 +25,47 @@ uint8_t const desc_hid_report[] =
   TUD_HID_REPORT_DESC_KEYBOARD()
 };
 
-Adafruit_USBD_HID usb_hid;
+// USB HID object
+// Note: For ESP32 these values cannot be changed after this declaration
+// desc report, desc len, protocol, interval, use out endpoint
+Adafruit_USBD_HID usb_hid(desc_hid_report, sizeof(desc_hid_report), HID_ITF_PROTOCOL_KEYBOARD, 2, false);
 
-// Array of pins and its keycode
-// For keycode definition see BLEHidGeneric.h
+//------------- Input Pins -------------//
+// Array of pins and its keycode.
+// Notes: these pins can be replaced by PIN_BUTTONn if defined in setup()
 #ifdef ARDUINO_ARCH_RP2040
-  uint8_t pins[]    = { D0, D1, D2, D3, D4, D5 };
+  uint8_t pins[] = { D0, D1, D2, D3 };
 #else
-  uint8_t pins[]    = { A0, A1, A2, A3, A4, A5 };
+  uint8_t pins[] = { A0, A1, A2, A3 };
 #endif
 
-uint8_t hidcode[] = { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_LEFT, HID_KEY_ARROW_DOWN, HID_KEY_ARROW_UP , HID_KEY_4, HID_KEY_5 };
-
+// number of pins
 uint8_t pincount = sizeof(pins)/sizeof(pins[0]);
 
+// For keycode definition check out https://github.com/hathach/tinyusb/blob/master/src/class/hid/hid.h
+uint8_t hidcode[] = { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_LEFT, HID_KEY_ARROW_DOWN, HID_KEY_ARROW_UP };
+
+#if defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(ARDUINO_NRF52840_CIRCUITPLAY) || defined(ARDUINO_FUNHOUSE_ESP32S2)
+  bool activeState = true;
+#else
+  bool activeState = false;
+#endif
+
+//------------- Neopixel -------------//
+// #define PIN_NEOPIXEL  8
+#ifdef PIN_NEOPIXEL
+
+// How many NeoPixels are attached to the Arduino?
+// use on-board defined NEOPIXEL_NUM if existed
+#ifndef NEOPIXEL_NUM
+  #define NEOPIXEL_NUM  10
+#endif
+
+Adafruit_NeoPixel pixels = Adafruit_NeoPixel(NEOPIXEL_NUM, PIN_NEOPIXEL, NEO_GRB + NEO_KHZ800);
+
+#endif
+
+
 // the setup function runs once when you press reset or power the board
 void setup()
 {
@@ -46,22 +74,53 @@ void setup()
   TinyUSB_Device_Init(0);
 #endif
 
-  usb_hid.setBootProtocol(HID_ITF_PROTOCOL_KEYBOARD);
-  usb_hid.setPollInterval(2);
-  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // Notes: following commented-out functions has no affect on ESP32
+  // usb_hid.setBootProtocol(HID_ITF_PROTOCOL_KEYBOARD);
+  // usb_hid.setPollInterval(2);
+  // usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  // usb_hid.setStringDescriptor("TinyUSB Keyboard");
+
+  // Set up output report (on control endpoint) for Capslock indicator
   usb_hid.setReportCallback(NULL, hid_report_callback);
-  //usb_hid.setStringDescriptor("TinyUSB Keyboard");
 
   usb_hid.begin();
 
   // led pin
   pinMode(LED_BUILTIN, OUTPUT);
   digitalWrite(LED_BUILTIN, LOW);
 
+  // neopixel if existed
+#ifdef PIN_NEOPIXEL
+  pixels.begin();
+  pixels.setBrightness(50);
+
+  #ifdef NEOPIXEL_POWER
+  pinMode(NEOPIXEL_POWER, OUTPUT);
+  digitalWrite(NEOPIXEL_POWER, NEOPIXEL_POWER_ON);
+  #endif
+#endif
+
+  // overwrite input pin with PIN_BUTTONx
+#ifdef PIN_BUTTON1
+  pins[0] = PIN_BUTTON1;
+#endif
+
+#ifdef PIN_BUTTON2
+  pins[1] = PIN_BUTTON2;
+#endif
+
+#ifdef PIN_BUTTON3
+  pins[2] = PIN_BUTTON3;
+#endif
+
+#ifdef PIN_BUTTON4
+  pins[3] = PIN_BUTTON4;
+#endif
+
   // Set up pin as input
   for (uint8_t i=0; i<pincount; i++)
   {
-    pinMode(pins[i], INPUT_PULLUP);
+    pinMode(pins[i], activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
   }
 
   // wait until device mounted
@@ -83,7 +142,7 @@ void loop()
   // scan normal key and send report
   for(uint8_t i=0; i < pincount; i++)
   {
-    if ( 0 == digitalRead(pins[i]) )
+    if ( activeState == digitalRead(pins[i]) )
     {
       // if pin is active (low), add its hid code to key report
       keycode[count++] = hidcode[i];
@@ -129,13 +188,19 @@ void hid_report_callback(uint8_t report_id, hid_report_type_t report_type, uint8
 {
   (void) report_id;
   (void) bufsize;
+
   // LED indicator is output report with only 1 byte length
   if ( report_type != HID_REPORT_TYPE_OUTPUT ) return;
 
   // The LED bit map is as follows: (also defined by KEYBOARD_LED_* )
   // Kana (4) | Compose (3) | ScrollLock (2) | CapsLock (1) | Numlock (0)
   uint8_t ledIndicator = buffer[0];
 
-  // turn on LED if caplock is set
+  // turn on LED if capslock is set
   digitalWrite(LED_BUILTIN, ledIndicator & KEYBOARD_LED_CAPSLOCK);
+
+#ifdef PIN_NEOPIXEL
+  pixels.fill(ledIndicator & KEYBOARD_LED_CAPSLOCK ? 0xff0000 : 0x000000);
+  pixels.show();
+#endif
 }