Initial commit of a more generic hardware test mode

Signed-off-by: Jesse Vincent <jesse@keyboard.io>

src/Kaleidoscope-HardwareTestMode.h

@@ -0,0 +1,19 @@
+/* Kaleidoscope-Hardware-TestMode - A factory test mode for the Model 01.
+ * Copyright (C) 2017-2019  Keyboard.io, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "kaleidoscope/plugin/HardwareTestMode.h"

src/kaleidoscope/plugin/HardwareTestMode.cpp

@@ -0,0 +1,129 @@
+/* Kaleidoscope-HardwareTestMode - A factory test mode for the Model 01.
+ * Copyright (C) 2017-2019  Keyboard.io, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Kaleidoscope.h"
+#include "Kaleidoscope-HardwareTestMode.h"
+#include "Kaleidoscope-LEDEffect-Rainbow.h"
+
+namespace kaleidoscope {
+namespace plugin {
+
+
+constexpr uint8_t CHATTER_CYCLE_LIMIT = 30;
+
+uint8_t HardwareTestMode::actionKey;
+
+void HardwareTestMode::setActionKey(uint8_t key) {
+  actionKey = key; 
+}
+
+void HardwareTestMode::waitForKeypress() {
+  while (1) {
+    KeyboardHardware.readMatrix();
+    if (KeyboardHardware.isKeyswitchPressed(actionKey) && 
+	! KeyboardHardware.wasKeyswitchPressed(actionKey)) {
+      break;
+    }
+  }
+}
+
+void HardwareTestMode::setLeds(cRGB color) {
+  ::LEDControl.set_all_leds_to(color);
+  ::LEDControl.syncLeds();
+  waitForKeypress();
+}
+
+void HardwareTestMode::testLeds(void) {
+  constexpr cRGB red = CRGB(201, 0, 0);
+  constexpr cRGB blue = CRGB(0, 0, 201);
+  constexpr cRGB green = CRGB(0, 201, 0);
+  constexpr cRGB brightWhite = CRGB(160, 160, 160);
+
+  setLeds(brightWhite);
+  setLeds(blue);
+  setLeds(green);
+  setLeds(red);
+  // rainbow for 10 seconds
+  ::LEDRainbowEffect.update_delay(5);
+  for (auto i = 0; i < 300; i++) {
+    ::LEDRainbowEffect.update();
+    ::LEDControl.syncLeds();
+  }
+}
+
+
+
+void HardwareTestMode::testMatrix() {
+  // Reset bad keys from previous tests.
+  chatter_data state[KeyboardHardware.matrix_columns * KeyboardHardware.matrix_rows] = {0,0,0};
+
+  constexpr cRGB red = CRGB(201, 0, 0);
+  constexpr cRGB blue = CRGB(0, 0, 201);
+  constexpr cRGB green = CRGB(0, 201, 0);
+  constexpr cRGB yellow = CRGB(201, 100, 0);
+
+  while (1) {
+    KeyboardHardware.readMatrix();
+    for (byte row = 0; row < KeyboardHardware.matrix_rows; row++) {
+      for (byte col = 0; col < KeyboardHardware.matrix_columns; col++) {
+        uint8_t keynum = (row * KeyboardHardware.matrix_columns) + (col);
+
+	// If the key is toggled on
+        if (KeyboardHardware.isKeyswitchPressed(row, col) && ! KeyboardHardware.wasKeyswitchPressed(row, col)) {
+          // And it's too soon (in terms of cycles between changes)
+	  state[keynum].tested = 1;
+          if (state[keynum].cyclesSinceStateChange < CHATTER_CYCLE_LIMIT) {
+            state[keynum].bad = 1;
+          }
+          state[keynum].cyclesSinceStateChange = 0;
+        } else if (state[keynum].cyclesSinceStateChange < CHATTER_CYCLE_LIMIT) {
+          state[keynum].cyclesSinceStateChange++;
+        }
+        // If the key is held down
+        if (KeyboardHardware.isKeyswitchPressed(row, col) && KeyboardHardware.wasKeyswitchPressed(row, col)) {
+          KeyboardHardware.setCrgbAt(row, col, green);
+        } 
+
+        // If we triggered chatter detection ever on this key
+	else if (state[keynum].bad == 1) {
+          KeyboardHardware.setCrgbAt(row, col, red);
+        } else if (state[keynum].tested == 0) {
+	 KeyboardHardware.setCrgbAt(row,col,yellow);
+	}
+        // If the key is not currently pressed and was not just released and is not marked bad
+        else if ( ! KeyboardHardware.isKeyswitchPressed(row, col)) {
+          KeyboardHardware.setCrgbAt(row, col, blue);
+	}
+      }
+    }
+    ::LEDControl.syncLeds();
+  }
+}
+
+void HardwareTestMode::runTests() {
+  // When we start test mode, we -may- have some keys held, so empty it
+  // out and send a new report
+  kaleidoscope::hid::releaseAllKeys();
+  kaleidoscope::hid::sendKeyboardReport();
+  KeyboardHardware.enableHardwareTestMode();
+  testLeds();
+  testMatrix();
+}
+
+}
+}
+
+kaleidoscope::plugin::HardwareTestMode HardwareTestMode;

src/kaleidoscope/plugin/HardwareTestMode.h

@@ -0,0 +1,49 @@
+/* Kaleidoscope-HardwareTestMode - A factory test mode for the Model 01.
+ * Copyright (C) 2017-2019  Keyboard.io, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <Arduino.h>
+#include "Kaleidoscope.h"
+
+namespace kaleidoscope {
+namespace plugin {
+
+class HardwareTestMode : public kaleidoscope::Plugin {
+ public:
+
+  typedef struct {
+    uint8_t bad : 1,
+            tested : 1,
+            cyclesSinceStateChange: 6;
+  } chatter_data;
+  static uint8_t actionKey;
+
+  HardwareTestMode(void) {}
+
+  static void runTests();
+  static void setActionKey(uint8_t key);
+ private:
+  static void testLeds();
+  static void testMatrix();
+  static void toggleProgrammingLedsOn();
+  static void waitForKeypress();
+  static void setLeds(cRGB color);
+};
+}
+}
+
+extern kaleidoscope::plugin::HardwareTestMode HardwareTestMode;