Merge pull request #20 from keyboardio/bug/numlock-sync-report-spam

Bug/numlock sync report spam

src/Kaleidoscope-NumPad.cpp

@@ -19,49 +19,46 @@
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-byte NumPad_::row = 255, NumPad_::col = 255;
+byte NumPad_::numpadLayerToggleKeyRow = 255, NumPad_::numpadLayerToggleKeyCol = 255;
 uint8_t NumPad_::numPadLayer;
-bool NumPad_::cleanupDone = true;
+bool NumPad_::numlockUnsynced = false;
 bool NumPad_::originalNumLockState = false;
 cRGB NumPad_::color = CRGB(160, 0, 0);
 uint8_t NumPad_::lock_hue = 170;
 
 kaleidoscope::EventHandlerResult NumPad_::onSetup(void) {
-  originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+  originalNumLockState = getNumlockState();
   return kaleidoscope::EventHandlerResult::OK;
 }
 
-static bool getNumlockState() {
+bool NumPad_::getNumlockState() {
   return !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
 }
 
-static void syncNumlock(bool state) {
+void NumPad_::syncNumlockState(bool state) {
-  bool numState = getNumlockState();
+  bool numLockLEDState = getNumlockState();
-  if (numState != state) {
+  if (numLockLEDState != state) {
     kaleidoscope::hid::pressKey(Key_KeypadNumLock);
   }
 }
 
-kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
-  if (!Layer.isOn(numPadLayer)) {
-    bool numState = getNumlockState();
-    if (!cleanupDone) {
-      LEDControl.set_mode(LEDControl.get_mode_index());
 
-      if (!originalNumLockState) {
-        syncNumlock(false);
-        numState = false;
-      }
-      cleanupDone = true;
-    }
-    originalNumLockState = numState;
 
-    return kaleidoscope::EventHandlerResult::OK;
+void NumPad_::cleanupNumlockState() {
+  if (!numlockUnsynced) {
+    bool numLockLEDState = getNumlockState();
+    LEDControl.set_mode(LEDControl.get_mode_index());
+    if (!originalNumLockState) {
+      syncNumlockState(false);
+      numLockLEDState = false;
+    }
+    originalNumLockState = numLockLEDState;
+    numlockUnsynced = true;
   }
 
-  cleanupDone = false;
+}
-  syncNumlock(true);
 
+void NumPad_::setKeyboardLEDColors(void) {
   LEDControl.set_mode(LEDControl.get_mode_index());
 
   for (uint8_t r = 0; r < ROWS; r++) {
@@ -70,8 +67,8 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
       if (k == LockLayer(numPadLayer)) {
-        row  = r;
+        numpadLayerToggleKeyRow = r;
-        col = c;
+        numpadLayerToggleKeyCol = c;
       }
 
       if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
@@ -82,13 +79,28 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
     }
   }
 
-  if (row > ROWS || col > COLS)
+  if ((numpadLayerToggleKeyRow <= ROWS) && (numpadLayerToggleKeyCol <= COLS)) {
-    return kaleidoscope::EventHandlerResult::OK;
 
-  cRGB lock_color = breath_compute(lock_hue);
-  LEDControl.setCrgbAt(row, col, lock_color);
 
+    cRGB lock_color = breath_compute(lock_hue);
+    LEDControl.setCrgbAt(numpadLayerToggleKeyRow, numpadLayerToggleKeyCol, lock_color);
+  }
+}
+
+kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
+  if (!Layer.isOn(numPadLayer)) {
+    cleanupNumlockState();
+  } else {
+    if (numlockUnsynced)  {
+      // If it's the first time we're in this loop after toggling the Numpad mode on
+      syncNumlockState(true);
+      numlockUnsynced = false;
+    }
+    setKeyboardLEDColors();
+  }
   return kaleidoscope::EventHandlerResult::OK;
 }
 
+
+
 NumPad_ NumPad;

src/Kaleidoscope-NumPad.h

@@ -32,8 +32,15 @@ class NumPad_ : public kaleidoscope::Plugin {
   kaleidoscope::EventHandlerResult afterEachCycle();
 
  private:
-  static byte row, col;
+
-  static bool cleanupDone;
+  void cleanupNumlockState(void);
+  void setKeyboardLEDColors(void);
+  bool getNumlockState(void);
+  void syncNumlockState(bool);
+
+  static uint8_t numpadLayerToggleKeyRow;
+  static uint8_t numpadLayerToggleKeyCol;
+  static bool numlockUnsynced;
   static bool originalNumLockState;
 };