Merge pull request #1376 from EvyBongers/docs/Colormap-Overlay

Fix readme and example
keyboardio · Jan 9, 2024 · 74e3963 · 74e3963
2 parents 3bc565c + e6e85c0
commit 74e3963
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 18 deletions.
diff --git a/plugins/Kaleidoscope-Colormap-Overlay/README.md b/plugins/Kaleidoscope-Colormap-Overlay/README.md
@@ -1,11 +1,11 @@
 # Colormap-Overlay
 
-The `ColormapOverlay` extension provides an easier way to apply color to
-specific combinations of keys and layers, regardless of the active LED mode.
-Colors are picked from a 16-color palette, provided by the
-[LED-Palette-Theme][plugin:l-p-t] plugin. The overlays are stored in `EEPROM`,
-and can be easily changed via the [FocusSerial][plugin:focusserial] plugin,
-which also provides palette editing capabilities.
+This plugin provides an easier way to apply color to specific combinations of
+keys and layers, regardless of the active LED mode. Colors are picked from a
+16-color palette, provided by the [LED-Palette-Theme][plugin:l-p-t] plugin. The
+overlays are stored in `EEPROM`, and can be easily changed via the
+[FocusSerial][plugin:focusserial] plugin, which also provides palette editing
+capabilities.
 
  [plugin:focusserial]: Kaleidoscope-FocusSerial.md
  [plugin:l-p-t]: Kaleidoscope-LED-Palette-Theme.md
@@ -37,7 +37,6 @@ key coordinates refer to the relevant header file:
 #include <Kaleidoscope.h>
 #include <Kaleidoscope-LEDControl.h>
 #include <Kaleidoscope-LED-Palette-Theme.h>
-#include <Kaleidoscope-Colormap.h>  // DefaultColorMap
 #include <Kaleidoscope-Colormap-Overlay.h>
 #include <Kaleidoscope-FocusSerial.h>
 
@@ -48,7 +47,7 @@ PALETTE(
 KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings,
                           LEDControl,
                           ColormapOverlay,
-                          DefaultColormap,
+                          DefaultPalette,
                           Focus);
 
 void setup() {
@@ -62,7 +61,7 @@ void setup() {
   )
 
   ColormapOverlay.setup();
-  DefaultColormap.setup();
+  DefaultPalette.setup();
 }
 ```
 

diff --git a/plugins/Kaleidoscope-Colormap-Overlay/examples/Colormap-Overlay/Colormap-Overlay.ino b/plugins/Kaleidoscope-Colormap-Overlay/examples/Colormap-Overlay/Colormap-Overlay.ino
@@ -18,7 +18,6 @@
 #include <Kaleidoscope.h>
 #include <Kaleidoscope-LEDControl.h>
 #include <Kaleidoscope-LED-Palette-Theme.h>
-#include <Kaleidoscope-Colormap.h>  // DefaultColorMap
 #include <Kaleidoscope-Colormap-Overlay.h>
 
 // clang-format off
@@ -64,10 +63,10 @@ enum {
 };
 
 PALETTE(
-  [PALETTE_RED]    = CRGB(0xff, 0x00, 0x00),
-  [PALETTE_GREEN]  = CRGB(0x00, 0xff, 0x00),
-  [PALETTE_YELLOW] = CRGB(0x00, 0x00, 0xff),
-  [PALETTE_BLACK]  = CRGB(0x00, 0x00, 0x00),
+  [PALETTE_RED]   = CRGB(0xff, 0x00, 0x00),
+  [PALETTE_GREEN] = CRGB(0x00, 0xff, 0x00),
+  [PALETTE_BLUE]  = CRGB(0x00, 0x00, 0xff),
+  [PALETTE_BLACK] = CRGB(0x00, 0x00, 0x00),
   // unused
   [PALETTE_UNUSED_1]  = CRGB(0x00, 0x00, 0x00),
   [PALETTE_UNUSED_2]  = CRGB(0x00, 0x00, 0x00),
@@ -85,7 +84,7 @@ PALETTE(
 KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings,
                           LEDControl,
                           ColormapOverlay,
-                          DefaultColormap);
+                          DefaultPalette);
 
 void setup() {
   Kaleidoscope.setup();
@@ -95,14 +94,14 @@ void setup() {
     kaleidoscope::plugin::Overlay(0, KeyAddr(0, 9), PALETTE_GREEN),
     // Make numlock red
     kaleidoscope::plugin::Overlay(0, KeyAddr(0, 15), PALETTE_RED),
-    // Make escape yellow
-    kaleidoscope::plugin::Overlay(0, KeyAddr(2, 6), PALETTE_YELLOW),
+    // Make escape blue
+    kaleidoscope::plugin::Overlay(0, KeyAddr(2, 6), PALETTE_BLUE),
     // Disable leds on the palm keys
     kaleidoscope::plugin::Overlay(0, KeyAddr(3, 6), PALETTE_BLACK),
     kaleidoscope::plugin::Overlay(0, KeyAddr(3, 9), PALETTE_BLACK))
 
   ColormapOverlay.setup();
-  DefaultColormap.setup();
+  DefaultPalette.setup();
 }
 
 void loop() {