From 5df5b209d7f11c885e2946889d0a7deb805ad550 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Fri, 27 Jan 2017 11:11:51 +0100
Subject: [PATCH 01/60] Lifted out from Keyboardio-LEDControl

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 COPYING                              | 339 +++++++++++++++++++++++++++
 README.md                            |   6 +
 library.properties                   |  10 +
 src/Keyboardio-LEDEffect-Numlock.cpp |  56 +++++
 src/Keyboardio-LEDEffect-Numlock.h   |  17 ++
 5 files changed, 428 insertions(+)
 create mode 100644 COPYING
 create mode 100644 README.md
 create mode 100644 library.properties
 create mode 100644 src/Keyboardio-LEDEffect-Numlock.cpp
 create mode 100644 src/Keyboardio-LEDEffect-Numlock.h

diff --git a/COPYING b/COPYING
new file mode 100644
index 00000000..d159169d
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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; either version 2 of the License, or
+    (at your option) any later version.
+
+    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, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..971fd4f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# Keyboardio-LEDEffect-Numlock
+
+This is a plugin for [KeyboardioFirmware][fw], adding an LED effect for when
+Num-lock is active.
+
+ [fw]: https://github.com/keyboardio/KeyboardioFirmware
diff --git a/library.properties b/library.properties
new file mode 100644
index 00000000..2618caee
--- /dev/null
+++ b/library.properties
@@ -0,0 +1,10 @@
+name=Keyboardio-LEDEffect-Numlock
+version=0.0.1
+author=Jesse Vincent
+maintainer=Jesse Vincent <jesse@keyboard.io>
+sentence=Special LED effect for when Numlock is pressed on Keyboardio boards.
+paragraph=...
+category=Communication
+url=https://github.com/keyboardio/Keyboardio-LEDEffect-Numlock
+architectures=avr
+dot_a_linkage=true
diff --git a/src/Keyboardio-LEDEffect-Numlock.cpp b/src/Keyboardio-LEDEffect-Numlock.cpp
new file mode 100644
index 00000000..0b707eb1
--- /dev/null
+++ b/src/Keyboardio-LEDEffect-Numlock.cpp
@@ -0,0 +1,56 @@
+#include "Keyboardio-LEDEffect-Numlock.h"
+#include "LEDUtils.h"
+#include "KeyboardioFirmware.h"
+#include "layers.h"
+
+static uint8_t numpadIndex;
+static uint8_t storedLEDMode;
+static uint8_t us;
+
+LEDNumlock::LEDNumlock (uint8_t numpadIdx) {
+    numpadIndex = numpadIdx;
+}
+
+void
+LEDNumlock::begin (void) {
+  us = LEDControl.mode_add (this);
+  loop_hook_add (this->loopHook);
+}
+
+void
+LEDNumlock::setup (void) {
+    if (!Layer.isOn (numpadIndex)) {
+        LEDControl.next_mode ();
+    }
+}
+
+void
+LEDNumlock::update (void) {
+    for (uint8_t i = 0; i < 44; i++) {
+        LEDControl.led_set_crgb_at(i, {0, 0, 0});
+    }
+    for (uint8_t i = 44; i < LED_COUNT; i++) {
+        LEDControl.led_set_crgb_at(i, {255, 0, 0});
+    }
+
+    cRGB color = breath_compute ();
+    LEDControl.led_set_crgb_at (60, color);
+}
+
+void
+LEDNumlock::loopHook (bool postClear) {
+    if (!postClear)
+        return;
+
+    if (Layer.isOn (numpadIndex)) {
+        if (storedLEDMode != us) {
+            storedLEDMode = LEDControl.get_mode ();
+        }
+        LEDControl.set_mode (us);
+    }
+
+    if (!Layer.isOn (numpadIndex) &&
+            LEDControl.get_mode () == us) {
+        LEDControl.set_mode (storedLEDMode);
+    }
+}
diff --git a/src/Keyboardio-LEDEffect-Numlock.h b/src/Keyboardio-LEDEffect-Numlock.h
new file mode 100644
index 00000000..14521096
--- /dev/null
+++ b/src/Keyboardio-LEDEffect-Numlock.h
@@ -0,0 +1,17 @@
+#pragma once
+
+#include "Keyboardio-LEDControl.h"
+#include "LEDUtils.h"
+
+class LEDNumlock : LEDMode {
+ public:
+  LEDNumlock (uint8_t numpadIndex);
+
+  virtual void begin (void) final;
+
+  virtual void update (void) final;
+  virtual void setup (void) final;
+
+ private:
+  static void loopHook (bool postClear);
+};

From ed92d5109c64574b42d3a4ec6d3dfbc0ebed0ced Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Fri, 27 Jan 2017 12:00:53 +0100
Subject: [PATCH 02/60] Fix the LED mode handling

First of all, to disallow switching to LEDNumlock, we need to do the check in
the `.init()` method, not in `.setup()`. Second, tracking the previous LED mode
can be done a lot simpler - and a lot reliably.

With these changes, the NumLock LED effect works as it is expected to.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Keyboardio-LEDEffect-Numlock.cpp | 16 ++++++----------
 src/Keyboardio-LEDEffect-Numlock.h   |  2 +-
 2 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/src/Keyboardio-LEDEffect-Numlock.cpp b/src/Keyboardio-LEDEffect-Numlock.cpp
index 0b707eb1..6468fd78 100644
--- a/src/Keyboardio-LEDEffect-Numlock.cpp
+++ b/src/Keyboardio-LEDEffect-Numlock.cpp
@@ -18,9 +18,9 @@ LEDNumlock::begin (void) {
 }
 
 void
