[Keyboard] Update to ZSA Boards (qmk#10119)

13 files changed, 86 insertions, 4 deletions

diff --git a/keyboards/planck/ez/config.h b/keyboards/planck/ez/config.h
index bfddeb37ff..1ead277542 100644
--- a/keyboards/planck/ez/config.h
+++ b/keyboards/planck/ez/config.h
@@ -18,8 +18,12 @@
 #pragma once
 
 /* USB Device descriptor parameter */
+#undef VENDOR_ID
+#define VENDOR_ID       0x3297
+#undef PRODUCT_ID
+#define PRODUCT_ID      0xC6CE
 #undef MANUFACTURER
-#define MANUFACTURER    ZSA
+#define MANUFACTURER    ZSA Technology Labs
 #undef PRODUCT
 #define PRODUCT         Planck EZ
 #define DEVICE_VER 0x0000
diff --git a/keyboards/planck/ez/ez.c b/keyboards/planck/ez/ez.c
index 3855622481..34f13235fe 100644
--- a/keyboards/planck/ez/ez.c
+++ b/keyboards/planck/ez/ez.c
@@ -19,7 +19,6 @@
 
 keyboard_config_t keyboard_config;
 
-
 #ifdef RGB_MATRIX_ENABLE
 void suspend_power_down_kb(void) {
     rgb_matrix_set_suspend_state(true);
diff --git a/keyboards/planck/ez/ez.h b/keyboards/planck/ez/ez.h
index 770d59acd4..07182417fc 100644
--- a/keyboards/planck/ez/ez.h
+++ b/keyboards/planck/ez/ez.h
@@ -17,6 +17,10 @@
 
 #include "planck.h"
 
+#ifdef KEYBOARD_planck_ez_glow
+#    include "glow.h"
+#endif
+
 #define LAYOUT_planck_1x2uC( \
     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
diff --git a/keyboards/planck/ez/glow/config.h b/keyboards/planck/ez/glow/config.h
new file mode 100644
index 0000000000..21a339da28
--- /dev/null
+++ b/keyboards/planck/ez/glow/config.h
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2018 Jack Humbert <jack.humb@gmail.com>
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#undef PRODUCT_ID
+#define PRODUCT_ID      0xC6CF
+
+#undef PRODUCT
+#define PRODUCT Planck EZ Glow
diff --git a/keyboards/planck/ez/glow/glow.h b/keyboards/planck/ez/glow/glow.h
new file mode 100644
index 0000000000..d8a01f4359
--- /dev/null
+++ b/keyboards/planck/ez/glow/glow.h
@@ -0,0 +1,3 @@
+#pragma once
+
+#include "ez.h"
diff --git a/keyboards/planck/keymaps/glow/config.h b/keyboards/planck/ez/glow/keymaps/glow/config.h
index 6fa31cc8a7..6fa31cc8a7 100644
--- a/keyboards/planck/keymaps/glow/config.h
+++ b/keyboards/planck/ez/glow/keymaps/glow/config.h
diff --git a/keyboards/planck/keymaps/glow/keymap.c b/keyboards/planck/ez/glow/keymaps/glow/keymap.c
index 03cc0049e4..03cc0049e4 100644
--- a/keyboards/planck/keymaps/glow/keymap.c
+++ b/keyboards/planck/ez/glow/keymaps/glow/keymap.c
diff --git a/keyboards/planck/keymaps/glow/readme.md b/keyboards/planck/ez/glow/keymaps/glow/readme.md
index de9680b498..de9680b498 100644
--- a/keyboards/planck/keymaps/glow/readme.md
+++ b/keyboards/planck/ez/glow/keymaps/glow/readme.md
diff --git a/keyboards/planck/keymaps/glow/rules.mk b/keyboards/planck/ez/glow/keymaps/glow/rules.mk
index dcf16bef39..dcf16bef39 100644
--- a/keyboards/planck/keymaps/glow/rules.mk
+++ b/keyboards/planck/ez/glow/keymaps/glow/rules.mk
diff --git a/keyboards/planck/ez/glow/rules.mk b/keyboards/planck/ez/glow/rules.mk
new file mode 100644
index 0000000000..575a9c8fa4
--- /dev/null
+++ b/keyboards/planck/ez/glow/rules.mk
@@ -0,0 +1 @@
+RGB_MATRIX_ENABLE = IS31FL3737
diff --git a/keyboards/planck/ez/readme.md b/keyboards/planck/ez/readme.md
index 9bd161abdf..247bf7448a 100644
--- a/keyboards/planck/ez/readme.md
+++ b/keyboards/planck/ez/readme.md
@@ -13,3 +13,50 @@ Make example for this keyboard (after setting up your build environment):
     make planck/ez:default
 
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+# Planck EZ Glow
+
+For the per key RGB version of this keyboard, you want to use the "glow" subdirectory. For example: 
+
+    make planck/ez/glow:default
+
+## Planck EZ Configuration (from Oryx)
+
+### Indicator LEDs
+
+The two front "teeth" LED indicators are PWM controlled.   If you have `ORYX_CONFIGURATOR` defined in your keymap's `config.h`, you can use the `LED_LEVEL` to cycle through preset vales (0, 25%, 50%, 75%, 100%), and will be saved to EEPROM (persistent storage)
+
+Alternatively, you can set the brightness by calling the following functions: 
+
+```c
+void planck_ez_right_led_level(uint8_t level);
+void planck_ez_left_led_level(uint8_t level);
+```
+
+These settings are not persistent, so you'd need to reset it every time the board starts. 
+
+These are on a 0-255 scale 
+
+#### Layer indication 
+
+By default, the indicator lights are used for layer indication, expecting the specific layers used in the default keymap.  However, this may not work for you.  And if that is the case, you can add `#define PLANCK_EZ_USER_LEDS` to your `config.h` file. 
+
+This will remove the default behavior for changing the LEDs based on layer, and allow you to control them manually. 
+
+Alternatively, you can use the following defines in your keymap's `config.h` to control which layers are used, as long as you have `ORYX_CONFIGURATOR` defined in your keymap's `config.h` file, as well. 
+
+```c
+#define PLANCK_EZ_LED_LOWER 3
+#define PLANCK_EZ_LED_RAISE 4
+#define PLANCK_EZ_LED_ADJUST 6
+```
+
+This will allow you to change the layers that are used, without having to add anything code to your `keymap.c`
+
+### RGB Matrix Features
+
+If you're using the Smart LED (layer indication) feature from the Oryx Configurator, you want to make sure that you enable these options by adding `#define ORYX_CONFIGURATOR` to your keymap's `config.h`. 
+
+This changes the `RGB_TOG` keycode so that it will toggle the lights on and off, in a way that will allow the Smart LEDs to continue to work, even with the rest of the LEDs turned off. 
+
+Additionally, a new keycode has been added to toggle the Smart LEDs.  Use `TOGGLE_LAYER_COLOR`, if you aren't already.  
diff --git a/keyboards/planck/ez/rules.mk b/keyboards/planck/ez/rules.mk
index f09072672e..fb4089afee 100644
--- a/keyboards/planck/ez/rules.mk
+++ b/keyboards/planck/ez/rules.mk
@@ -13,11 +13,9 @@ CONSOLE_ENABLE = no  # Console for debug
 COMMAND_ENABLE = no    # Commands for debug and configuration
 #SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
 NKRO_ENABLE = yes     # USB Nkey Rollover
-CUSTOM_MATRIX = no # Custom matrix file
 AUDIO_ENABLE = yes
 RGBLIGHT_ENABLE = no
 # SERIAL_LINK_ENABLE = yes
 ENCODER_ENABLE = yes
-RGB_MATRIX_ENABLE = IS31FL3737
 
 LAYOUTS += ortho_4x12
diff --git a/keyboards/planck/keymaps/oryx/keymap.c b/keyboards/planck/keymaps/oryx/keymap.c
index 83b7b42767..55a9168dca 100644
--- a/keyboards/planck/keymaps/oryx/keymap.c
+++ b/keyboards/planck/keymaps/oryx/keymap.c
@@ -53,11 +53,13 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
         eeconfig_init();
       }
       return false;
+#ifdef RGBLIGHT_ENABLE
     case RGB_SLD:
       if (record->event.pressed) {
         rgblight_mode(1);
       }
       return false;
+#endif
   }
   return true;
 }