-LEDNumlock::setup (void) {
+LEDNumlock::init (void) {
     if (!Layer.isOn (numpadIndex)) {
-        LEDControl.next_mode ();
+        LEDControl.next_mode();
     }
 }
 
@@ -42,15 +42,11 @@ LEDNumlock::loopHook (bool postClear) {
     if (!postClear)
         return;
 
-    if (Layer.isOn (numpadIndex)) {
-        if (storedLEDMode != us) {
+    if (!Layer.isOn (numpadIndex)) {
+        if (LEDControl.get_mode () != us)
             storedLEDMode = LEDControl.get_mode ();
-        }
-        LEDControl.set_mode (us);
-    }
-
-    if (!Layer.isOn (numpadIndex) &&
-            LEDControl.get_mode () == us) {
         LEDControl.set_mode (storedLEDMode);
+    } else {
+        LEDControl.set_mode (us);
     }
 }
diff --git a/src/Keyboardio-LEDEffect-Numlock.h b/src/Keyboardio-LEDEffect-Numlock.h
index 14521096..46ea71d7 100644
--- a/src/Keyboardio-LEDEffect-Numlock.h
+++ b/src/Keyboardio-LEDEffect-Numlock.h
@@ -10,7 +10,7 @@ class LEDNumlock : LEDMode {
   virtual void begin (void) final;
 
   virtual void update (void) final;
-  virtual void setup (void) final;
+  virtual void init (void) final;
 
  private:
   static void loopHook (bool postClear);

From 975cd0bf045b3872fde47724518cc71f43bd0de5 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Fri, 27 Jan 2017 23:09:19 +0100
Subject: [PATCH 03/60] Use the new, double-add protected hook functions

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Keyboardio-LEDEffect-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Keyboardio-LEDEffect-Numlock.cpp b/src/Keyboardio-LEDEffect-Numlock.cpp
index 6468fd78..2f8f9759 100644
--- a/src/Keyboardio-LEDEffect-Numlock.cpp
+++ b/src/Keyboardio-LEDEffect-Numlock.cpp
@@ -14,7 +14,7 @@ LEDNumlock::LEDNumlock (uint8_t numpadIdx) {
 void
 LEDNumlock::begin (void) {
   us = LEDControl.mode_add (this);
-  loop_hook_add (this->loopHook);
+  loop_hook_use (this->loopHook);
 }
 
 void

From 051778048dcec8e7ae000a3febb70b29c9724826 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sat, 28 Jan 2017 14:37:15 +0100
Subject: [PATCH 04/60] Turn the plugin into a macro

The expected usage is now calling `NumLock.toggle(row, col, layer)` from within
a macro.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Keyboardio-LEDEffect-Numlock.cpp | 65 +++++++++++++++++-----------
 src/Keyboardio-LEDEffect-Numlock.h   | 14 ++++--
 2 files changed, 50 insertions(+), 29 deletions(-)

diff --git a/src/Keyboardio-LEDEffect-Numlock.cpp b/src/Keyboardio-LEDEffect-Numlock.cpp
index 2f8f9759..d80a6d86 100644
--- a/src/Keyboardio-LEDEffect-Numlock.cpp
+++ b/src/Keyboardio-LEDEffect-Numlock.cpp
@@ -3,50 +3,63 @@
 #include "KeyboardioFirmware.h"
 #include "layers.h"
 
-static uint8_t numpadIndex;
-static uint8_t storedLEDMode;
-static uint8_t us;
+uint8_t NumLock_::previousLEDMode;
+uint8_t NumLock_::us;
+bool NumLock_::isActive;
+byte NumLock_::row = 255, NumLock_::col = 255;
 
-LEDNumlock::LEDNumlock (uint8_t numpadIdx) {
-    numpadIndex = numpadIdx;
+NumLock_::NumLock_ (void) {
 }
 
 void
-LEDNumlock::begin (void) {
-  us = LEDControl.mode_add (this);
-  loop_hook_use (this->loopHook);
+NumLock_::begin (void) {
+    us = LEDControl.mode_add (this);
 }
 
 void
-LEDNumlock::init (void) {
-    if (!Layer.isOn (numpadIndex)) {
+NumLock_::init (void) {
+    if (!isActive) {
         LEDControl.next_mode();
     }
 }
 
 void
-LEDNumlock::update (void) {
-    for (uint8_t i = 0; i < 44; i++) {
-        LEDControl.led_set_crgb_at(i, {0, 0, 0});
-    }
-    for (uint8_t i = 44; i < LED_COUNT; i++) {
-        LEDControl.led_set_crgb_at(i, {255, 0, 0});
+NumLock_::update (void) {
+    for (uint8_t r = 0; r < ROWS; r++) {
+        for (uint8_t c = 0; c < COLS; c++) {
+            Key k = Layer.lookup (r, c);
+
+            if (k.raw < Key_NumLock.raw || k.raw > Key_KeypadDot.raw)
+                continue;
+
+            LEDControl.led_set_crgb_at(r, c, {255, 0, 0});
+        }
     }
 
-    cRGB color = breath_compute ();
-    LEDControl.led_set_crgb_at (60, color);
+    if (row > ROWS || col > COLS)
+        return;
+
+    cRGB color = breath_compute();
+    LEDControl.led_set_crgb_at (row, col, color);
 }
 
-void
-LEDNumlock::loopHook (bool postClear) {
-    if (!postClear)
-        return;
+const macro_t *
+NumLock_::toggle (byte row_, byte col_, uint8_t numPadLayer) {
+    row = row_;
+    col = col_;
 
-    if (!Layer.isOn (numpadIndex)) {
-        if (LEDControl.get_mode () != us)
-            storedLEDMode = LEDControl.get_mode ();
-        LEDControl.set_mode (storedLEDMode);
+    if (Layer.isOn (numPadLayer)) {
+        isActive = false;
+        LEDControl.set_mode (previousLEDMode);
+        Layer.off (numPadLayer);
     } else {
+        isActive = true;
+        previousLEDMode = LEDControl.get_mode ();
         LEDControl.set_mode (us);
+        Layer.on (numPadLayer);
     }
+
+    return MACRO(T(NumLock), END);
 }
+
+NumLock_ NumLock;
diff --git a/src/Keyboardio-LEDEffect-Numlock.h b/src/Keyboardio-LEDEffect-Numlock.h
index 46ea71d7..b6af6d55 100644
--- a/src/Keyboardio-LEDEffect-Numlock.h
+++ b/src/Keyboardio-LEDEffect-Numlock.h
@@ -1,17 +1,25 @@
 #pragma once
 
 #include "Keyboardio-LEDControl.h"
+#include "Keyboardio-Macros.h"
 #include "LEDUtils.h"
 
-class LEDNumlock : LEDMode {
+class NumLock_ : LEDMode {
  public:
-  LEDNumlock (uint8_t numpadIndex);
+  NumLock_ (void);
 
   virtual void begin (void) final;
 
   virtual void update (void) final;
   virtual void init (void) final;
 
+  static const macro_t *toggle (byte row, byte col, uint8_t numPadLayer);
+
  private:
-  static void loopHook (bool postClear);
+  static uint8_t previousLEDMode;
+  static uint8_t us;
+  static bool isActive;
+  static byte row, col;
 };
+
+extern NumLock_ NumLock;

From 17046f281e9000a6b6ac5be49c8181f18992aea7 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 29 Jan 2017 08:23:12 +0100
Subject: [PATCH 05/60] Introduce two helper macros

`TOGGLENUMLOCK` is the index of the macro, to be used in the `macroAction`
function, and `Key_ToggleNumlock` is to be used in the keymap, instead of
`M(0)`. This is considerably friendlier than before.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Keyboardio-LEDEffect-Numlock.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/Keyboardio-LEDEffect-Numlock.h b/src/Keyboardio-LEDEffect-Numlock.h
index b6af6d55..8a71f8fc 100644
--- a/src/Keyboardio-LEDEffect-Numlock.h
+++ b/src/Keyboardio-LEDEffect-Numlock.h
@@ -4,6 +4,9 @@
 #include "Keyboardio-Macros.h"
 #include "LEDUtils.h"
 
+#define TOGGLENUMLOCK 0
+#define Key_ToggleNumlock M(TOGGLENUMLOCK)
+
 class NumLock_ : LEDMode {
  public:
   NumLock_ (void);

From 89b92927e4be8154076c62164a6f25653674df63 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Mon, 30 Jan 2017 23:22:19 +0100
Subject: [PATCH 06/60] Rename to Keyboardio-Numlock

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 README.md                                                   | 6 +++---
 library.properties                                          | 6 +++---
 ...boardio-LEDEffect-Numlock.cpp => Keyboardio-Numlock.cpp} | 2 +-
 ...{Keyboardio-LEDEffect-Numlock.h => Keyboardio-Numlock.h} | 0
 4 files changed, 7 insertions(+), 7 deletions(-)
 rename src/{Keyboardio-LEDEffect-Numlock.cpp => Keyboardio-Numlock.cpp} (96%)
 rename src/{Keyboardio-LEDEffect-Numlock.h => Keyboardio-Numlock.h} (100%)

diff --git a/README.md b/README.md
index 971fd4f3..9c121ae8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Keyboardio-LEDEffect-Numlock
+# Keyboardio-Numlock
 
-This is a plugin for [KeyboardioFirmware][fw], adding an LED effect for when
-Num-lock is active.
+This is a plugin for [KeyboardioFirmware][fw], that adds a NumLock-specific LED
+effect, along with a way to toggle to a numpad layer, and apply the effect.
 
  [fw]: https://github.com/keyboardio/KeyboardioFirmware
diff --git a/library.properties b/library.properties
index 2618caee..d2d6d175 100644
--- a/library.properties
+++ b/library.properties
@@ -1,10 +1,10 @@
-name=Keyboardio-LEDEffect-Numlock
+name=Keyboardio-Numlock
 version=0.0.1
 author=Jesse Vincent
 maintainer=Jesse Vincent <jesse@keyboard.io>
-sentence=Special LED effect for when Numlock is pressed on Keyboardio boards.
+sentence=A Numlock plugin for KeyboardioFirmware.
 paragraph=...
 category=Communication
-url=https://github.com/keyboardio/Keyboardio-LEDEffect-Numlock
+url=https://github.com/keyboardio/Keyboardio-Numlock
 architectures=avr
 dot_a_linkage=true
diff --git a/src/Keyboardio-LEDEffect-Numlock.cpp b/src/Keyboardio-Numlock.cpp
similarity index 96%
rename from src/Keyboardio-LEDEffect-Numlock.cpp
rename to src/Keyboardio-Numlock.cpp
index d80a6d86..ed216fee 100644
--- a/src/Keyboardio-LEDEffect-Numlock.cpp
+++ b/src/Keyboardio-Numlock.cpp
@@ -1,4 +1,4 @@
-#include "Keyboardio-LEDEffect-Numlock.h"
+#include "Keyboardio-Numlock.h"
 #include "LEDUtils.h"
 #include "KeyboardioFirmware.h"
 #include "layers.h"
diff --git a/src/Keyboardio-LEDEffect-Numlock.h b/src/Keyboardio-Numlock.h
similarity index 100%
rename from src/Keyboardio-LEDEffect-Numlock.h
rename to src/Keyboardio-Numlock.h

From 5fe8ff28cb7fb928fbff893aa07c8f9fefdf7394 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sat, 11 Feb 2017 23:41:39 +0100
Subject: [PATCH 07/60] The Big Rename

Renamed the library to Kaleidoscope-Numlock, and followed up with other renames.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 README.md                                                | 6 +++---
 library.properties                                       | 6 +++---
 src/{Keyboardio-Numlock.cpp => Kaleidoscope-Numlock.cpp} | 4 ++--
 src/{Keyboardio-Numlock.h => Kaleidoscope-Numlock.h}     | 4 ++--
 4 files changed, 10 insertions(+), 10 deletions(-)
 rename src/{Keyboardio-Numlock.cpp => Kaleidoscope-Numlock.cpp} (95%)
 rename src/{Keyboardio-Numlock.h => Kaleidoscope-Numlock.h} (87%)

diff --git a/README.md b/README.md
index 9c121ae8..b8173982 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Keyboardio-Numlock
+# Kaleidoscope-Numlock
 
-This is a plugin for [KeyboardioFirmware][fw], that adds a NumLock-specific LED
+This is a plugin for [Kaleidoscope][fw], that adds a NumLock-specific LED
 effect, along with a way to toggle to a numpad layer, and apply the effect.
 
- [fw]: https://github.com/keyboardio/KeyboardioFirmware
+ [fw]: https://github.com/keyboardio/Kaleidoscope
diff --git a/library.properties b/library.properties
index d2d6d175..8db57a28 100644
--- a/library.properties
+++ b/library.properties
@@ -1,10 +1,10 @@
-name=Keyboardio-Numlock
+name=Kaleidoscope-Numlock
 version=0.0.1
 author=Jesse Vincent
 maintainer=Jesse Vincent <jesse@keyboard.io>
-sentence=A Numlock plugin for KeyboardioFirmware.
+sentence=A Numlock plugin for Kaleidoscope.
 paragraph=...
 category=Communication
-url=https://github.com/keyboardio/Keyboardio-Numlock
+url=https://github.com/keyboardio/Kaleidoscope-Numlock
 architectures=avr
 dot_a_linkage=true
diff --git a/src/Keyboardio-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
similarity index 95%
rename from src/Keyboardio-Numlock.cpp
rename to src/Kaleidoscope-Numlock.cpp
index ed216fee..e25b7494 100644
--- a/src/Keyboardio-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -1,6 +1,6 @@
-#include "Keyboardio-Numlock.h"
+#include "Kaleidoscope-Numlock.h"
 #include "LEDUtils.h"
-#include "KeyboardioFirmware.h"
+#include "Kaleidoscope.h"
 #include "layers.h"
 
 uint8_t NumLock_::previousLEDMode;
diff --git a/src/Keyboardio-Numlock.h b/src/Kaleidoscope-Numlock.h
similarity index 87%
rename from src/Keyboardio-Numlock.h
rename to src/Kaleidoscope-Numlock.h
index 8a71f8fc..52fab4cd 100644
--- a/src/Keyboardio-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -1,7 +1,7 @@
 #pragma once
 
-#include "Keyboardio-LEDControl.h"
-#include "Keyboardio-Macros.h"
+#include "Kaleidoscope-LEDControl.h"
+#include "Kaleidoscope-Macros.h"
 #include "LEDUtils.h"
 
 #define TOGGLENUMLOCK 0

From f2773e144430b06d753758a72fc580128ddf8c84 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Wed, 22 Feb 2017 00:16:38 +0100
Subject: [PATCH 08/60] Mark the class a descendant of public LEDMode

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index 52fab4cd..b118f411 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -7,7 +7,7 @@
 #define TOGGLENUMLOCK 0
 #define Key_ToggleNumlock M(TOGGLENUMLOCK)
 
-class NumLock_ : LEDMode {
+class NumLock_ : public LEDMode {
  public:
   NumLock_ (void);
 

From 2fbeb322d8c047c95b73641e122f4ccd538c73fc Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 20 Mar 2017 16:20:30 -0700
Subject: [PATCH 09/60] Switch from a hardcoded structure that's in BGR order
 to using a cRGB and getting our color (red) correct

---
 src/Kaleidoscope-Numlock.cpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index e25b7494..253cee89 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -7,6 +7,8 @@ uint8_t NumLock_::previousLEDMode;
 uint8_t NumLock_::us;
 bool NumLock_::isActive;
 byte NumLock_::row = 255, NumLock_::col = 255;
+cRGB numpad_color;
+
 
 NumLock_::NumLock_ (void) {
 }
@@ -14,6 +16,7 @@ NumLock_::NumLock_ (void) {
 void
 NumLock_::begin (void) {
     us = LEDControl.mode_add (this);
+    numpad_color.r=255;
 }
 
 void
@@ -32,7 +35,7 @@ NumLock_::update (void) {
             if (k.raw < Key_NumLock.raw || k.raw > Key_KeypadDot.raw)
                 continue;
 
-            LEDControl.led_set_crgb_at(r, c, {255, 0, 0});
+            LEDControl.led_set_crgb_at(r, c, numpad_color);
         }
     }
 

From ca71ff2c759ed4e3655067b80c8b6eb198b3deee Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sun, 21 May 2017 21:57:35 -0700
Subject: [PATCH 10/60] Fix  the name of the numlock key

---
 src/Kaleidoscope-Numlock.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 253cee89..fc4e8393 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -32,7 +32,7 @@ NumLock_::update (void) {
         for (uint8_t c = 0; c < COLS; c++) {
             Key k = Layer.lookup (r, c);
 
-            if (k.raw < Key_NumLock.raw || k.raw > Key_KeypadDot.raw)
+            if (k.raw < Key_KeypadNumLock.raw || k.raw > Key_KeypadDot.raw)
                 continue;
 
             LEDControl.led_set_crgb_at(r, c, numpad_color);
@@ -62,7 +62,7 @@ NumLock_::toggle (byte row_, byte col_, uint8_t numPadLayer) {
         Layer.on (numPadLayer);
     }
 
-    return MACRO(T(NumLock), END);
+    return MACRO(T(KeypadNumLock), END);
 }
 
 NumLock_ NumLock;

From 18fe127ac2be3678bef18d2e2dc6580456fed2dc Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 3 Jun 2017 22:46:56 -0700
Subject: [PATCH 11/60] astyle with current project style guidelines

---
 src/Kaleidoscope-Numlock.cpp | 68 ++++++++++++++++++------------------
 src/Kaleidoscope-Numlock.h   | 10 +++---
 2 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index fc4e8393..15fe07a8 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -10,59 +10,59 @@ byte NumLock_::row = 255, NumLock_::col = 255;
 cRGB numpad_color;
 
 
-NumLock_::NumLock_ (void) {
+NumLock_::NumLock_(void) {
 }
 
 void
-NumLock_::begin (void) {
-    us = LEDControl.mode_add (this);
-    numpad_color.r=255;
+NumLock_::begin(void) {
+  us = LEDControl.mode_add(this);
+  numpad_color.r=255;
 }
 
 void
-NumLock_::init (void) {
-    if (!isActive) {
-        LEDControl.next_mode();
-    }
+NumLock_::init(void) {
+  if (!isActive) {
+    LEDControl.next_mode();
+  }
 }
 
 void
-NumLock_::update (void) {
-    for (uint8_t r = 0; r < ROWS; r++) {
-        for (uint8_t c = 0; c < COLS; c++) {
-            Key k = Layer.lookup (r, c);
+NumLock_::update(void) {
+  for (uint8_t r = 0; r < ROWS; r++) {
+    for (uint8_t c = 0; c < COLS; c++) {
+      Key k = Layer.lookup(r, c);
 
-            if (k.raw < Key_KeypadNumLock.raw || k.raw > Key_KeypadDot.raw)
-                continue;
+      if (k.raw < Key_KeypadNumLock.raw || k.raw > Key_KeypadDot.raw)
+        continue;
 
-            LEDControl.led_set_crgb_at(r, c, numpad_color);
-        }
+      LEDControl.led_set_crgb_at(r, c, numpad_color);
     }
+  }
 
-    if (row > ROWS || col > COLS)
-        return;
+  if (row > ROWS || col > COLS)
+    return;
 
-    cRGB color = breath_compute();
-    LEDControl.led_set_crgb_at (row, col, color);
+  cRGB color = breath_compute();
+  LEDControl.led_set_crgb_at(row, col, color);
 }
 
 const macro_t *
-NumLock_::toggle (byte row_, byte col_, uint8_t numPadLayer) {
-    row = row_;
-    col = col_;
+NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
+  row = row_;
+  col = col_;
 
-    if (Layer.isOn (numPadLayer)) {
-        isActive = false;
-        LEDControl.set_mode (previousLEDMode);
-        Layer.off (numPadLayer);
-    } else {
-        isActive = true;
-        previousLEDMode = LEDControl.get_mode ();
-        LEDControl.set_mode (us);
-        Layer.on (numPadLayer);
-    }
+  if (Layer.isOn(numPadLayer)) {
+    isActive = false;
+    LEDControl.set_mode(previousLEDMode);
+    Layer.off(numPadLayer);
+  } else {
+    isActive = true;
+    previousLEDMode = LEDControl.get_mode();
+    LEDControl.set_mode(us);
+    Layer.on(numPadLayer);
+  }
 
-    return MACRO(T(KeypadNumLock), END);
+  return MACRO(T(KeypadNumLock), END);
 }
 
 NumLock_ NumLock;
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index b118f411..3dc27052 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -9,14 +9,14 @@
 
 class NumLock_ : public LEDMode {
  public:
-  NumLock_ (void);
+  NumLock_(void);
 
-  virtual void begin (void) final;
+  virtual void begin(void) final;
 
-  virtual void update (void) final;
-  virtual void init (void) final;
+  virtual void update(void) final;
+  virtual void init(void) final;
 
-  static const macro_t *toggle (byte row, byte col, uint8_t numPadLayer);
+  static const macro_t *toggle(byte row, byte col, uint8_t numPadLayer);
 
  private:
   static uint8_t previousLEDMode;

From b04570b9dd5d1bb2fa6e32fd506cd5e39f84df7e Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 3 Jun 2017 23:20:06 -0700
Subject: [PATCH 12/60] Add build infrastructure

---
 .travis.yml | 21 +++++++++++++++++++++
 Makefile    | 12 ++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 .travis.yml
 create mode 100644 Makefile

diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 00000000..e7030acf
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,21 @@
+dist: trusty
+sudo: false
+os:
+  - linux
+install:
+  - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr
+script:
+  - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
+notifications:
+  irc:
+    channels:
+      - "chat.freenode.net#keyboardio"
+    use_notice: true
+    skip_join: true
+    template:
+      - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" 
+  email:
+    on_success: change
+    on_failure: change
+cache:
+  ccache: true
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..9ce0c4a9
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,12 @@
+# This stub makefile for a Kaleidoscope plugin pulls in 
+# all targets from the Kaleidoscope-Plugin library
+
+MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build
+UNAME_S := $(shell uname -s)
+
+BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware
+ifeq ($(UNAME_S),Darwin)
+BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware
+endif
+
+include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk

From 42c833c81a271ce4ce7064ac9302b02658dc815a Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 3 Jun 2017 23:24:52 -0700
Subject: [PATCH 13/60] linter cleanup

---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 src/Kaleidoscope-Numlock.h   | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 15fe07a8..1fc5ba7f 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -16,7 +16,7 @@ NumLock_::NumLock_(void) {
 void
 NumLock_::begin(void) {
   us = LEDControl.mode_add(this);
-  numpad_color.r=255;
+  numpad_color.r = 255;
 }
 
 void
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index 3dc27052..eaa448b4 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -11,10 +11,10 @@ class NumLock_ : public LEDMode {
  public:
   NumLock_(void);
 
-  virtual void begin(void) final;
+  void begin(void) final;
 
-  virtual void update(void) final;
-  virtual void init(void) final;
+  void update(void) final;
+  void init(void) final;
 
   static const macro_t *toggle(byte row, byte col, uint8_t numPadLayer);
 

From 98bf56d09734ae1a61f22fc3dc6f3168ddbc73bd Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 2 Jul 2017 18:22:01 +0200
Subject: [PATCH 14/60] Instead of acting as a strange LED mode, use a loop
 hook instead

Having the LED effects of the NumLock layer as a special LED mode has a number
of drawbacks, like not interacting well with led mode switching: one can't get
back to the NumLock effect once switching away from it (but the mode remains
active nevertheless).

To avoid this and other issues, don't make the effect a LED mode. Instead,
override the active LED mode with the numlock layer colors. This way, it is
always in sync with the layer.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 30 ++++++++----------------------
 src/Kaleidoscope-Numlock.h   |  8 ++------
 2 files changed, 10 insertions(+), 28 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 1fc5ba7f..13bdf58c 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -3,31 +3,22 @@
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-uint8_t NumLock_::previousLEDMode;
-uint8_t NumLock_::us;
 bool NumLock_::isActive;
 byte NumLock_::row = 255, NumLock_::col = 255;
-cRGB numpad_color;
+cRGB numpad_color = CRGB(255, 0, 0);
 
 
 NumLock_::NumLock_(void) {
 }
 
-void
-NumLock_::begin(void) {
-  us = LEDControl.mode_add(this);
-  numpad_color.r = 255;
+void NumLock_::begin(void) {
+  loop_hook_use(loopHook);
 }
 
-void
-NumLock_::init(void) {
-  if (!isActive) {
-    LEDControl.next_mode();
-  }
-}
+void NumLock_::loopHook(bool postClear) {
+  if (!postClear || !isActive)
+    return;
 
-void
-NumLock_::update(void) {
   for (uint8_t r = 0; r < ROWS; r++) {
     for (uint8_t c = 0; c < COLS; c++) {
       Key k = Layer.lookup(r, c);
@@ -46,21 +37,16 @@ NumLock_::update(void) {
   LEDControl.led_set_crgb_at(row, col, color);
 }
 
-const macro_t *
-NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
+const macro_t *NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
   row = row_;
   col = col_;
 
   if (Layer.isOn(numPadLayer)) {
-    isActive = false;
-    LEDControl.set_mode(previousLEDMode);
     Layer.off(numPadLayer);
   } else {
-    isActive = true;
-    previousLEDMode = LEDControl.get_mode();
-    LEDControl.set_mode(us);
     Layer.on(numPadLayer);
   }
+  isActive = Layer.isOn(numPadLayer);
 
   return MACRO(T(KeypadNumLock), END);
 }
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index eaa448b4..47b2a77e 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -7,20 +7,16 @@
 #define TOGGLENUMLOCK 0
 #define Key_ToggleNumlock M(TOGGLENUMLOCK)
 
-class NumLock_ : public LEDMode {
+class NumLock_ : public KaleidoscopePlugin {
  public:
   NumLock_(void);
 
   void begin(void) final;
 
-  void update(void) final;
-  void init(void) final;
-
   static const macro_t *toggle(byte row, byte col, uint8_t numPadLayer);
+  static void loopHook(const bool postClear);
 
  private:
-  static uint8_t previousLEDMode;
-  static uint8_t us;
   static bool isActive;
   static byte row, col;
 };

From 40328cd34262d2779a1ab8b980901c3d15dceba7 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 2 Jul 2017 18:42:07 +0200
Subject: [PATCH 15/60] Re-init the active LED mode when NumLock is turned off

To make sure that the active LED mode is restored to a good state, re-init it.
Without this change, LED modes that do all their work in the `init()` method
will not refresh when NumLock is turned off.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 13bdf58c..e5e19f4b 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -43,6 +43,7 @@ const macro_t *NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
 
   if (Layer.isOn(numPadLayer)) {
     Layer.off(numPadLayer);
+    LEDControl.init_mode();
   } else {
     Layer.on(numPadLayer);
   }

From f2d3d91a733a10c83c4ae89c279bb942a8cf0fd9 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 2 Jul 2017 22:40:01 +0200
Subject: [PATCH 16/60] Simplify the API

Instead of requiring the NumLock key row and column, and the numpad layer index
to be passed to `NumLock.toggle` on every call, derive the first two from
Macros.row and Macros.col respectively, and the latter from a new class
variable, which should be set in the `setup()` method of the sketch.

This way, `NumLock.toggle()` becomes argument-less.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 12 +++++-------
 src/Kaleidoscope-Numlock.h   |  5 +++--
 2 files changed, 8 insertions(+), 9 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index e5e19f4b..decee6d9 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -3,11 +3,10 @@
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-bool NumLock_::isActive;
 byte NumLock_::row = 255, NumLock_::col = 255;
+uint8_t NumLock_::numPadLayer;
 cRGB numpad_color = CRGB(255, 0, 0);
 
-
 NumLock_::NumLock_(void) {
 }
 
@@ -16,7 +15,7 @@ void NumLock_::begin(void) {
 }
 
 void NumLock_::loopHook(bool postClear) {
-  if (!postClear || !isActive)
+  if (!postClear || !Layer.isOn(numPadLayer))
     return;
 
   for (uint8_t r = 0; r < ROWS; r++) {
@@ -37,9 +36,9 @@ void NumLock_::loopHook(bool postClear) {
   LEDControl.led_set_crgb_at(row, col, color);
 }
 
-const macro_t *NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
-  row = row_;
-  col = col_;
+const macro_t *NumLock_::toggle() {
+  row = Macros.row;
+  col = Macros.col;
 
   if (Layer.isOn(numPadLayer)) {
     Layer.off(numPadLayer);
@@ -47,7 +46,6 @@ const macro_t *NumLock_::toggle(byte row_, byte col_, uint8_t numPadLayer) {
   } else {
     Layer.on(numPadLayer);
   }
-  isActive = Layer.isOn(numPadLayer);
 
   return MACRO(T(KeypadNumLock), END);
 }
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index 47b2a77e..1c9ebee4 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -13,11 +13,12 @@ class NumLock_ : public KaleidoscopePlugin {
 
   void begin(void) final;
 
-  static const macro_t *toggle(byte row, byte col, uint8_t numPadLayer);
+  static const macro_t *toggle();
   static void loopHook(const bool postClear);
 
+  static uint8_t numPadLayer;
+
  private:
-  static bool isActive;
   static byte row, col;
 };
 

From 137ff3761054db3ca40cc304e35775428cb3e0a1 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 24 Jul 2017 14:59:12 -0700
Subject: [PATCH 17/60] CamelCaseifcation of LED related functions

s/led_set_crgb_at/setCrgbAt/
s/hsv_to_rgb/hsvToRgb/
s/led_get_crgb_at/getCrgbAt/
s/led_sync/syncLeds/
s/get_led_index/getLedIndex/
s/send_led_data/sendLedData/
s/led_power_fault/ledPowerFault/
---
 src/Kaleidoscope-Numlock.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index decee6d9..9b251120 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -25,7 +25,7 @@ void NumLock_::loopHook(bool postClear) {
       if (k.raw < Key_KeypadNumLock.raw || k.raw > Key_KeypadDot.raw)
         continue;
 
-      LEDControl.led_set_crgb_at(r, c, numpad_color);
+      LEDControl.setCrgbAt(r, c, numpad_color);
     }
   }
 
@@ -33,7 +33,7 @@ void NumLock_::loopHook(bool postClear) {
     return;
 
   cRGB color = breath_compute();
-  LEDControl.led_set_crgb_at(row, col, color);
+  LEDControl.setCrgbAt(row, col, color);
 }
 
 const macro_t *NumLock_::toggle() {

From 401e9326a050316b54777fe0fab7273aa983c44d Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Tue, 25 Jul 2017 15:52:17 -0700
Subject: [PATCH 18/60] Update Makefile to fix OS X build

---
 Makefile | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 9ce0c4a9..2b04143a 100644
--- a/Makefile
+++ b/Makefile
@@ -4,9 +4,10 @@
 MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build
 UNAME_S := $(shell uname -s)
 
-BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware
 ifeq ($(UNAME_S),Darwin)
-BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware
+BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware
+else
+BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware
 endif
 
-include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk
+include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk

From 4f7e60ec52efedcf969b4cb42b6abbcfdc7e17c4 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Fri, 28 Jul 2017 08:24:36 +0200
Subject: [PATCH 19/60] Highlight changed keys on the NumLock layer, not just
 NumPad ones

As there are - or at least may be - other keys on the layer, not just NumPad
ones, those should be highlighted too.

Addresses the bulk of keyboardio/Kaleidoscope#149, by comparing the looked up
key with what is directly on the `numPadLayer`: if they are the same, then it is
a key that we assume changed, and do the coloring. If they are different (in
other words, the key on the `numPadLayer` is transparent or off), we skip the
highlight.

The downside is that we highlight layer switching keys too, which we may not
want. That will be addressed separately.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 9b251120..430d7f2b 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -21,8 +21,9 @@ void NumLock_::loopHook(bool postClear) {
   for (uint8_t r = 0; r < ROWS; r++) {
     for (uint8_t c = 0; c < COLS; c++) {
       Key k = Layer.lookup(r, c);
+      Key layer_key = Layer.getKey(numPadLayer, r, c);
 
-      if (k.raw < Key_KeypadNumLock.raw || k.raw > Key_KeypadDot.raw)
+      if ((k != layer_key))
         continue;
 
       LEDControl.setCrgbAt(r, c, numpad_color);

From 23b341e2b3d5a3c5337acdd25116fd8ff685db66 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Fri, 28 Jul 2017 08:34:49 +0200
Subject: [PATCH 20/60] Skip layer switching keys when it comes to highlighting

Together with the previous, this fixes keyboardio/Kaleidoscope#149.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 430d7f2b..c6c03c50 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -23,7 +23,7 @@ void NumLock_::loopHook(bool postClear) {
       Key k = Layer.lookup(r, c);
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
-      if ((k != layer_key))
+      if ((k != layer_key) || ((k.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) && !(k.flags & RESERVED)))
         continue;
 
       LEDControl.setCrgbAt(r, c, numpad_color);

From 92050c2ab7b91b4ad72db762b2d715e384423d68 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Sun, 30 Jul 2017 09:22:19 +0200
Subject: [PATCH 21/60] Highlight only those keys that have no flag set

Instead of trying to exclude layer keys, exclude everything with a flag. Thus,
only the basic keys will receive the highlighting treatment, and the rest,
`Prog`, `Any` and the layer keys will not.

Thanks to @chughes87 for the report!

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index c6c03c50..54db9122 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -23,7 +23,7 @@ void NumLock_::loopHook(bool postClear) {
       Key k = Layer.lookup(r, c);
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
-      if ((k != layer_key) || ((k.flags == (SYNTHETIC | SWITCH_TO_KEYMAP)) && !(k.flags & RESERVED)))
+      if ((k != layer_key) || (k.flags != KEY_FLAGS))
         continue;
 
       LEDControl.setCrgbAt(r, c, numpad_color);

From c575fd0d5216e726fa1d196dd38de8ed4793e389 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Thu, 3 Aug 2017 18:10:18 +0900
Subject: [PATCH 22/60] When in numlock, we should only light up the numpad
 keys, not everything else

---
 src/Kaleidoscope-Numlock.cpp | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 54db9122..7e04b63d 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -6,6 +6,7 @@
 byte NumLock_::row = 255, NumLock_::col = 255;
 uint8_t NumLock_::numPadLayer;
 cRGB numpad_color = CRGB(255, 0, 0);
+cRGB off_color = CRGB(0, 0, 0);
 
 NumLock_::NumLock_(void) {
 }
@@ -23,10 +24,11 @@ void NumLock_::loopHook(bool postClear) {
       Key k = Layer.lookup(r, c);
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
-      if ((k != layer_key) || (k.flags != KEY_FLAGS))
-        continue;
-
-      LEDControl.setCrgbAt(r, c, numpad_color);
+      if ((k != layer_key) || (k.flags != KEY_FLAGS)) {
+        LEDControl.setCrgbAt(r, c, off_color);
+      } else {
+        LEDControl.setCrgbAt(r, c, numpad_color);
+      }
     }
   }
 

From 6dc23db20b7be741c6849f976debe5d13c3c0e7b Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 12 Aug 2017 23:36:42 -0700
Subject: [PATCH 23/60] When figuring out which keys to light up with LEDs:
 Switch to looking up the numpad keys based on the currently active layer

---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 7e04b63d..60246e4f 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -21,7 +21,7 @@ void NumLock_::loopHook(bool postClear) {
 
   for (uint8_t r = 0; r < ROWS; r++) {
     for (uint8_t c = 0; c < COLS; c++) {
-      Key k = Layer.lookup(r, c);
+      Key k = Layer.lookupOnActiveLayer(r, c);
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
       if ((k != layer_key) || (k.flags != KEY_FLAGS)) {

From 9fa29b709dc78fe0b6d1c7cf4a0be8d0c2dee031 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 12 Aug 2017 23:53:38 -0700
Subject: [PATCH 24/60] Turn off the LEDs when exiting NumLock mode.

---
 src/Kaleidoscope-Numlock.cpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 60246e4f..b27fe8ca 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -45,6 +45,9 @@ const macro_t *NumLock_::toggle() {
 
   if (Layer.isOn(numPadLayer)) {
     Layer.off(numPadLayer);
+    // Reset all LEDs to off to hopefully give the previous LED effect
+    // a better starting state
+    LEDControl.set_all_leds_to({0, 0, 0});
     LEDControl.init_mode();
   } else {
     Layer.on(numPadLayer);

From da0c998760529ab41d61858f6ab9fc7062bc070a Mon Sep 17 00:00:00 2001
From: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
Date: Tue, 15 Aug 2017 23:04:32 +0200
Subject: [PATCH 25/60] Updated to use the new LEDMode/LEDControl API

Signed-off-by: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
---
 src/Kaleidoscope-Numlock.cpp | 13 +++----------
 src/Kaleidoscope-Numlock.h   |  2 +-
 2 files changed, 4 insertions(+), 11 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index b27fe8ca..744ffd49 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -6,13 +6,9 @@
 byte NumLock_::row = 255, NumLock_::col = 255;
 uint8_t NumLock_::numPadLayer;
 cRGB numpad_color = CRGB(255, 0, 0);
-cRGB off_color = CRGB(0, 0, 0);
-
-NumLock_::NumLock_(void) {
-}
 
 void NumLock_::begin(void) {
-  loop_hook_use(loopHook);
+  Kaleidoscope.useLoopHook(loopHook);
 }
 
 void NumLock_::loopHook(bool postClear) {
@@ -25,7 +21,7 @@ void NumLock_::loopHook(bool postClear) {
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
       if ((k != layer_key) || (k.flags != KEY_FLAGS)) {
-        LEDControl.setCrgbAt(r, c, off_color);
+        LEDControl.refreshAt(r, c);
       } else {
         LEDControl.setCrgbAt(r, c, numpad_color);
       }
@@ -45,10 +41,7 @@ const macro_t *NumLock_::toggle() {
 
   if (Layer.isOn(numPadLayer)) {
     Layer.off(numPadLayer);
-    // Reset all LEDs to off to hopefully give the previous LED effect
-    // a better starting state
-    LEDControl.set_all_leds_to({0, 0, 0});
-    LEDControl.init_mode();
+    LEDControl.set_mode(LEDControl.get_mode_index());
   } else {
     Layer.on(numPadLayer);
   }
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index 1c9ebee4..c11a36ce 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -9,7 +9,7 @@
 
 class NumLock_ : public KaleidoscopePlugin {
  public:
-  NumLock_(void);
+  NumLock_(void) {}
 
   void begin(void) final;
 

From 74bd0d88a231d921620e5d09d5d467f41841254f Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 21 Aug 2017 22:24:58 -0700
Subject: [PATCH 26/60] Update Makefile with OSX fixes and new paths

---
 Makefile | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Makefile b/Makefile
index 2b04143a..8f830f44 100644
--- a/Makefile
+++ b/Makefile
@@ -1,13 +1,14 @@
 # This stub makefile for a Kaleidoscope plugin pulls in 
 # all targets from the Kaleidoscope-Plugin library
 
-MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build
 UNAME_S := $(shell uname -s)
 
 ifeq ($(UNAME_S),Darwin)
-BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware
+SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/
 else
-BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware
+SKETCHBOOK_DIR ?= $(HOME)/Arduino
 endif
 
-include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk
+BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware
+KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/
+include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk

From 1d1affb71b3569843f1c55f1bc9976939445a53b Mon Sep 17 00:00:00 2001
From: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
Date: Sun, 1 Oct 2017 01:10:28 +0200
Subject: [PATCH 27/60] Use an event loop hook instead of requiring a macro to
 detect NumLock

Requiring the end-user to use a macro to have the NumLock effect is a bit
confusing. We can do better than that, by using an event handler hook, and
catching `Keypad_NumLock` presses, and toggle on keypress.

This way, the macro is not necessary, and all the user has to do, is to use the
plugin, configure `numPadLayer`, and done.

Signed-off-by: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
---
 src/Kaleidoscope-Numlock.cpp | 12 ++++++++----
 src/Kaleidoscope-Numlock.h   |  9 +++------
 2 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 744ffd49..1de648e3 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -9,6 +9,7 @@ cRGB numpad_color = CRGB(255, 0, 0);
 
 void NumLock_::begin(void) {
   Kaleidoscope.useLoopHook(loopHook);
+  Kaleidoscope.useEventHandlerHook(eventHandlerHook);
 }
 
 void NumLock_::loopHook(bool postClear) {
@@ -35,9 +36,12 @@ void NumLock_::loopHook(bool postClear) {
   LEDControl.setCrgbAt(row, col, color);
 }
 
-const macro_t *NumLock_::toggle() {
-  row = Macros.row;
-  col = Macros.col;
+Key NumLock_::eventHandlerHook(Key key, byte row, byte col, uint8_t key_state) {
+  if (key != Key_KeypadNumLock)
+    return key;
+
+  if (!key_toggled_on(key_state))
+    return key;
 
   if (Layer.isOn(numPadLayer)) {
     Layer.off(numPadLayer);
@@ -46,7 +50,7 @@ const macro_t *NumLock_::toggle() {
     Layer.on(numPadLayer);
   }
 
-  return MACRO(T(KeypadNumLock), END);
+  return key;
 }
 
 NumLock_ NumLock;
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index c11a36ce..d9d42871 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -4,21 +4,18 @@
 #include "Kaleidoscope-Macros.h"
 #include "LEDUtils.h"
 
-#define TOGGLENUMLOCK 0
-#define Key_ToggleNumlock M(TOGGLENUMLOCK)
-
 class NumLock_ : public KaleidoscopePlugin {
  public:
   NumLock_(void) {}
 
   void begin(void) final;
 
-  static const macro_t *toggle();
-  static void loopHook(const bool postClear);
-
   static uint8_t numPadLayer;
 
  private:
+  static void loopHook(const bool postClear);
+  static Key eventHandlerHook(Key key, byte row, byte col, uint8_t key_state);
+
   static byte row, col;
 };
 

From 393bba00ba7c21764b786ffd9e8f8b3b21ce9e9b Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sat, 14 Oct 2017 22:42:31 -0700
Subject: [PATCH 28/60] Fix for a deprecated API

---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 1de648e3..c0d31150 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -40,7 +40,7 @@ Key NumLock_::eventHandlerHook(Key key, byte row, byte col, uint8_t key_state) {
   if (key != Key_KeypadNumLock)
     return key;
 
-  if (!key_toggled_on(key_state))
+  if (!keyToggledOn(key_state))
     return key;
 
   if (Layer.isOn(numPadLayer)) {

From a1c0fdfb42d5fca67c68558f2a8dd85f394cb9be Mon Sep 17 00:00:00 2001
From: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
Date: Sun, 29 Oct 2017 20:30:03 +0100
Subject: [PATCH 29/60] Sync the NUMPAD layer state with the host

Instead of trying to track numlock ourselves, rely on the host telling us what
it thinks the state is. This is much more reliable than what we were doing, and
hopefully fixes most of - if not all - the issues we were having with NumLock.

Signed-off-by: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
---
 src/Kaleidoscope-Numlock.cpp | 35 ++++++++++++++++-------------------
 src/Kaleidoscope-Numlock.h   |  2 +-
 2 files changed, 17 insertions(+), 20 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index c0d31150..5bd2dc33 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -5,15 +5,29 @@
 
 byte NumLock_::row = 255, NumLock_::col = 255;
 uint8_t NumLock_::numPadLayer;
+bool NumLock_::isOn;
 cRGB numpad_color = CRGB(255, 0, 0);
 
 void NumLock_::begin(void) {
   Kaleidoscope.useLoopHook(loopHook);
-  Kaleidoscope.useEventHandlerHook(eventHandlerHook);
 }
 
 void NumLock_::loopHook(bool postClear) {
-  if (!postClear || !Layer.isOn(numPadLayer))
+  if (!postClear)
+    return;
+
+  bool numState = !!(Keyboard.getLEDs() & LED_NUM_LOCK);
+  if (numState != isOn) {
+    isOn = numState;
+    if (isOn) {
+      Layer.on(numPadLayer);
+    } else {
+      Layer.off(numPadLayer);
+      LEDControl.set_mode(LEDControl.get_mode_index());
+    }
+  }
+
+  if (!isOn)
     return;
 
   for (uint8_t r = 0; r < ROWS; r++) {
@@ -36,21 +50,4 @@ void NumLock_::loopHook(bool postClear) {
   LEDControl.setCrgbAt(row, col, color);
 }
 
-Key NumLock_::eventHandlerHook(Key key, byte row, byte col, uint8_t key_state) {
-  if (key != Key_KeypadNumLock)
-    return key;
-
-  if (!keyToggledOn(key_state))
-    return key;
-
-  if (Layer.isOn(numPadLayer)) {
-    Layer.off(numPadLayer);
-    LEDControl.set_mode(LEDControl.get_mode_index());
-  } else {
-    Layer.on(numPadLayer);
-  }
-
-  return key;
-}
-
 NumLock_ NumLock;
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index d9d42871..9b147d4d 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -14,9 +14,9 @@ class NumLock_ : public KaleidoscopePlugin {
 
  private:
   static void loopHook(const bool postClear);
-  static Key eventHandlerHook(Key key, byte row, byte col, uint8_t key_state);
 
   static byte row, col;
+  static bool isOn;
 };
 
 extern NumLock_ NumLock;

From 0943911786e53f468254c243e04e6eededb3e97f Mon Sep 17 00:00:00 2001
From: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
Date: Sun, 29 Oct 2017 22:22:28 +0100
Subject: [PATCH 30/60] Use kaleidoscope::hid instead of Keyboard directly

Signed-off-by: Gergely Nagy <kaleidoscope@gergo.csillger.hu>
---
 src/Kaleidoscope-Numlock.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 5bd2dc33..651975da 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -16,7 +16,7 @@ void NumLock_::loopHook(bool postClear) {
   if (!postClear)
     return;
 
-  bool numState = !!(Keyboard.getLEDs() & LED_NUM_LOCK);
+  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
   if (numState != isOn) {
     isOn = numState;
     if (isOn) {

From 1333f302527cd1dfbf9d4ed5ce8edb26569eace3 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sun, 12 Nov 2017 23:08:39 -0800
Subject: [PATCH 31/60] Switch to not trying to use 'Numlock' as a toggle.

---
 src/Kaleidoscope-Numlock.cpp | 28 ++++++++++++++++++----------
 src/Kaleidoscope-Numlock.h   |  2 +-
 2 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-Numlock.cpp
index 651975da..c7f2adf1 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-Numlock.cpp
@@ -5,7 +5,7 @@
 
 byte NumLock_::row = 255, NumLock_::col = 255;
 uint8_t NumLock_::numPadLayer;
-bool NumLock_::isOn;
+bool NumLock_::cleanupDone = true;
 cRGB numpad_color = CRGB(255, 0, 0);
 
 void NumLock_::begin(void) {
@@ -16,25 +16,33 @@ void NumLock_::loopHook(bool postClear) {
   if (!postClear)
     return;
 
-  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
-  if (numState != isOn) {
-    isOn = numState;
-    if (isOn) {
-      Layer.on(numPadLayer);
-    } else {
-      Layer.off(numPadLayer);
+  if (!Layer.isOn(numPadLayer)) {
+    if (!cleanupDone) {
       LEDControl.set_mode(LEDControl.get_mode_index());
+      cleanupDone = true;
     }
+    return;
   }
 
-  if (!isOn)
-    return;
+  cleanupDone = false;
+  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+  if (!numState) {
+    kaleidoscope::hid::pressKey(Key_KeypadNumLock);
+    kaleidoscope::hid::sendKeyboardReport();
+  }
+
+  LEDControl.set_mode(LEDControl.get_mode_index());
 
   for (uint8_t r = 0; r < ROWS; r++) {
     for (uint8_t c = 0; c < COLS; c++) {
       Key k = Layer.lookupOnActiveLayer(r, c);
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
+      if (k == LockLayer(numPadLayer)) {
+        row  = r;
+        col = c;
+      }
+
       if ((k != layer_key) || (k.flags != KEY_FLAGS)) {
         LEDControl.refreshAt(r, c);
       } else {
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-Numlock.h
index 9b147d4d..bf33aa5e 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-Numlock.h
@@ -16,7 +16,7 @@ class NumLock_ : public KaleidoscopePlugin {
   static void loopHook(const bool postClear);
 
   static byte row, col;
-  static bool isOn;
+  static bool cleanupDone;
 };
 
 extern NumLock_ NumLock;

From 3de82eb6a4e074d8bec2a98cde4f1450c5ff783c Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sun, 12 Nov 2017 23:11:44 -0800
Subject: [PATCH 32/60] Renaming

---
 README.md                                        |  4 ++--
 library.properties                               |  6 +++---
 ...scope-Numlock.cpp => Kaleidoscope-NumPad.cpp} | 16 ++++++++--------
 ...eidoscope-Numlock.h => Kaleidoscope-NumPad.h} |  6 +++---
 4 files changed, 16 insertions(+), 16 deletions(-)
 rename src/{Kaleidoscope-Numlock.cpp => Kaleidoscope-NumPad.cpp} (79%)
 rename src/{Kaleidoscope-Numlock.h => Kaleidoscope-NumPad.h} (76%)

diff --git a/README.md b/README.md
index b8173982..3bbe9948 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Kaleidoscope-Numlock
+# Kaleidoscope-NumPad
 
-This is a plugin for [Kaleidoscope][fw], that adds a NumLock-specific LED
+This is a plugin for [Kaleidoscope][fw], that adds a NumPad-specific LED
 effect, along with a way to toggle to a numpad layer, and apply the effect.
 
  [fw]: https://github.com/keyboardio/Kaleidoscope
diff --git a/library.properties b/library.properties
index 8db57a28..1155e73c 100644
--- a/library.properties
+++ b/library.properties
@@ -1,10 +1,10 @@
-name=Kaleidoscope-Numlock
+name=Kaleidoscope-NumPad
 version=0.0.1
 author=Jesse Vincent
 maintainer=Jesse Vincent <jesse@keyboard.io>
-sentence=A Numlock plugin for Kaleidoscope.
+sentence=A NumPad plugin for Kaleidoscope.
 paragraph=...
 category=Communication
-url=https://github.com/keyboardio/Kaleidoscope-Numlock
+url=https://github.com/keyboardio/Kaleidoscope-NumPad
 architectures=avr
 dot_a_linkage=true
diff --git a/src/Kaleidoscope-Numlock.cpp b/src/Kaleidoscope-NumPad.cpp
similarity index 79%
rename from src/Kaleidoscope-Numlock.cpp
rename to src/Kaleidoscope-NumPad.cpp
index c7f2adf1..6ccb97fa 100644
--- a/src/Kaleidoscope-Numlock.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -1,18 +1,18 @@
-#include "Kaleidoscope-Numlock.h"
+#include "Kaleidoscope-NumPad.h"
 #include "LEDUtils.h"
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-byte NumLock_::row = 255, NumLock_::col = 255;
-uint8_t NumLock_::numPadLayer;
-bool NumLock_::cleanupDone = true;
+byte NumPad_::row = 255, NumPad_::col = 255;
+uint8_t NumPad_::numPadLayer;
+bool NumPad_::cleanupDone = true;
 cRGB numpad_color = CRGB(255, 0, 0);
 
-void NumLock_::begin(void) {
+void NumPad_::begin(void) {
   Kaleidoscope.useLoopHook(loopHook);
 }
 
-void NumLock_::loopHook(bool postClear) {
+void NumPad_::loopHook(bool postClear) {
   if (!postClear)
     return;
 
@@ -27,7 +27,7 @@ void NumLock_::loopHook(bool postClear) {
   cleanupDone = false;
   bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
   if (!numState) {
-    kaleidoscope::hid::pressKey(Key_KeypadNumLock);
+    kaleidoscope::hid::pressKey(Key_KeypadNumPad);
     kaleidoscope::hid::sendKeyboardReport();
   }
 
@@ -58,4 +58,4 @@ void NumLock_::loopHook(bool postClear) {
   LEDControl.setCrgbAt(row, col, color);
 }
 
-NumLock_ NumLock;
+NumPad_ NumPad;
diff --git a/src/Kaleidoscope-Numlock.h b/src/Kaleidoscope-NumPad.h
similarity index 76%
rename from src/Kaleidoscope-Numlock.h
rename to src/Kaleidoscope-NumPad.h
index bf33aa5e..3d60b417 100644
--- a/src/Kaleidoscope-Numlock.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -4,9 +4,9 @@
 #include "Kaleidoscope-Macros.h"
 #include "LEDUtils.h"
 
-class NumLock_ : public KaleidoscopePlugin {
+class NumPad_ : public KaleidoscopePlugin {
  public:
-  NumLock_(void) {}
+  NumPad_(void) {}
 
   void begin(void) final;
 
@@ -19,4 +19,4 @@ class NumLock_ : public KaleidoscopePlugin {
   static bool cleanupDone;
 };
 
-extern NumLock_ NumLock;
+extern NumPad_ NumPad;

From 1fb97c958bb2505c657a81c32135f1caa047a3a5 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Sun, 12 Nov 2017 23:22:03 -0800
Subject: [PATCH 33/60] That renaming was slightly over-aggressive

---
 src/Kaleidoscope-NumPad.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 6ccb97fa..c5ad13d1 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -27,7 +27,7 @@ void NumPad_::loopHook(bool postClear) {
   cleanupDone = false;
   bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
   if (!numState) {
-    kaleidoscope::hid::pressKey(Key_KeypadNumPad);
+    kaleidoscope::hid::pressKey(Key_KeypadNumLock);
     kaleidoscope::hid::sendKeyboardReport();
   }
 

From 952198a98af9a19174d9ba1ea73d8515a0f28ebb Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 13 Nov 2017 13:57:45 -0800
Subject: [PATCH 34/60] It appears that when the BIOS isn't reporting the
 keyboard LED state back to the keyboard, the old code resulted in sending far
 too many key reports. (Specifically, out of controll key repeat on OSX)

---
 src/Kaleidoscope-NumPad.cpp | 1 -
 1 file changed, 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index c5ad13d1..ca7794aa 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -28,7 +28,6 @@ void NumPad_::loopHook(bool postClear) {
   bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
   if (!numState) {
     kaleidoscope::hid::pressKey(Key_KeypadNumLock);
-    kaleidoscope::hid::sendKeyboardReport();
   }
 
   LEDControl.set_mode(LEDControl.get_mode_index());

From 1017cfd600cac605d73614382f9d46cd5df03d7f Mon Sep 17 00:00:00 2001
From: Evan Danaher <github@edanaher.net>
Date: Thu, 22 Feb 2018 13:57:45 -0500
Subject: [PATCH 35/60] Send numlock keypress when disabling the numpad layer.

This avoids the OS being stuck with Numlock on, which leaves the LED on
if other keyboard are attached, and breaks FVWM.

See keyboardio/Model01-Firmware#42
---
 src/Kaleidoscope-NumPad.cpp | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index ca7794aa..c98d7776 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -12,6 +12,13 @@ void NumPad_::begin(void) {
   Kaleidoscope.useLoopHook(loopHook);
 }
 
+static void syncNumlock(bool state) {
+  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+  if (numState != state) {
+    kaleidoscope::hid::pressKey(Key_KeypadNumLock);
+  }
+}
+
 void NumPad_::loopHook(bool postClear) {
   if (!postClear)
     return;
@@ -19,16 +26,14 @@ void NumPad_::loopHook(bool postClear) {
   if (!Layer.isOn(numPadLayer)) {
     if (!cleanupDone) {
       LEDControl.set_mode(LEDControl.get_mode_index());
+      syncNumlock(false);
       cleanupDone = true;
     }
     return;
   }
 
   cleanupDone = false;
-  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
-  if (!numState) {
-    kaleidoscope::hid::pressKey(Key_KeypadNumLock);
-  }
+  syncNumlock(true);
 
   LEDControl.set_mode(LEDControl.get_mode_index());
 

From d5369288fb61011f2892d135b12f90f2a6144ec0 Mon Sep 17 00:00:00 2001
From: Marty Gentillon <marty.gentillon@gmail.com>
Date: Wed, 28 Feb 2018 22:48:20 -0800
Subject: [PATCH 36/60] NumPad now restores the former num lock state on
 deactivation.

---
 src/Kaleidoscope-NumPad.cpp | 9 +++++++++
 src/Kaleidoscope-NumPad.h   | 1 +
 2 files changed, 10 insertions(+)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index ca7794aa..2e446a40 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -6,10 +6,12 @@
 byte NumPad_::row = 255, NumPad_::col = 255;
 uint8_t NumPad_::numPadLayer;
 bool NumPad_::cleanupDone = true;
+bool NumPad_::originalNumLockState = false;
 cRGB numpad_color = CRGB(255, 0, 0);
 
 void NumPad_::begin(void) {
   Kaleidoscope.useLoopHook(loopHook);
+  originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
 }
 
 void NumPad_::loopHook(bool postClear) {
@@ -17,10 +19,17 @@ void NumPad_::loopHook(bool postClear) {
     return;
 
   if (!Layer.isOn(numPadLayer)) {
+    bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
     if (!cleanupDone) {
       LEDControl.set_mode(LEDControl.get_mode_index());
       cleanupDone = true;
+
+      if (numState && !originalNumLockState) {
+        kaleidoscope::hid::pressKey(Key_KeypadNumLock);
+        numState = false;
+      }
     }
+    originalNumLockState = numState;
     return;
   }
 
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 3d60b417..1f3c9010 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -17,6 +17,7 @@ class NumPad_ : public KaleidoscopePlugin {
 
   static byte row, col;
   static bool cleanupDone;
+  static bool originalNumLockState;
 };
 
 extern NumPad_ NumPad;

From deb92d85dd509bd2dcbe6635bd5c09590343fb72 Mon Sep 17 00:00:00 2001
From: Maxime de Roucy <maxime.deroucy@gmail.com>
Date: Sun, 4 Mar 2018 19:32:15 +0100
Subject: [PATCH 37/60] Don't enable LED on Key_NoKey

---
 src/Kaleidoscope-NumPad.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index ca7794aa..269db35d 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -42,7 +42,7 @@ void NumPad_::loopHook(bool postClear) {
         col = c;
       }
 
-      if ((k != layer_key) || (k.flags != KEY_FLAGS)) {
+      if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
         LEDControl.refreshAt(r, c);
       } else {
         LEDControl.setCrgbAt(r, c, numpad_color);

From effa6eba153467edab35f4ae80a7fcfa31314bd0 Mon Sep 17 00:00:00 2001
From: Marty Gentillon <marty.gentillon@gmail.com>
Date: Wed, 14 Mar 2018 17:14:27 -0700
Subject: [PATCH 38/60] Numpad now properly restores the former numlock state
 on deactivation.

Test procedure:
  1. Make sure numlock is off on host machine.
  2. Activate num layer. Confirm, numlock is now on.
  3. Deactivate num layer. Confirm, numlock is now off.
  4. Using another keyboard, activate numlock on host machine.
  5. Activate num layer. Confirm, numlock is still on.
  6. Deactivate num layer. Confirm, numlock is still on.

Prior to this commit, step 6 resulted in numlock being off.

see https://github.com/keyboardio/Kaleidoscope-NumPad/pull/2
broken https://github.com/keyboardio/Kaleidoscope-NumPad/pull/3
see https://github.com/keyboardio/Kaleidoscope-NumPad/issues/1
fixes https://github.com/keyboardio/Kaleidoscope-NumPad/issues/6
---
 src/Kaleidoscope-NumPad.cpp | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 84b9eba2..08ed6c93 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -14,8 +14,12 @@ void NumPad_::begin(void) {
   originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
 }
 
+static bool getNumlockState() {
+  return !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+}
+
 static void syncNumlock(bool state) {
-  bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+  bool numState = getNumlockState();
   if (numState != state) {
     kaleidoscope::hid::pressKey(Key_KeypadNumLock);
   }
@@ -26,16 +30,15 @@ void NumPad_::loopHook(bool postClear) {
     return;
 
   if (!Layer.isOn(numPadLayer)) {
-    bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+    bool numState = getNumlockState();
     if (!cleanupDone) {
       LEDControl.set_mode(LEDControl.get_mode_index());
-      syncNumlock(false);
-      cleanupDone = true;
 
-      if (numState && !originalNumLockState) {
-        kaleidoscope::hid::pressKey(Key_KeypadNumLock);
+      if (!originalNumLockState) {
+        syncNumlock(false);
         numState = false;
       }
+      cleanupDone = true;
     }
     originalNumLockState = numState;
     return;

From 115e439a4cb0e3b4775daf08fdfb5cb328341ebf Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Sun, 13 May 2018 10:29:00 +0200
Subject: [PATCH 39/60] Updated to use the new plugin APIs

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 30 ++++++++++++++++++++++--------
 src/Kaleidoscope-NumPad.h   | 15 ++++++++++-----
 2 files changed, 32 insertions(+), 13 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 84b9eba2..0057d08c 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -9,9 +9,9 @@ bool NumPad_::cleanupDone = true;
 bool NumPad_::originalNumLockState = false;
 cRGB numpad_color = CRGB(255, 0, 0);
 
-void NumPad_::begin(void) {
-  Kaleidoscope.useLoopHook(loopHook);
+kaleidoscope::EventHandlerResult NumPad_::onSetup(void) {
   originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
+  return kaleidoscope::EventHandlerResult::OK;
 }
 
 static void syncNumlock(bool state) {
@@ -21,10 +21,7 @@ static void syncNumlock(bool state) {
   }
 }
 
-void NumPad_::loopHook(bool postClear) {
-  if (!postClear)
-    return;
-
+kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     bool numState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
     if (!cleanupDone) {
@@ -38,7 +35,8 @@ void NumPad_::loopHook(bool postClear) {
       }
     }
     originalNumLockState = numState;
-    return;
+
+    return kaleidoscope::EventHandlerResult::OK;
   }
 
   cleanupDone = false;
@@ -65,10 +63,26 @@ void NumPad_::loopHook(bool postClear) {
   }
 
   if (row > ROWS || col > COLS)
-    return;
+    return kaleidoscope::EventHandlerResult::OK;
 
   cRGB color = breath_compute();
   LEDControl.setCrgbAt(row, col, color);
+
+  return kaleidoscope::EventHandlerResult::OK;
+}
+
+// Legacy V1 API
+#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
+void NumPad_::begin() {
+  onSetup();
+  Kaleidoscope.useLoopHook(legacyLoopHook);
+}
+
+void NumPad_::legacyLoopHook(bool is_post_clear) {
+  if (!is_post_clear)
+    return;
+  NumPad.afterEachCycle();
 }
+#endif
 
 NumPad_ NumPad;
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 1f3c9010..6371c534 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -4,17 +4,22 @@
 #include "Kaleidoscope-Macros.h"
 #include "LEDUtils.h"
 
-class NumPad_ : public KaleidoscopePlugin {
+class NumPad_ : public kaleidoscope::Plugin {
  public:
   NumPad_(void) {}
 
-  void begin(void) final;
-
   static uint8_t numPadLayer;
 
- private:
-  static void loopHook(const bool postClear);
+  kaleidoscope::EventHandlerResult onSetup(void);
+  kaleidoscope::EventHandlerResult afterEachCycle();
 
+#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
+ protected:
+  void begin();
+  static void legacyLoopHook(bool is_post_clear);
+#endif
+
+ private:
   static byte row, col;
   static bool cleanupDone;
   static bool originalNumLockState;

From 6190f55c578e93b177ba6e8f78c023b4114ca79c Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Wed, 6 Jun 2018 11:57:36 +0200
Subject: [PATCH 40/60] Dim the numpad color down from 255 to 160.

Having it at the brightest uses too much power, and may result in power use
surges when switching between LED modes and NumPad, which in turn can force the
operating system to disable the whole device. To avoid this, lower the
brightness to 160, a carefull tuned value, also used by the `solidRed` mode in
the factory firmware.

Fixes #9.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 0057d08c..70a2299a 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -7,7 +7,7 @@ byte NumPad_::row = 255, NumPad_::col = 255;
 uint8_t NumPad_::numPadLayer;
 bool NumPad_::cleanupDone = true;
 bool NumPad_::originalNumLockState = false;
-cRGB numpad_color = CRGB(255, 0, 0);
+cRGB numpad_color = CRGB(160, 0, 0);
 
 kaleidoscope::EventHandlerResult NumPad_::onSetup(void) {
   originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);

From 4b04d506c414ae5685b0fe04b010c4addb66c1f6 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Fri, 15 Jun 2018 15:31:41 +0200
Subject: [PATCH 41/60] Make the numpad highlight color configurable

Fixes #11.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 8 ++++----
 src/Kaleidoscope-NumPad.h   | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 70a2299a..16263e38 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -7,7 +7,7 @@ byte NumPad_::row = 255, NumPad_::col = 255;
 uint8_t NumPad_::numPadLayer;
 bool NumPad_::cleanupDone = true;
 bool NumPad_::originalNumLockState = false;
-cRGB numpad_color = CRGB(160, 0, 0);
+cRGB NumPad_::color = CRGB(160, 0, 0);
 
 kaleidoscope::EventHandlerResult NumPad_::onSetup(void) {
   originalNumLockState = !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
@@ -57,7 +57,7 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
       if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
         LEDControl.refreshAt(r, c);
       } else {
-        LEDControl.setCrgbAt(r, c, numpad_color);
+        LEDControl.setCrgbAt(r, c, color);
       }
     }
   }
@@ -65,8 +65,8 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (row > ROWS || col > COLS)
     return kaleidoscope::EventHandlerResult::OK;
 
-  cRGB color = breath_compute();
-  LEDControl.setCrgbAt(row, col, color);
+  cRGB lock_color = breath_compute();
+  LEDControl.setCrgbAt(row, col, lock_color);
 
   return kaleidoscope::EventHandlerResult::OK;
 }
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 6371c534..d6b73eaf 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -9,6 +9,7 @@ class NumPad_ : public kaleidoscope::Plugin {
   NumPad_(void) {}
 
   static uint8_t numPadLayer;
+  static cRGB color;
 
   kaleidoscope::EventHandlerResult onSetup(void);
   kaleidoscope::EventHandlerResult afterEachCycle();

From 604ebc448d613576027dabe2f2793c3607ebed4c Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Fri, 15 Jun 2018 15:32:59 +0200
Subject: [PATCH 42/60] Make the NumLock breathe's hue configurable too

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 3 ++-
 src/Kaleidoscope-NumPad.h   | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 16263e38..c9860238 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -8,6 +8,7 @@ uint8_t NumPad_::numPadLayer;
 bool NumPad_::cleanupDone = true;
 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);
@@ -65,7 +66,7 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (row > ROWS || col > COLS)
     return kaleidoscope::EventHandlerResult::OK;
 
-  cRGB lock_color = breath_compute();
+  cRGB lock_color = breath_compute(lock_hue);
   LEDControl.setCrgbAt(row, col, lock_color);
 
   return kaleidoscope::EventHandlerResult::OK;
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index d6b73eaf..aeb534b1 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -10,6 +10,7 @@ class NumPad_ : public kaleidoscope::Plugin {
 
   static uint8_t numPadLayer;
   static cRGB color;
+  static uint8_t lock_hue;
 
   kaleidoscope::EventHandlerResult onSetup(void);
   kaleidoscope::EventHandlerResult afterEachCycle();

From 121219943c5d8bfa1b7ebb14527197622f32ff41 Mon Sep 17 00:00:00 2001
From: Shriramana Sharma <samjnaa@gmail.com>
Date: Sun, 17 Jun 2018 17:28:59 +0530
Subject: [PATCH 43/60] Add documentation for recently added color properties

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 3bbe9948..83bc5629 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,37 @@
 This is a plugin for [Kaleidoscope][fw], that adds a NumPad-specific LED
 effect, along with a way to toggle to a numpad layer, and apply the effect.
 
+## Using the extension
+
+To use the plugin, include the header, and tell the firmware to use it:
+
+```c++
+#include "Kaleidoscope-NumPad.h"
+
+KALEIDOSCOPE_INIT_PLUGINS(NumPad);
+
+void setup() {
+  Kaleidoscope.setup();
+
+  NumPad.color = CRGB(0, 0, 160); // a blue color
+  NumPad.lock_hue = 85; // green
+}
+```
+
+##   Plugin methods
+
+The plugin provides the `NumPad` object, with the following properties:
+
+### `.color`
+
+> This property sets the color that the NumPad keys are highlighted in.
+>
+> The default is `CRGB(160, 0, 0)`, a red color.
+
+### `.lock_hue`
+
+> This property sets the color hue that the NumLock LED breathes in.
+>
+> The default is `170`, a blue hue.
+
  [fw]: https://github.com/keyboardio/Kaleidoscope

From 454c0d5b06692ac88f78cfef728a14d81a0a4ce7 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Mon, 20 Aug 2018 23:21:48 +0200
Subject: [PATCH 44/60] Drop the V1 plugin API compatibility code

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 14 --------------
 src/Kaleidoscope-NumPad.h   |  6 ------
 2 files changed, 20 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 5d454d98..43f643c5 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -75,18 +75,4 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   return kaleidoscope::EventHandlerResult::OK;
 }
 
-// Legacy V1 API
-#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
-void NumPad_::begin() {
-  onSetup();
-  Kaleidoscope.useLoopHook(legacyLoopHook);
-}
-
-void NumPad_::legacyLoopHook(bool is_post_clear) {
-  if (!is_post_clear)
-    return;
-  NumPad.afterEachCycle();
-}
-#endif
-
 NumPad_ NumPad;
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index aeb534b1..0b85cd33 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -15,12 +15,6 @@ class NumPad_ : public kaleidoscope::Plugin {
   kaleidoscope::EventHandlerResult onSetup(void);
   kaleidoscope::EventHandlerResult afterEachCycle();
 
-#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
- protected:
-  void begin();
-  static void legacyLoopHook(bool is_post_clear);
-#endif
-
  private:
   static byte row, col;
   static bool cleanupDone;

From 358e58a6efe84e6d356d7118d322e5114ea97284 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Thu, 23 Aug 2018 22:11:29 +0200
Subject: [PATCH 45/60] Relicense under GPLv3 (only), and add headers.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 COPYING                     | 899 +++++++++++++++++++++++++-----------
 src/Kaleidoscope-NumPad.cpp |  16 +
 src/Kaleidoscope-NumPad.h   |  16 +
 3 files changed, 649 insertions(+), 282 deletions(-)

diff --git a/COPYING b/COPYING
index d159169d..94a9ed02 100644
--- a/COPYING
+++ b/COPYING
@@ -1,281 +1,622 @@
                     GNU GENERAL PUBLIC LICENSE
-                       Version 2, June 1991
+                       Version 3, 29 June 2007
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
                             Preamble
 
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.)  You can apply it to
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
 your programs, too.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
 
-  To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
 
   For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
-
-  We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
-  Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
-  Finally, any free program is threatened constantly by software
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-                    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
-  1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
-  2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-    a) You must cause the modified files to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    b) You must cause any work that you distribute or publish, that in
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
-
-    c) If the modified program normally reads commands interactively
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-    a) Accompany it with the complete corresponding machine-readable
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
-
-    b) Accompany it with a written offer, valid for at least three
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
-
-    c) Accompany it with the information you received as to the offer
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-  5. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-  6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
 this License.
 
-  7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
 be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
-Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
-  10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
-                            NO WARRANTY
-
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
 
                      END OF TERMS AND CONDITIONS
 
@@ -287,15 +628,15 @@ free software which everyone can redistribute and change under these terms.
 
   To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
+state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
     Copyright (C) <year>  <name of author>
 
-    This program is free software; you can redistribute it and/or modify
+    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; either version 2 of the License, or
+    the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
@@ -303,37 +644,31 @@ the "copyright" line and a pointer to where the full notice is found.
     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, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
 
 The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  <signature of Ty Coon>, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 43f643c5..2755efc8 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -1,3 +1,19 @@
+/* Kaleidoscope-NumPad - A NumPad plugin for Kaleidoscope.
+ * Copyright (C) 2017-2018  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-NumPad.h"
 #include "LEDUtils.h"
 #include "Kaleidoscope.h"
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 0b85cd33..2487b64a 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -1,3 +1,19 @@
+/* Kaleidoscope-NumPad - A NumPad plugin for Kaleidoscope.
+ * Copyright (C) 2017-2018  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-LEDControl.h"

From 54b7a809670aff09f7a9451d531345d67a7aa063 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Thu, 23 Aug 2018 22:11:33 +0200
Subject: [PATCH 46/60] Add CONTRIBUTING.md

Copied from Kaleidoscope, as it is applicable here too.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..c490e3ce
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Developer Certificate of Origin
+
+All contributions must include acceptance of the DCO:
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+## Sign your work
+
+To accept the DCO, please add this line to each commit message with your name
+and email address (`git commit -s` will do this for you):
+
+    Signed-off-by: Jane Example <jane@example.com>

From 380a2e8a28944810196ffb9059294dde93c61835 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 00:24:59 -0700
Subject: [PATCH 47/60] rename some variables to make them clearer

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 11 +++++------
 src/Kaleidoscope-NumPad.h   |  3 ++-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 2755efc8..16e480e9 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -19,7 +19,7 @@
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-byte NumPad_::row = 255, NumPad_::col = 255;
+byte NumPad_::numpad_lock_key_row = 255, NumPad_::numpad_lock_key_col = 255;
 uint8_t NumPad_::numPadLayer;
 bool NumPad_::cleanupDone = true;
 bool NumPad_::originalNumLockState = false;
@@ -70,8 +70,8 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
       if (k == LockLayer(numPadLayer)) {
-        row  = r;
-        col = c;
+        numpad_lock_key_row = r;
+        numpad_lock_key_col = c;
       }
 
       if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
@@ -82,11 +82,10 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
     }
   }
 
-  if (row > ROWS || col > COLS)
+  if ((numpad_lock_key_row > ROWS) || (numpad_lock_key_col > COLS)) {
     return kaleidoscope::EventHandlerResult::OK;
 
-  cRGB lock_color = breath_compute(lock_hue);
-  LEDControl.setCrgbAt(row, col, lock_color);
+  LEDControl.setCrgbAt(numpad_lock_key_row, numpad_lock_key_col, lock_color);
 
   return kaleidoscope::EventHandlerResult::OK;
 }
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 2487b64a..843a14da 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -32,7 +32,8 @@ class NumPad_ : public kaleidoscope::Plugin {
   kaleidoscope::EventHandlerResult afterEachCycle();
 
  private:
-  static byte row, col;
+  static uint8_t numpad_lock_key_row;
+  static uint8_t numpad_lock_key_col;
   static bool cleanupDone;
   static bool originalNumLockState;
 };

From b491146f33184820f7b72a93514eaee85773aaee Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 00:27:06 -0700
Subject: [PATCH 48/60] Extract a couple methods and rename a variable

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 52 +++++++++++++++++++++++--------------
 src/Kaleidoscope-NumPad.h   |  4 +++
 2 files changed, 37 insertions(+), 19 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 16e480e9..3bb77deb 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -36,32 +36,30 @@ static bool getNumlockState() {
 }
 
 static void syncNumlock(bool state) {
-  bool numState = getNumlockState();
-  if (numState != state) {
+  bool numLockLEDState = getNumlockState();
+  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() {
+  bool numLockLEDState = getNumlockState();
+  if (!cleanupDone) {
+    LEDControl.set_mode(LEDControl.get_mode_index());
+
+    if (!originalNumLockState) {
+      syncNumlock(false);
+      numLockLEDState = false;
+    }
+    cleanupDone = true;
   }
+  originalNumLockState = numLockLEDState;
 
-  cleanupDone = false;
-  syncNumlock(true);
+}
 
+void NumPad_::setKeyboardLEDColors(void) {
   LEDControl.set_mode(LEDControl.get_mode_index());
 
   for (uint8_t r = 0; r < ROWS; r++) {
@@ -82,12 +80,28 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
     }
   }
 
-  if ((numpad_lock_key_row > ROWS) || (numpad_lock_key_col > COLS)) {
+  if ((numpad_lock_key_row <= ROWS) && (numpad_lock_key_col <= COLS)) {
+
+
+    cRGB lock_color = breath_compute(lock_hue);
+    LEDControl.setCrgbAt(numpad_lock_key_row, numpad_lock_key_col, lock_color);
+  }
+}
+
+kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
+  if (!Layer.isOn(numPadLayer)) {
+    cleanupNumlockState();
     return kaleidoscope::EventHandlerResult::OK;
+  }
+
+  cleanupDone = false;
+  syncNumlock(true);
 
-  LEDControl.setCrgbAt(numpad_lock_key_row, numpad_lock_key_col, lock_color);
 
+  setKeyboardLEDColors();
   return kaleidoscope::EventHandlerResult::OK;
 }
 
+
+
 NumPad_ NumPad;
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 843a14da..bad11578 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -32,6 +32,10 @@ class NumPad_ : public kaleidoscope::Plugin {
   kaleidoscope::EventHandlerResult afterEachCycle();
 
  private:
+
+  void cleanupNumlockState(void);
+  void setKeyboardLEDColors(void);
+
   static uint8_t numpad_lock_key_row;
   static uint8_t numpad_lock_key_col;
   static bool cleanupDone;

From 7c1a5cea95e822c546248e7ba538561e1a6f75cb Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 00:53:33 -0700
Subject: [PATCH 49/60] Refactoring. no functional changes

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 20 +++++++++-----------
 src/Kaleidoscope-NumPad.h   |  2 ++
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 3bb77deb..34eb654b 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -27,15 +27,15 @@ 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 numLockLEDState = getNumlockState();
   if (numLockLEDState != state) {
     kaleidoscope::hid::pressKey(Key_KeypadNumLock);
@@ -50,7 +50,7 @@ void NumPad_::cleanupNumlockState() {
     LEDControl.set_mode(LEDControl.get_mode_index());
 
     if (!originalNumLockState) {
-      syncNumlock(false);
+      syncNumlockState(false);
       numLockLEDState = false;
     }
     cleanupDone = true;
@@ -91,14 +91,12 @@ void NumPad_::setKeyboardLEDColors(void) {
 kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     cleanupNumlockState();
-    return kaleidoscope::EventHandlerResult::OK;
-  }
-
-  cleanupDone = false;
-  syncNumlock(true);
+  } else {
+    cleanupDone = false;
+    syncNumlockState(true);
+    setKeyboardLEDColors();
 
-
-  setKeyboardLEDColors();
+  }
   return kaleidoscope::EventHandlerResult::OK;
 }
 
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index bad11578..4c7311f3 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -35,6 +35,8 @@ class NumPad_ : public kaleidoscope::Plugin {
 
   void cleanupNumlockState(void);
   void setKeyboardLEDColors(void);
+  bool getNumlockState(void);
+  void syncNumlockState(bool);
 
   static uint8_t numpad_lock_key_row;
   static uint8_t numpad_lock_key_col;

From 79996b7216b9bba62763db9dd6aa63a71f0ebf50 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 00:53:58 -0700
Subject: [PATCH 50/60] Only try to reset the numlock led if we actually
 haven't done the cleanup

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 34eb654b..be424624 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -45,17 +45,16 @@ void NumPad_::syncNumlockState(bool state) {
 
 
 void NumPad_::cleanupNumlockState() {
-  bool numLockLEDState = getNumlockState();
   if (!cleanupDone) {
+    bool numLockLEDState = getNumlockState();
     LEDControl.set_mode(LEDControl.get_mode_index());
-
     if (!originalNumLockState) {
       syncNumlockState(false);
       numLockLEDState = false;
     }
     cleanupDone = true;
+    originalNumLockState = numLockLEDState;
   }
-  originalNumLockState = numLockLEDState;
 
 }
 

From 8fb50b2415a49903d6f0a493313f02d938b89939 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 01:02:22 -0700
Subject: [PATCH 51/60] Only run our "toggle numlock mode" once upon toggle of
 the layer

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index be424624..2d32e666 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -21,7 +21,7 @@
 
 byte NumPad_::numpad_lock_key_row = 255, NumPad_::numpad_lock_key_col = 255;
 uint8_t NumPad_::numPadLayer;
-bool NumPad_::cleanupDone = true;
+bool NumPad_::cleanupDone = false;
 bool NumPad_::originalNumLockState = false;
 cRGB NumPad_::color = CRGB(160, 0, 0);
 uint8_t NumPad_::lock_hue = 170;
@@ -52,8 +52,8 @@ void NumPad_::cleanupNumlockState() {
       syncNumlockState(false);
       numLockLEDState = false;
     }
-    cleanupDone = true;
     originalNumLockState = numLockLEDState;
+    cleanupDone = true;
   }
 
 }
@@ -90,10 +90,11 @@ void NumPad_::setKeyboardLEDColors(void) {
 kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     cleanupNumlockState();
-  } else {
-    cleanupDone = false;
+  } else if (cleanupDone)  {
+    // If it's the first time we're in this loop after toggling the Numpad mode on
     syncNumlockState(true);
     setKeyboardLEDColors();
+    cleanupDone = false;
 
   }
   return kaleidoscope::EventHandlerResult::OK;

From efbf158b132bce76374c40663dc2c2f3dc82bf3e Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 23:03:55 -0700
Subject: [PATCH 52/60] Bring back the LED breathing effect

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 2d32e666..b621cd50 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -90,12 +90,13 @@ void NumPad_::setKeyboardLEDColors(void) {
 kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     cleanupNumlockState();
-  } else if (cleanupDone)  {
-    // If it's the first time we're in this loop after toggling the Numpad mode on
-    syncNumlockState(true);
+  } else {
+    if (cleanupDone)  {
+      // If it's the first time we're in this loop after toggling the Numpad mode on
+      syncNumlockState(true);
+      cleanupDone = false;
+    }
     setKeyboardLEDColors();
-    cleanupDone = false;
-
   }
   return kaleidoscope::EventHandlerResult::OK;
 }

From c6886b09fb15f89e2a69364e84d410dc3edd2460 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 23:15:07 -0700
Subject: [PATCH 53/60] Change cleanupDone to numlockUnsynced to better
 represent what it does

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 10 +++++-----
 src/Kaleidoscope-NumPad.h   |  2 +-
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index b621cd50..18d86928 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -21,7 +21,7 @@
 
 byte NumPad_::numpad_lock_key_row = 255, NumPad_::numpad_lock_key_col = 255;
 uint8_t NumPad_::numPadLayer;
-bool NumPad_::cleanupDone = false;
+bool NumPad_::numlockUnsynced = false;
 bool NumPad_::originalNumLockState = false;
 cRGB NumPad_::color = CRGB(160, 0, 0);
 uint8_t NumPad_::lock_hue = 170;
@@ -45,7 +45,7 @@ void NumPad_::syncNumlockState(bool state) {
 
 
 void NumPad_::cleanupNumlockState() {
-  if (!cleanupDone) {
+  if (!numlockUnsynced) {
     bool numLockLEDState = getNumlockState();
     LEDControl.set_mode(LEDControl.get_mode_index());
     if (!originalNumLockState) {
@@ -53,7 +53,7 @@ void NumPad_::cleanupNumlockState() {
       numLockLEDState = false;
     }
     originalNumLockState = numLockLEDState;
-    cleanupDone = true;
+    numlockUnsynced = true;
   }
 
 }
@@ -91,10 +91,10 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     cleanupNumlockState();
   } else {
-    if (cleanupDone)  {
+    if (numlockUnsynced)  {
       // If it's the first time we're in this loop after toggling the Numpad mode on
       syncNumlockState(true);
-      cleanupDone = false;
+      numlockUnsynced = false;
     }
     setKeyboardLEDColors();
   }
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 4c7311f3..1d3595e9 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -40,7 +40,7 @@ class NumPad_ : public kaleidoscope::Plugin {
 
   static uint8_t numpad_lock_key_row;
   static uint8_t numpad_lock_key_col;
-  static bool cleanupDone;
+  static bool numlockUnsynced;
   static bool originalNumLockState;
 };
 

From e3acde94194bcc0c145ab5cf4e9109107b4e05c8 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Fri, 24 Aug 2018 23:23:08 -0700
Subject: [PATCH 54/60] rename a variable that didn't match the style guide

Signed-off-by: Jesse Vincent <jesse@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 10 +++++-----
 src/Kaleidoscope-NumPad.h   |  4 ++--
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index 18d86928..d90fbcdc 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -19,7 +19,7 @@
 #include "Kaleidoscope.h"
 #include "layers.h"
 
-byte NumPad_::numpad_lock_key_row = 255, NumPad_::numpad_lock_key_col = 255;
+byte NumPad_::numpadLayerToggleKeyRow = 255, NumPad_::numpadLayerToggleKeyCol = 255;
 uint8_t NumPad_::numPadLayer;
 bool NumPad_::numlockUnsynced = false;
 bool NumPad_::originalNumLockState = false;
@@ -67,8 +67,8 @@ void NumPad_::setKeyboardLEDColors(void) {
       Key layer_key = Layer.getKey(numPadLayer, r, c);
 
       if (k == LockLayer(numPadLayer)) {
-        numpad_lock_key_row = r;
-        numpad_lock_key_col = c;
+        numpadLayerToggleKeyRow = r;
+        numpadLayerToggleKeyCol = c;
       }
 
       if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
@@ -79,11 +79,11 @@ void NumPad_::setKeyboardLEDColors(void) {
     }
   }
 
-  if ((numpad_lock_key_row <= ROWS) && (numpad_lock_key_col <= COLS)) {
+  if ((numpadLayerToggleKeyRow <= ROWS) && (numpadLayerToggleKeyCol <= COLS)) {
 
 
     cRGB lock_color = breath_compute(lock_hue);
-    LEDControl.setCrgbAt(numpad_lock_key_row, numpad_lock_key_col, lock_color);
+    LEDControl.setCrgbAt(numpadLayerToggleKeyRow, numpadLayerToggleKeyCol, lock_color);
   }
 }
 
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 1d3595e9..016ded65 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -38,8 +38,8 @@ class NumPad_ : public kaleidoscope::Plugin {
   bool getNumlockState(void);
   void syncNumlockState(bool);
 
-  static uint8_t numpad_lock_key_row;
-  static uint8_t numpad_lock_key_col;
+  static uint8_t numpadLayerToggleKeyRow;
+  static uint8_t numpadLayerToggleKeyCol;
   static bool numlockUnsynced;
   static bool originalNumLockState;
 };

From e09c08dd8987d97634d6499dbe8e695deb16fbef Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Tue, 4 Sep 2018 18:24:02 -0700
Subject: [PATCH 55/60] Update travis.yml to point to new bundle repo

---
 .travis.yml | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index e7030acf..e3e64f77 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -2,10 +2,15 @@ dist: trusty
 sudo: false
 os:
   - linux
+addons:
+  apt:
+    packages:
+      - shellcheck
 install:
-  - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr
+  - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio
 script:
   - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
+  - shellcheck bin/kaleidoscope-builder
 notifications:
   irc:
     channels:
@@ -13,7 +18,7 @@ notifications:
     use_notice: true
     skip_join: true
     template:
-      - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" 
+      - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}"
   email:
     on_success: change
     on_failure: change

From 9071ede7301cc5bc331c8295169480bce7cd3ae7 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Tue, 4 Sep 2018 18:42:30 -0700
Subject: [PATCH 56/60] shellcheck should only be run in the Kaleidoscope repo

---
 .travis.yml | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index e3e64f77..23d30ccc 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -2,15 +2,10 @@ dist: trusty
 sudo: false
 os:
   - linux
-addons:
-  apt:
-    packages:
-      - shellcheck
 install:
   - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio
 script:
   - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
-  - shellcheck bin/kaleidoscope-builder
 notifications:
   irc:
     channels:

From 33275c4073d01311f9bae2a6d0a20c02f1bbb303 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Wed, 10 Oct 2018 06:52:35 +0200
Subject: [PATCH 57/60] Travis cleanup

Remove the IRC notifications from Travis (we're not using IRC anymore).

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 .travis.yml | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 23d30ccc..49b8c498 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -7,13 +7,6 @@ install:
 script:
   - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
 notifications:
-  irc:
-    channels:
-      - "chat.freenode.net#keyboardio"
-    use_notice: true
-    skip_join: true
-    template:
-      - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}"
   email:
     on_success: change
     on_failure: change

From ebd4c5191729caa10ba538b936753f1a497a8b68 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Sun, 14 Oct 2018 09:34:05 +0200
Subject: [PATCH 58/60] No need to include "layers.h"

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 src/Kaleidoscope-NumPad.cpp | 1 -
 1 file changed, 1 deletion(-)

diff --git a/src/Kaleidoscope-NumPad.cpp b/src/Kaleidoscope-NumPad.cpp
index d90fbcdc..e5275bc2 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/Kaleidoscope-NumPad.cpp
@@ -17,7 +17,6 @@
 #include "Kaleidoscope-NumPad.h"
 #include "LEDUtils.h"
 #include "Kaleidoscope.h"
-#include "layers.h"
 
 byte NumPad_::numpadLayerToggleKeyRow = 255, NumPad_::numpadLayerToggleKeyCol = 255;
 uint8_t NumPad_::numPadLayer;

From 09c48b8da245e723406cb36fcf0b9947106cd2f7 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Sun, 14 Oct 2018 12:47:52 +0200
Subject: [PATCH 59/60] Rearrange the file layout in preparation of becoming a
 monorepo

Move the documentation to `doc/plugin/NumPad.md`, sources under
`src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of
merging plugins into a single monorepo.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 README.md                                     | 39 ++-------------
 doc/plugin/NumPad.md                          | 39 +++++++++++++++
 src/Kaleidoscope-NumPad.h                     | 30 +----------
 .../plugin/NumPad.cpp}                        | 50 +++++++++----------
 src/kaleidoscope/plugin/NumPad.h              | 50 +++++++++++++++++++
 5 files changed, 119 insertions(+), 89 deletions(-)
 create mode 100644 doc/plugin/NumPad.md
 rename src/{Kaleidoscope-NumPad.cpp => kaleidoscope/plugin/NumPad.cpp} (67%)
 create mode 100644 src/kaleidoscope/plugin/NumPad.h

diff --git a/README.md b/README.md
index 83bc5629..a761cab0 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,8 @@
 # Kaleidoscope-NumPad
 
-This is a plugin for [Kaleidoscope][fw], that adds a NumPad-specific LED
-effect, along with a way to toggle to a numpad layer, and apply the effect.
+[![Build Status][travis:image]][travis:status]
 
-## Using the extension
+ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-NumPad.svg?branch=master
+ [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-NumPad
 
-To use the plugin, include the header, and tell the firmware to use it:
-
-```c++
-#include "Kaleidoscope-NumPad.h"
-
-KALEIDOSCOPE_INIT_PLUGINS(NumPad);
-
-void setup() {
-  Kaleidoscope.setup();
-
-  NumPad.color = CRGB(0, 0, 160); // a blue color
-  NumPad.lock_hue = 85; // green
-}
-```
-
-##   Plugin methods
-
-The plugin provides the `NumPad` object, with the following properties:
-
-### `.color`
-
-> This property sets the color that the NumPad keys are highlighted in.
->
-> The default is `CRGB(160, 0, 0)`, a red color.
-
-### `.lock_hue`
-
-> This property sets the color hue that the NumLock LED breathes in.
->
-> The default is `170`, a blue hue.
-
- [fw]: https://github.com/keyboardio/Kaleidoscope
+See [doc/plugin/NumPad.md](doc/plugin/NumPad.md) for documentation.
diff --git a/doc/plugin/NumPad.md b/doc/plugin/NumPad.md
new file mode 100644
index 00000000..83bc5629
--- /dev/null
+++ b/doc/plugin/NumPad.md
@@ -0,0 +1,39 @@
+# Kaleidoscope-NumPad
+
+This is a plugin for [Kaleidoscope][fw], that adds a NumPad-specific LED
+effect, along with a way to toggle to a numpad layer, and apply the effect.
+
+## Using the extension
+
+To use the plugin, include the header, and tell the firmware to use it:
+
+```c++
+#include "Kaleidoscope-NumPad.h"
+
+KALEIDOSCOPE_INIT_PLUGINS(NumPad);
+
+void setup() {
+  Kaleidoscope.setup();
+
+  NumPad.color = CRGB(0, 0, 160); // a blue color
+  NumPad.lock_hue = 85; // green
+}
+```
+
+##   Plugin methods
+
+The plugin provides the `NumPad` object, with the following properties:
+
+### `.color`
+
+> This property sets the color that the NumPad keys are highlighted in.
+>
+> The default is `CRGB(160, 0, 0)`, a red color.
+
+### `.lock_hue`
+
+> This property sets the color hue that the NumLock LED breathes in.
+>
+> The default is `170`, a blue hue.
+
+ [fw]: https://github.com/keyboardio/Kaleidoscope
diff --git a/src/Kaleidoscope-NumPad.h b/src/Kaleidoscope-NumPad.h
index 016ded65..be0c76f6 100644
--- a/src/Kaleidoscope-NumPad.h
+++ b/src/Kaleidoscope-NumPad.h
@@ -16,32 +16,4 @@
 
 #pragma once
 
-#include "Kaleidoscope-LEDControl.h"
-#include "Kaleidoscope-Macros.h"
-#include "LEDUtils.h"
-
-class NumPad_ : public kaleidoscope::Plugin {
- public:
-  NumPad_(void) {}
-
-  static uint8_t numPadLayer;
-  static cRGB color;
-  static uint8_t lock_hue;
-
-  kaleidoscope::EventHandlerResult onSetup(void);
-  kaleidoscope::EventHandlerResult afterEachCycle();
-
- private:
-
-  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;
-};
-
-extern NumPad_ NumPad;
+#include "kaleidoscope/plugin/NumPad.h"
diff --git a/src/Kaleidoscope-NumPad.cpp b/src/kaleidoscope/plugin/NumPad.cpp
similarity index 67%
rename from src/Kaleidoscope-NumPad.cpp
rename to src/kaleidoscope/plugin/NumPad.cpp
index e5275bc2..6b49ae05 100644
--- a/src/Kaleidoscope-NumPad.cpp
+++ b/src/kaleidoscope/plugin/NumPad.cpp
@@ -15,26 +15,27 @@
  */
 
 #include "Kaleidoscope-NumPad.h"
-#include "LEDUtils.h"
-#include "Kaleidoscope.h"
 
-byte NumPad_::numpadLayerToggleKeyRow = 255, NumPad_::numpadLayerToggleKeyCol = 255;
-uint8_t NumPad_::numPadLayer;
-bool NumPad_::numlockUnsynced = false;
-bool NumPad_::originalNumLockState = false;
-cRGB NumPad_::color = CRGB(160, 0, 0);
-uint8_t NumPad_::lock_hue = 170;
+namespace kaleidoscope {
+namespace plugin {
 
-kaleidoscope::EventHandlerResult NumPad_::onSetup(void) {
+byte NumPad::numpadLayerToggleKeyRow = 255, NumPad::numpadLayerToggleKeyCol = 255;
+uint8_t NumPad::numPadLayer;
+bool NumPad::numlockUnsynced = false;
+bool NumPad::originalNumLockState = false;
+cRGB NumPad::color = CRGB(160, 0, 0);
+uint8_t NumPad::lock_hue = 170;
+
+EventHandlerResult NumPad::onSetup(void) {
   originalNumLockState = getNumlockState();
-  return kaleidoscope::EventHandlerResult::OK;
+  return EventHandlerResult::OK;
 }
 
-bool NumPad_::getNumlockState() {
+bool NumPad::getNumlockState() {
   return !!(kaleidoscope::hid::getKeyboardLEDs() & LED_NUM_LOCK);
 }
 
-void NumPad_::syncNumlockState(bool state) {
+void NumPad::syncNumlockState(bool state) {
   bool numLockLEDState = getNumlockState();
   if (numLockLEDState != state) {
     kaleidoscope::hid::pressKey(Key_KeypadNumLock);
@@ -43,10 +44,10 @@ void NumPad_::syncNumlockState(bool state) {
 
 
 
-void NumPad_::cleanupNumlockState() {
+void NumPad::cleanupNumlockState() {
   if (!numlockUnsynced) {
     bool numLockLEDState = getNumlockState();
-    LEDControl.set_mode(LEDControl.get_mode_index());
+    ::LEDControl.set_mode(::LEDControl.get_mode_index());
     if (!originalNumLockState) {
       syncNumlockState(false);
       numLockLEDState = false;
@@ -57,8 +58,8 @@ void NumPad_::cleanupNumlockState() {
 
 }
 
-void NumPad_::setKeyboardLEDColors(void) {
-  LEDControl.set_mode(LEDControl.get_mode_index());
+void NumPad::setKeyboardLEDColors(void) {
+  ::LEDControl.set_mode(::LEDControl.get_mode_index());
 
   for (uint8_t r = 0; r < ROWS; r++) {
     for (uint8_t c = 0; c < COLS; c++) {
@@ -71,22 +72,20 @@ void NumPad_::setKeyboardLEDColors(void) {
       }
 
       if ((k != layer_key) || (k == Key_NoKey) || (k.flags != KEY_FLAGS)) {
-        LEDControl.refreshAt(r, c);
+        ::LEDControl.refreshAt(r, c);
       } else {
-        LEDControl.setCrgbAt(r, c, color);
+        ::LEDControl.setCrgbAt(r, c, color);
       }
     }
   }
 
   if ((numpadLayerToggleKeyRow <= ROWS) && (numpadLayerToggleKeyCol <= COLS)) {
-
-
     cRGB lock_color = breath_compute(lock_hue);
-    LEDControl.setCrgbAt(numpadLayerToggleKeyRow, numpadLayerToggleKeyCol, lock_color);
+    ::LEDControl.setCrgbAt(numpadLayerToggleKeyRow, numpadLayerToggleKeyCol, lock_color);
   }
 }
 
-kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
+EventHandlerResult NumPad::afterEachCycle() {
   if (!Layer.isOn(numPadLayer)) {
     cleanupNumlockState();
   } else {
@@ -97,9 +96,10 @@ kaleidoscope::EventHandlerResult NumPad_::afterEachCycle() {
     }
     setKeyboardLEDColors();
   }
-  return kaleidoscope::EventHandlerResult::OK;
+  return EventHandlerResult::OK;
 }
 
+}
+}
 
-
-NumPad_ NumPad;
+kaleidoscope::plugin::NumPad NumPad;
diff --git a/src/kaleidoscope/plugin/NumPad.h b/src/kaleidoscope/plugin/NumPad.h
new file mode 100644
index 00000000..8735cd84
--- /dev/null
+++ b/src/kaleidoscope/plugin/NumPad.h
@@ -0,0 +1,50 @@
+/* Kaleidoscope-NumPad - A NumPad plugin for Kaleidoscope.
+ * Copyright (C) 2017-2018  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-LEDControl.h"
+
+namespace kaleidoscope {
+namespace plugin {
+
+class NumPad : public kaleidoscope::Plugin {
+ public:
+  NumPad(void) {}
+
+  static uint8_t numPadLayer;
+  static cRGB color;
+  static uint8_t lock_hue;
+
+  EventHandlerResult onSetup(void);
+  EventHandlerResult afterEachCycle();
+
+ private:
+
+  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;
+};
+}
+}
+
+extern kaleidoscope::plugin::NumPad NumPad;

From cbbdcc3e0da9a7dd9c9a1a813e81f10f9fca24de Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@keyboard.io>
Date: Sun, 14 Oct 2018 12:47:53 +0200
Subject: [PATCH 60/60] Remove files we do not need in the monorepo

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
---
 .travis.yml        |  14 -
 CONTRIBUTING.md    |  50 ----
 COPYING            | 674 ---------------------------------------------
 Makefile           |  14 -
 README.md          |   8 -
 library.properties |  10 -
 6 files changed, 770 deletions(-)
 delete mode 100644 .travis.yml
 delete mode 100644 CONTRIBUTING.md
 delete mode 100644 COPYING
 delete mode 100644 Makefile
 delete mode 100644 README.md
 delete mode 100644 library.properties

diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 49b8c498..00000000
--- a/.travis.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-dist: trusty
-sudo: false
-os:
-  - linux
-install:
-  - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio
-script:
-  - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware
-notifications:
-  email:
-    on_success: change
-    on_failure: change
-cache:
-  ccache: true
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index c490e3ce..00000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# Developer Certificate of Origin
-
-All contributions must include acceptance of the DCO:
-
-```
-Developer Certificate of Origin
-Version 1.1
-
-Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
-1 Letterman Drive
-Suite D4700
-San Francisco, CA, 94129
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
-
-Developer's Certificate of Origin 1.1
-
-By making a contribution to this project, I certify that:
-
-(a) The contribution was created in whole or in part by me and I
-    have the right to submit it under the open source license
-    indicated in the file; or
-
-(b) The contribution is based upon previous work that, to the best
-    of my knowledge, is covered under an appropriate open source
-    license and I have the right under that license to submit that
-    work with modifications, whether created in whole or in part
-    by me, under the same open source license (unless I am
-    permitted to submit under a different license), as indicated
-    in the file; or
-
-(c) The contribution was provided directly to me by some other
-    person who certified (a), (b) or (c) and I have not modified
-    it.
-
-(d) I understand and agree that this project and the contribution
-    are public and that a record of the contribution (including all
-    personal information I submit with it, including my sign-off) is
-    maintained indefinitely and may be redistributed consistent with
-    this project or the open source license(s) involved.
-```
-
-## Sign your work
-
-To accept the DCO, please add this line to each commit message with your name
-and email address (`git commit -s` will do this for you):
-
-    Signed-off-by: Jane Example <jane@example.com>
diff --git a/COPYING b/COPYING
deleted file mode 100644
index 94a9ed02..00000000
--- a/COPYING
+++ /dev/null
@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    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, either version 3 of the License, or
-    (at your option) any later version.
-
-    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/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/Makefile b/Makefile
deleted file mode 100644
index 8f830f44..00000000
--- a/Makefile
+++ /dev/null
@@ -1,14 +0,0 @@
-# This stub makefile for a Kaleidoscope plugin pulls in 
-# all targets from the Kaleidoscope-Plugin library
-
-UNAME_S := $(shell uname -s)
-
-ifeq ($(UNAME_S),Darwin)
-SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/
-else
-SKETCHBOOK_DIR ?= $(HOME)/Arduino
-endif
-
-BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware
-KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/
-include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk
diff --git a/README.md b/README.md
deleted file mode 100644
index a761cab0..00000000
--- a/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Kaleidoscope-NumPad
-
-[![Build Status][travis:image]][travis:status]
-
- [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-NumPad.svg?branch=master
- [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-NumPad
-
-See [doc/plugin/NumPad.md](doc/plugin/NumPad.md) for documentation.
diff --git a/library.properties b/library.properties
deleted file mode 100644
index 1155e73c..00000000
--- a/library.properties
+++ /dev/null
@@ -1,10 +0,0 @@
-name=Kaleidoscope-NumPad
-version=0.0.1
-author=Jesse Vincent
-maintainer=Jesse Vincent <jesse@keyboard.io>
-sentence=A NumPad plugin for Kaleidoscope.
-paragraph=...
-category=Communication
-url=https://github.com/keyboardio/Kaleidoscope-NumPad
-architectures=avr
-dot_a_linkage=true