Convert `novelkeys/nk87` to use RGB Matrix (#26349)

keyboards/novelkeys/nk87/config.h

@@ -1,76 +1,9 @@
-/*
-Copyright 2020 Yiancar
-
-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/>.
-*/
-
+// Copyright 2020 Yiancar
+// SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
-/* Backlight options */
-
-#define RGB_BACKLIGHT_ENABLED 1
-
-#define RGB_BACKLIGHT_NK87
-
-// they aren't really used if RGB_BACKLIGHT_HS60 defined
-#define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 0
-#define RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT 0
-#define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 0
-#define RGB_BACKLIGHT_USE_7U_SPACEBAR 0
-#define RGB_BACKLIGHT_USE_ISO_ENTER 0
-#define RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS 0
-
-// disable backlight when USB suspended (PC sleep/hibernate/shutdown)
-#define RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED 0
-
-// disable backlight after timeout in minutes, 0 = no timeout
-#define RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT 0
-
-// the default brightness
-#define RGB_BACKLIGHT_BRIGHTNESS 255
-
-// the default effect (RGB test)
-#define RGB_BACKLIGHT_EFFECT 6
-
-// the default effect speed (0-3)
-#define RGB_BACKLIGHT_EFFECT_SPEED 0
-
-// the default color1 and color2
-#define RGB_BACKLIGHT_COLOR_1 { .h = 0, .s = 255 }
-#define RGB_BACKLIGHT_COLOR_2 { .h = 127, .s = 255 }
-
 #define IS31FL3733_I2C_ADDRESS_1 IS31FL3733_I2C_ADDRESS_GND_GND
 #define IS31FL3733_I2C_ADDRESS_2 IS31FL3733_I2C_ADDRESS_GND_SDA
-#define IS31FL3733_LED_COUNT 128
-
-// These define which keys in the matrix are alphas/mods
-// Used for backlight effects so colors are different for
-// alphas vs. mods
-// Each value is for a row, bit 0 is column 0
-// Alpha=0 Mod=1
-// Rows are shifted one down, F-row cannot be dynamically modified at the moment.
-#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b1110000000000000
-#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b1100000000000001
-#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0010000000000001
-#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b1001000000000001
-#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b1111100000000111
-
-#define RGB_BACKLIGHT_CAPS_LOCK_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
-#define RGB_BACKLIGHT_LAYER_1_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
-#define RGB_BACKLIGHT_LAYER_2_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
-#define RGB_BACKLIGHT_LAYER_3_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 }
 
-// Backlight config starts after VIA's EEPROM usage,
-// dynamic keymaps start after this.
-#define VIA_EEPROM_CUSTOM_CONFIG_SIZE 32
+#define IS31FL3733_SW_PULLUP IS31FL3733_PUR_0K5_OHM
+#define IS31FL3733_CS_PULLDOWN IS31FL3733_PDR_0K5_OHM

keyboards/novelkeys/nk87/halconf.h

@@ -1,33 +1,7 @@
-/* Copyright 2020 QMK
- *
- * 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/>.
- */
-
-/*
- * This file was auto-generated by:
- *    `qmk chibios-confmigrate -i keyboards/nk87/halconf.h -r platforms/chibios/QMK_PROTON_C/configs/halconf.h`
- */
-
+// Copyright 2020 Yiancar
+// SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
-#define HAL_USE_PWM FALSE
-
-#define HAL_USE_SPI FALSE
-
-#define PAL_USE_CALLBACKS FALSE
-
-#define PAL_USE_WAIT FALSE
+#define HAL_USE_I2C TRUE
 
 #include_next <halconf.h>
-

keyboards/novelkeys/nk87/keyboard.json

@@ -12,6 +12,7 @@
         "bootmagic": true,
         "extrakey": true,
         "mousekey": true,
+        "rgb_matrix": true,
         "nkro": true
     },
     "matrix_pins": {
@@ -21,7 +22,152 @@
     "diode_direction": "COL2ROW",
     "processor": "STM32F303",
     "bootloader": "stm32-dfu",
-    "board": "QMK_PROTON_C",
+    "rgb_matrix": {
+        "driver": "is31fl3733",
+        "sleep": true,
+        "animations": {
+            "alphas_mods": true,
+            "gradient_up_down": true,
+            "gradient_left_right": true,
+            "breathing": true,
+            "band_sat": true,
+            "band_val": true,
+            "band_pinwheel_sat": true,
+            "band_pinwheel_val": true,
+            "band_spiral_sat": true,
+            "band_spiral_val": true,
+            "cycle_all": true,
+            "cycle_left_right": true,
+            "cycle_up_down": true,
+            "cycle_out_in": true,
+            "cycle_out_in_dual": true,
+            "rainbow_moving_chevron": true,
+            "cycle_pinwheel": true,
+            "cycle_spiral": true,
+            "dual_beacon": true,
+            "rainbow_beacon": true,
+            "rainbow_pinwheels": true,
+            "raindrops": true,
+            "jellybean_raindrops": true,
+            "hue_breathing": true,
+            "hue_pendulum": true,
+            "hue_wave": true,
+            "pixel_fractal": true,
+            "pixel_flow": true,
+            "pixel_rain": true,
+            "typing_heatmap": true,
+            "digital_rain": true,
+            "solid_reactive_simple": true,
+            "solid_reactive": true,
+            "solid_reactive_wide": true,
+            "solid_reactive_multiwide": true,
+            "solid_reactive_cross": true,
+            "solid_reactive_multicross": true,
+            "solid_reactive_nexus": true,
+            "solid_reactive_multinexus": true,
+            "splash": true,
+            "multisplash": true,
+            "solid_splash": true,
+            "solid_multisplash": true
+        },
+        "layout": [
+            { "flags": 4, "matrix": [0,  0], "x":   6, "y":  8 },
+            { "flags": 4, "matrix": [0,  1], "x":  21, "y":  8 },
+            { "flags": 4, "matrix": [0,  2], "x":  33, "y":  8 },
+            { "flags": 4, "matrix": [0,  3], "x":  45, "y":  8 },
+            { "flags": 4, "matrix": [0,  4], "x":  57, "y":  8 },
+            { "flags": 4, "matrix": [0,  5], "x":  74, "y":  8 },
+            { "flags": 4, "matrix": [0,  6], "x":  86, "y":  8 },
+            { "flags": 4, "matrix": [0,  7], "x":  98, "y":  8 },
+            { "flags": 4, "matrix": [0,  8], "x": 110, "y":  8 },
+            { "flags": 4, "matrix": [0,  9], "x": 125, "y":  8 },
+            { "flags": 4, "matrix": [0, 10], "x": 137, "y":  8 },
+            { "flags": 4, "matrix": [0, 11], "x": 150, "y":  8 },
+            { "flags": 4, "matrix": [0, 12], "x": 161, "y":  8 },
+            { "flags": 4, "matrix": [0, 13], "x": 176, "y":  8 },
+            { "flags": 4, "matrix": [0, 14], "x": 192, "y":  8 },
+            { "flags": 4, "matrix": [0, 15], "x": 204, "y":  8 },
+            { "flags": 4, "matrix": [0, 16], "x": 217, "y":  8 },
+
+            { "flags": 4, "matrix": [1,  0], "x":   6, "y": 21 },
+            { "flags": 4, "matrix": [1,  1], "x":  18, "y": 21 },
+            { "flags": 4, "matrix": [1,  2], "x":  30, "y": 21 },
+            { "flags": 4, "matrix": [1,  3], "x":  43, "y": 21 },
+            { "flags": 4, "matrix": [1,  4], "x":  55, "y": 21 },
+            { "flags": 4, "matrix": [1,  5], "x":  67, "y": 21 },
+            { "flags": 4, "matrix": [1,  6], "x":  79, "y": 21 },
+            { "flags": 4, "matrix": [1,  7], "x":  92, "y": 21 },
+            { "flags": 4, "matrix": [1,  8], "x": 104, "y": 21 },
+            { "flags": 4, "matrix": [1,  9], "x": 116, "y": 21 },
+            { "flags": 4, "matrix": [1, 10], "x": 128, "y": 21 },
+            { "flags": 4, "matrix": [1, 11], "x": 141, "y": 21 },
+            { "flags": 4, "matrix": [1, 12], "x": 153, "y": 21 },
+            { "flags": 4, "matrix": [1, 13], "x": 171, "y": 21 },
+            { "flags": 4, "matrix": [1, 14], "x": 192, "y": 21 },
+            { "flags": 4, "matrix": [1, 15], "x": 204, "y": 21 },
+            { "flags": 4, "matrix": [1, 16], "x": 217, "y": 21 },
+
+            { "flags": 4, "matrix": [2,  0], "x":   9, "y": 31 },
+            { "flags": 4, "matrix": [2,  1], "x":  24, "y": 31 },
+            { "flags": 4, "matrix": [2,  2], "x":  36, "y": 31 },
+            { "flags": 4, "matrix": [2,  3], "x":  48, "y": 31 },
+            { "flags": 4, "matrix": [2,  4], "x":  61, "y": 31 },
+            { "flags": 4, "matrix": [2,  5], "x":  73, "y": 31 },
+            { "flags": 4, "matrix": [2,  6], "x":  86, "y": 31 },
+            { "flags": 4, "matrix": [2,  7], "x":  98, "y": 31 },
+            { "flags": 4, "matrix": [2,  8], "x": 110, "y": 31 },
+            { "flags": 4, "matrix": [2,  9], "x": 122, "y": 31 },
+            { "flags": 4, "matrix": [2, 10], "x": 134, "y": 31 },
+            { "flags": 4, "matrix": [2, 11], "x": 146, "y": 31 },
+            { "flags": 4, "matrix": [2, 12], "x": 159, "y": 31 },
+            { "flags": 4, "matrix": [3, 12], "x": 174, "y": 31 },
+            { "flags": 4, "matrix": [2, 14], "x": 192, "y": 31 },
+            { "flags": 4, "matrix": [2, 15], "x": 204, "y": 31 },
+            { "flags": 4, "matrix": [2, 16], "x": 217, "y": 31 },
+
+            { "flags": 4, "matrix": [3,  0], "x":  11, "y": 41 },
+            { "flags": 4, "matrix": [3,  1], "x":  27, "y": 41 },
+            { "flags": 4, "matrix": [3,  2], "x":  40, "y": 41 },
+            { "flags": 4, "matrix": [3,  3], "x":  52, "y": 41 },
+            { "flags": 4, "matrix": [3,  4], "x":  64, "y": 41 },
+            { "flags": 4, "matrix": [3,  5], "x":  76, "y": 41 },
+            { "flags": 4, "matrix": [3,  6], "x":  88, "y": 41 },
+            { "flags": 4, "matrix": [3,  7], "x": 100, "y": 41 },
+            { "flags": 4, "matrix": [3,  8], "x": 113, "y": 41 },
+            { "flags": 4, "matrix": [3,  9], "x": 124, "y": 41 },
+            { "flags": 4, "matrix": [3, 10], "x": 137, "y": 41 },
+            { "flags": 4, "matrix": [3, 11], "x": 150, "y": 41 },
+            { "flags": 4, "matrix": [3, 13], "x": 170, "y": 41 },
+
+            { "flags": 4, "matrix": [4,  0], "x":  13, "y": 51 },
+            { "flags": 4, "matrix": [4,  2], "x":  34, "y": 51 },
+            { "flags": 4, "matrix": [4,  3], "x":  45, "y": 51 },
+            { "flags": 4, "matrix": [4,  4], "x":  58, "y": 51 },
+            { "flags": 4, "matrix": [4,  5], "x":  70, "y": 51 },
+            { "flags": 4, "matrix": [4,  6], "x":  82, "y": 51 },
+            { "flags": 4, "matrix": [4,  7], "x":  94, "y": 51 },
+            { "flags": 4, "matrix": [4,  8], "x": 107, "y": 51 },
+            { "flags": 4, "matrix": [4,  9], "x": 119, "y": 51 },
+            { "flags": 4, "matrix": [4, 10], "x": 131, "y": 51 },
+            { "flags": 4, "matrix": [4, 11], "x": 143, "y": 51 },
+            { "flags": 4, "matrix": [4, 12], "x": 166, "y": 51 },
+            { "flags": 4, "matrix": [4, 15], "x": 204, "y": 51 },
+
+            { "flags": 4, "matrix": [5,  0], "x":   8, "y": 61 },
+            { "flags": 4, "matrix": [5,  1], "x":  23, "y": 61 },
+            { "flags": 4, "matrix": [5,  2], "x":  38, "y": 61 },
+            { "flags": 4, "matrix": [5,  6], "x":  84, "y": 61 },
+            { "flags": 4, "matrix": [5, 11], "x": 135, "y": 61 },
+            { "flags": 4, "matrix": [5, 12], "x": 152, "y": 61 },
+            { "flags": 4, "matrix": [5, 13], "x": 170, "y": 61 },
+            { "flags": 4, "matrix": [5, 14], "x": 192, "y": 61 },
+            { "flags": 4, "matrix": [5, 15], "x": 204, "y": 61 },
+            { "flags": 4, "matrix": [5, 16], "x": 217, "y": 61 },
+            { "flags": 1, "x": 224, "y": 0 },
+            { "flags": 1, "x": 224, "y": 5 },
+            { "flags": 1, "x": 224, "y": 10 }
+        ]
+    },
     "community_layouts": ["tkl_f13_ansi_tsangan"],
     "layout_aliases": {
         "LAYOUT_all": "LAYOUT_tkl_f13_ansi_tsangan"

keyboards/novelkeys/nk87/keymaps/default/keymap.c

@@ -1,34 +1,21 @@
-/* Copyright 2020 Yiancar
- *
- * 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/>.
- */
+// Copyright 2020 Yiancar
+// SPDX-License-Identifier: GPL-2.0-or-later
 #include QMK_KEYBOARD_H
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 [0] = LAYOUT_tkl_f13_ansi_tsangan( /* Base */
-    KC_ESC,  KC_F1,   KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_F13,  KC_PSCR, KC_SCRL, KC_PAUS,
-    KC_GRV,  KC_1,    KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_INS,  KC_HOME, KC_PGUP,
-    KC_TAB,  KC_Q,    KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,  KC_END,  KC_PGDN,
-    KC_CAPS, KC_A,    KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,
-    KC_LSFT, KC_Z,    KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,                   KC_UP,
-    KC_LCTL, KC_LGUI, KC_LALT,                KC_SPC,                                            KC_RALT, MO(1),   KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
+    KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_F13,  KC_PSCR, KC_SCRL, KC_PAUS,
+    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_INS,  KC_HOME, KC_PGUP,
+    KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,  KC_END,  KC_PGDN,
+    KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,
+    KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,                   KC_UP,
+    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                               KC_RALT, MO(1),   KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
 
 [1] = LAYOUT_tkl_f13_ansi_tsangan( /* FN */
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_VOLU, KC_VOLD, KC_MUTE,
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, QK_BOOT, KC_TRNS, KC_TRNS, KC_TRNS,
-    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, S1_DEC,  S1_INC,  S2_DEC,  S2_INC,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,          KC_TRNS,
-    KC_TRNS, EF_DEC,  EF_INC,  H1_DEC,  H1_INC,  H2_DEC,  H2_INC,  BR_DEC,  BR_INC,  ES_DEC,  ES_INC,           KC_TRNS,                   KC_TRNS,
-    KC_TRNS, KC_TRNS, KC_TRNS,                   KC_TRNS,                                              KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_VOLU, KC_VOLD, KC_MUTE,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, QK_BOOT, _______, _______, _______,
+    _______, RM_TOGG, _______, _______, RM_SATD, RM_SATU, _______, _______, _______, _______, _______, _______,         _______,
+    _______, RM_PREV, RM_NEXT, RM_HUED, RM_HUEU, _______, _______, RM_VALD, RM_VALU, RM_SPDD, RM_SPDU,          _______,                   _______,
+    _______, _______, _______,                   _______,                                              _______, _______, _______, _______, _______, _______),
 };

keyboards/novelkeys/nk87/keymaps/default/readme.md

@@ -1,7 +0,0 @@
-# The default keymap for NK87
-
-![Layer 0](https://i.imgur.com/nw29fvc.png)
-Fn Layer:
-![Layer 1](https://i.imgur.com/SyijLFt.png)
-
-Default layer is normal ANSI TKL

keyboards/novelkeys/nk87/matrix_diagram.md

@@ -1,18 +0,0 @@
-# Matrix Diagram for NK87
-
-```
-┌───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┐┌───┬───┬───┐
-│00 ││01 │02 │03 │04 ││05 │06 │07 │08 ││09 │0A │0B │0C ││0D ││0E │0F │0G │
-└───┘└───┴───┴───┴───┘└───┴───┴───┴───┘└───┴───┴───┴───┘└───┘└───┴───┴───┘
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐┌───┬───┬───┐
-│10 │11 │12 │13 │14 │15 │16 │17 │18 │19 │1A │1B │1C │1D     ││1E │1F │1G │
-├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤├───┼───┼───┤
-│20   │21 │22 │23 │24 │25 │26 │27 │28 │29 │2A │2B │2C │3C   ││2E │2F │2G │
-├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤└───┴───┴───┘
-│30    │31 │32 │33 │34 │35 │36 │37 │38 │39 │3A │3B │3D      │
-├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤    ┌───┐
-│40      │42 │43 │44 │45 │46 │47 │48 │49 │4A │4B │4C        │    │4F │
-├─────┬──┴┬──┴──┬┴───┴───┴───┴───┴───┴───┴──┬┴───┴┬───┬─────┤┌───┼───┼───┐
-│50   │51 │52   │56                         │5B   │5C │5D   ││5E │5F │5G │
-└─────┴───┴─────┴───────────────────────────┴─────┴───┴─────┘└───┴───┴───┘
-```

keyboards/novelkeys/nk87/mcuconf.h

@@ -1,43 +1,8 @@
-/* Copyright 2020 QMK
- *
- * 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/>.
- */
-
-/*
- * This file was auto-generated by:
- *    `qmk chibios-confmigrate -i keyboards/nk87/mcuconf.h -r platforms/chibios/QMK_PROTON_C/configs/mcuconf.h`
- */
-
+// Copyright 2020 Yiancar
+// SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
 #include_next <mcuconf.h>
 
-#undef STM32_GPT_USE_TIM4
-#define STM32_GPT_USE_TIM4 TRUE
-
-#undef STM32_GPT_USE_TIM15
-#define STM32_GPT_USE_TIM15 FALSE
-
-#undef STM32_PWM_USE_TIM3
-#define STM32_PWM_USE_TIM3 FALSE
-
-#undef STM32_PWM_USE_TIM4
-#define STM32_PWM_USE_TIM4 FALSE
-
-#undef STM32_SERIAL_USE_USART2
-#define STM32_SERIAL_USE_USART2 FALSE
-
-#undef STM32_SPI_USE_SPI2
-#define STM32_SPI_USE_SPI2 FALSE
-
+#undef STM32_I2C_USE_I2C1
+#define STM32_I2C_USE_I2C1 TRUE

keyboards/novelkeys/nk87/nk87.c

@@ -1,26 +1,8 @@
-/* Copyright 2020 Yiancar
- *
- * 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/>.
- */
-#ifndef RGB_BACKLIGHT_NK87
-#error RGB_BACKLIGHT_NK87 not defined, recheck config.h
-#endif
+// Copyright 2020 Yiancar
+// SPDX-License-Identifier: GPL-2.0-or-later
+#include "quantum.h"
 
-#include "nk87.h"
-#include "drivers/led/issi/is31fl3733.h"
-
-#if defined(RGB_MATRIX_ENABLE) || defined(RGB_BACKLIGHT_NK87)
+#if defined(RGB_MATRIX_ENABLE)
 const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
 /* Refer to IS31 manual for these locations
  *   driver
@@ -28,171 +10,134 @@ const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
  *   |  |      G location
  *   |  |      |      B location
  *   |  |      |      | */
+    {1, SW2_CS1,   SW1_CS1,   SW3_CS1}, //LB1
+    {1, SW2_CS2,   SW1_CS2,   SW3_CS2}, //LB5
+    {1, SW2_CS3,   SW1_CS3,   SW3_CS3}, //LB9
+    {1, SW2_CS4,   SW1_CS4,   SW3_CS4}, //LB13
+    {1, SW2_CS5,   SW1_CS5,   SW3_CS5}, //LB17
+    {1, SW2_CS6,   SW1_CS6,   SW3_CS6}, //LB21
+    {1, SW2_CS7,   SW1_CS7,   SW3_CS7}, //LB25
+    {1, SW2_CS8,   SW1_CS8,   SW3_CS8}, //LB29
+    {1, SW2_CS9,   SW1_CS9,   SW3_CS9}, //LB33
+    {1, SW2_CS10,  SW1_CS10,  SW3_CS10}, //LB37
+    {1, SW2_CS11,  SW1_CS11,  SW3_CS11}, //LB41
+    {1, SW2_CS12,  SW1_CS12,  SW3_CS12}, //LB45
+    {1, SW2_CS13,  SW1_CS13,  SW3_CS13}, //LB49
+    {1, SW2_CS14,  SW1_CS14,  SW3_CS14}, //LB53
+    {1, SW2_CS15,  SW1_CS15,  SW3_CS15}, //LB57
+    {1, SW2_CS16,  SW1_CS16,  SW3_CS16}, //LB61
+    {1, SW11_CS16, SW10_CS16, SW12_CS16}, //LB64
+
     {0, SW2_CS1,   SW1_CS1,   SW3_CS1}, //LA1
-    {0, SW5_CS1,   SW4_CS1,   SW6_CS1}, //LA2
-    {0, SW8_CS1,   SW7_CS1,   SW9_CS1}, //LA3
-    {0, SW11_CS1,   SW10_CS1,   SW12_CS1}, //LA4
     {0, SW2_CS2,   SW1_CS2,   SW3_CS2}, //LA5
-    {0, SW5_CS2,   SW4_CS2,   SW6_CS2}, //LA6
-    {0, SW8_CS2,   SW7_CS2,   SW9_CS2}, //LA7
-    {0, SW11_CS2,   SW10_CS2,   SW12_CS2}, //LA8
     {0, SW2_CS3,   SW1_CS3,   SW3_CS3}, //LA9
-    {0, SW5_CS3,   SW4_CS3,   SW6_CS3}, //LA10
-    {0, SW8_CS3,   SW7_CS3,   SW9_CS3}, //LA11
-    {0, SW11_CS3,   SW10_CS3,   SW12_CS3}, //LA12
     {0, SW2_CS4,   SW1_CS4,   SW3_CS4}, //LA13
-    {0, SW5_CS4,   SW4_CS4,   SW6_CS4}, //LA14
-    {0, SW8_CS4,   SW7_CS4,   SW9_CS4}, //LA15
-    {0, SW11_CS4,   SW10_CS4,   SW12_CS4}, //LA16
     {0, SW2_CS5,   SW1_CS5,   SW3_CS5}, //LA17
-    {0, SW5_CS5,   SW4_CS5,   SW6_CS5}, //LA18
-    {0, SW8_CS5,   SW7_CS5,   SW9_CS5}, //LA19
-    {0, SW11_CS5,   SW10_CS5,   SW12_CS5}, //LA20
     {0, SW2_CS6,   SW1_CS6,   SW3_CS6}, //LA21
-    {0, SW5_CS6,   SW4_CS6,   SW6_CS6}, //LA22
-    {0, SW8_CS6,   SW7_CS6,   SW9_CS6}, //LA23
-    {0, SW11_CS6,   SW10_CS6,   SW12_CS6}, //LA24
     {0, SW2_CS7,   SW1_CS7,   SW3_CS7}, //LA25
-    {0, SW5_CS7,   SW4_CS7,   SW6_CS7}, //LA26
-    {0, SW8_CS7,   SW7_CS7,   SW9_CS7}, //LA27
-    {0, SW11_CS7,   SW10_CS7,   SW12_CS7}, //LA28
     {0, SW2_CS8,   SW1_CS8,   SW3_CS8}, //LA29
-    {0, SW5_CS8,   SW4_CS8,   SW6_CS8}, //LA30
-    {0, SW8_CS8,   SW7_CS8,   SW9_CS8}, //LA31
-    {0, SW11_CS8,   SW10_CS8,   SW12_CS8}, //LA32
     {0, SW2_CS9,   SW1_CS9,   SW3_CS9}, //LA33
-    {0, SW5_CS9,   SW4_CS9,   SW6_CS9}, //LA34
-    {0, SW8_CS9,   SW7_CS9,   SW9_CS9}, //LA35
-    {0, SW11_CS9,   SW10_CS9,   SW12_CS9}, //LA36
     {0, SW2_CS10,  SW1_CS10,  SW3_CS10}, //LA37
-    {0, SW5_CS10,  SW4_CS10,  SW6_CS10}, //LA38
-    {0, SW8_CS10,  SW7_CS10,  SW9_CS10}, //LA39
-    {0, SW11_CS10,  SW10_CS10,  SW12_CS10}, //LA40
     {0, SW2_CS11,  SW1_CS11,  SW3_CS11}, //LA41
-    {0, SW5_CS11,  SW4_CS11,  SW6_CS11}, //LA42
-    {0, SW8_CS11,  SW7_CS11,  SW9_CS11}, //LA43
-    {0, SW11_CS11,  SW10_CS11,  SW12_CS11}, //LA44
     {0, SW2_CS12,  SW1_CS12,  SW3_CS12}, //LA45
-    {0, SW5_CS12,  SW4_CS12,  SW6_CS12}, //LA46
-    {0, SW8_CS12,  SW7_CS12,  SW9_CS12}, //LA47
-    {0, SW11_CS12,  SW10_CS12,  SW12_CS12}, //LA48
     {0, SW2_CS13,  SW1_CS13,  SW3_CS13}, //LA49
-    {0, SW5_CS13,  SW4_CS13,  SW6_CS13}, //LA50
-    {0, SW8_CS13,  SW7_CS13,  SW9_CS13}, //LA51
-    {0, SW11_CS13,  SW10_CS13,  SW12_CS13}, //LA52
     {0, SW2_CS14,  SW1_CS14,  SW3_CS14}, //LA53
+    {1, SW11_CS13, SW10_CS13, SW12_CS13}, //LB52
+    {1, SW11_CS14, SW10_CS14, SW12_CS14}, //LB56
+    {1, SW11_CS15, SW10_CS15, SW12_CS15}, //LB60
+
+    {0, SW5_CS1,   SW4_CS1,   SW6_CS1}, //LA2
+    {0, SW5_CS2,   SW4_CS2,   SW6_CS2}, //LA6
+    {0, SW5_CS3,   SW4_CS3,   SW6_CS3}, //LA10
+    {0, SW5_CS4,   SW4_CS4,   SW6_CS4}, //LA14
+    {0, SW5_CS5,   SW4_CS5,   SW6_CS5}, //LA18
+    {0, SW5_CS6,   SW4_CS6,   SW6_CS6}, //LA22
+    {0, SW5_CS7,   SW4_CS7,   SW6_CS7}, //LA26
+    {0, SW5_CS8,   SW4_CS8,   SW6_CS8}, //LA30
+    {0, SW5_CS9,   SW4_CS9,   SW6_CS9}, //LA34
+    {0, SW5_CS10,  SW4_CS10,  SW6_CS10}, //LA38
+    {0, SW5_CS11,  SW4_CS11,  SW6_CS11}, //LA42
+    {0, SW5_CS12,  SW4_CS12,  SW6_CS12}, //LA46
+    {0, SW5_CS13,  SW4_CS13,  SW6_CS13}, //LA50
     {0, SW5_CS14,  SW4_CS14,  SW6_CS14}, //LA54
+    {1, SW8_CS13,  SW7_CS13,  SW9_CS13}, //LB51
+    {1, SW8_CS14,  SW7_CS14,  SW9_CS14}, //LB55
+    {1, SW8_CS15,  SW7_CS15,  SW9_CS15}, //LB59
+
+    {0, SW8_CS1,   SW7_CS1,   SW9_CS1}, //LA3
+    {0, SW8_CS2,   SW7_CS2,   SW9_CS2}, //LA7
+    {0, SW8_CS3,   SW7_CS3,   SW9_CS3}, //LA11
+    {0, SW8_CS4,   SW7_CS4,   SW9_CS4}, //LA15
+    {0, SW8_CS5,   SW7_CS5,   SW9_CS5}, //LA19
+    {0, SW8_CS6,   SW7_CS6,   SW9_CS6}, //LA23
+    {0, SW8_CS7,   SW7_CS7,   SW9_CS7}, //LA27
+    {0, SW8_CS8,   SW7_CS8,   SW9_CS8}, //LA31
+    {0, SW8_CS9,   SW7_CS9,   SW9_CS9}, //LA35
+    {0, SW8_CS10,  SW7_CS10,  SW9_CS10}, //LA39
+    {0, SW8_CS11,  SW7_CS11,  SW9_CS11}, //LA43
+    {0, SW8_CS12,  SW7_CS12,  SW9_CS12}, //LA47
     {0, SW8_CS14,  SW7_CS14,  SW9_CS14}, //LA55
-    {0, SW11_CS14,  SW10_CS14,  SW12_CS14}, //LA56
+
+    {0, SW11_CS1,  SW10_CS1,  SW12_CS1}, //LA4
+    {0, SW11_CS2,  SW10_CS2,  SW12_CS2}, //LA8
+    {0, SW11_CS3,  SW10_CS3,  SW12_CS3}, //LA12
+    {0, SW11_CS4,  SW10_CS4,  SW12_CS4}, //LA16
+    {0, SW11_CS5,  SW10_CS5,  SW12_CS5}, //LA20
+    {0, SW11_CS6,  SW10_CS6,  SW12_CS6}, //LA24
+    {0, SW11_CS7,  SW10_CS7,  SW12_CS7}, //LA28
+    {0, SW11_CS8,  SW10_CS8,  SW12_CS8}, //LA32
+    {0, SW11_CS9,  SW10_CS9,  SW12_CS9}, //LA36
+    {0, SW11_CS10, SW10_CS10, SW12_CS10}, //LA40
+    {0, SW11_CS11, SW10_CS11, SW12_CS11}, //LA44
+    {0, SW8_CS13,  SW7_CS13,  SW9_CS13}, //LA51
+    {0, SW11_CS13, SW10_CS13, SW12_CS13}, //LA52
+
     {0, SW2_CS15,  SW1_CS15,  SW3_CS15}, //LA57
     {0, SW5_CS15,  SW4_CS15,  SW6_CS15}, //LA58
     {0, SW8_CS15,  SW7_CS15,  SW9_CS15}, //LA59
-    {0, SW11_CS15,  SW10_CS15,  SW12_CS15}, //LA60
-    {0, SW2_CS16,  SW1_CS16,  SW3_CS16}, //LA61
+    {0, SW11_CS15, SW10_CS15, SW12_CS15}, //LA60
     {0, SW5_CS16,  SW4_CS16,  SW6_CS16}, //LA62
     {0, SW8_CS16,  SW7_CS16,  SW9_CS16}, //LA63
-    {0, SW11_CS16,  SW10_CS16,  SW12_CS16}, //LA64
+    {0, SW11_CS16, SW10_CS16, SW12_CS16}, //LA64
+    {0, SW11_CS12, SW10_CS12, SW12_CS12}, //LA48
+    {0, SW11_CS14, SW10_CS14, SW12_CS14}, //LA56
+    {1, SW11_CS3,  SW10_CS3,  SW12_CS3}, //LB12
 
-    {1, SW2_CS1,   SW1_CS1,   SW3_CS1}, //LB1
-    {1, SW5_CS1,   SW4_CS1,   SW6_CS1}, //LB2
-    {1, SW8_CS1,   SW7_CS1,   SW9_CS1}, //LB3
-    {1, SW11_CS1,   SW10_CS1,   SW12_CS1}, //LB4
-    {1, SW2_CS2,   SW1_CS2,   SW3_CS2}, //LB5
-    {1, SW5_CS2,   SW4_CS2,   SW6_CS2}, //LB6
-    {1, SW8_CS2,   SW7_CS2,   SW9_CS2}, //LB7
-    {1, SW11_CS2,   SW10_CS2,   SW12_CS2}, //LB8
-    {1, SW2_CS3,   SW1_CS3,   SW3_CS3}, //LB9
-    {1, SW5_CS3,   SW4_CS3,   SW6_CS3}, //LB10
-    {1, SW8_CS3,   SW7_CS3,   SW9_CS3}, //LB11
-    {1, SW11_CS3,   SW10_CS3,   SW12_CS3}, //LB12
-    {1, SW2_CS4,   SW1_CS4,   SW3_CS4}, //LB13
-    {1, SW5_CS4,   SW4_CS4,   SW6_CS4}, //LB14
-    {1, SW8_CS4,   SW7_CS4,   SW9_CS4}, //LB15
-    {1, SW11_CS4,   SW10_CS4,   SW12_CS4}, //LB16
-    {1, SW2_CS5,   SW1_CS5,   SW3_CS5}, //LB17
-    {1, SW5_CS5,   SW4_CS5,   SW6_CS5}, //LB18
-    {1, SW8_CS5,   SW7_CS5,   SW9_CS5}, //LB19
-    {1, SW11_CS5,   SW10_CS5,   SW12_CS5}, //LB20
-    {1, SW2_CS6,   SW1_CS6,   SW3_CS6}, //LB21
-    {1, SW5_CS6,   SW4_CS6,   SW6_CS6}, //LB22
-    {1, SW8_CS6,   SW7_CS6,   SW9_CS6}, //LB23
-    {1, SW11_CS6,   SW10_CS6,   SW12_CS6}, //LB24
-    {1, SW2_CS7,   SW1_CS7,   SW3_CS7}, //LB25
-    {1, SW5_CS7,   SW4_CS7,   SW6_CS7}, //LB26
-    {1, SW8_CS7,   SW7_CS7,   SW9_CS7}, //LB27
-    {1, SW11_CS7,   SW10_CS7,   SW12_CS7}, //LB28
-    {1, SW2_CS8,   SW1_CS8,   SW3_CS8}, //LB29
-    {1, SW5_CS8,   SW4_CS8,   SW6_CS8}, //LB30
-    {1, SW8_CS8,   SW7_CS8,   SW9_CS8}, //LB31
-    {1, SW11_CS8,   SW10_CS8,   SW12_CS8}, //LB32
-    {1, SW2_CS9,   SW1_CS9,   SW3_CS9}, //LB33
-    {1, SW5_CS9,   SW4_CS9,   SW6_CS9}, //LB34
-    {1, SW8_CS9,   SW7_CS9,   SW9_CS9}, //LB35
-    {1, SW11_CS9,   SW10_CS9,   SW12_CS9}, //LB36
-    {1, SW2_CS10,  SW1_CS10,  SW3_CS10}, //LB37
-    {1, SW5_CS10,  SW4_CS10,  SW6_CS10}, //LB38
-    {1, SW8_CS10,  SW7_CS10,  SW9_CS10}, //LB39
-    {1, SW11_CS10,  SW10_CS10,  SW12_CS10}, //LB40
-    {1, SW2_CS11,  SW1_CS11,  SW3_CS11}, //LB41
-    {1, SW5_CS11,  SW4_CS11,  SW6_CS11}, //LB42
-    {1, SW8_CS11,  SW7_CS11,  SW9_CS11}, //LB43
-    {1, SW11_CS11,  SW10_CS11,  SW12_CS11}, //LB44
-    {1, SW2_CS12,  SW1_CS12,  SW3_CS12}, //LB45
-    {1, SW5_CS12,  SW4_CS12,  SW6_CS12}, //LB46
-    {1, SW8_CS12,  SW7_CS12,  SW9_CS12}, //LB47
-    {1, SW11_CS12,  SW10_CS12,  SW12_CS12}, //LB48
-    {1, SW2_CS13,  SW1_CS13,  SW3_CS13}, //LB49
-    {1, SW5_CS13,  SW4_CS13,  SW6_CS13}, //LB50
-    {1, SW8_CS13,  SW7_CS13,  SW9_CS13}, //LB51
-    {1, SW11_CS13,  SW10_CS13,  SW12_CS13}, //LB52
-    {1, SW2_CS14,  SW1_CS14,  SW3_CS14}, //LB53
-    {1, SW5_CS14,  SW4_CS14,  SW6_CS14}, //LB54
-    {1, SW8_CS14,  SW7_CS14,  SW9_CS14}, //LB55
-    {1, SW11_CS14,  SW10_CS14,  SW12_CS14}, //LB56
-    {1, SW2_CS15,  SW1_CS15,  SW3_CS15}, //LB57
-    {1, SW5_CS15,  SW4_CS15,  SW6_CS15}, //LB58
-    {1, SW8_CS15,  SW7_CS15,  SW9_CS15}, //LB59
-    {1, SW11_CS15,  SW10_CS15,  SW12_CS15}, //LB60
-    {1, SW2_CS16,  SW1_CS16,  SW3_CS16}, //LB61
-    {1, SW5_CS16,  SW4_CS16,  SW6_CS16}, //LB62
-    {1, SW8_CS16,  SW7_CS16,  SW9_CS16}, //LB63
-    {1, SW11_CS16,  SW10_CS16,  SW12_CS16}, //LB64
+    // Mapped with "dead" locations so each indicator is logically separate
+    {1, SW5_CS16,  SW4_CS16,  SW9_CS16}, //LB63 - top indi
+    {1, SW8_CS16,  SW7_CS16,  SW6_CS16}, //LB63 - mid indi
+    {1, SW11_CS12, SW10_CS12, SW12_CS12}, //LB48 - bot indi
 };
-#endif
 
 /* Indicator LEDS are part of the LED driver
  * Top LED is blue only. LED driver 2 RGB 63 Blue channel
  * Middle LED is blue and red. LED driver 2 RGB 63 Red and Green channel
  * Bottom LED is red only LED driver 2 RGB 48 Blue channel.
  */
-uint8_t CAPS = 0;
-uint8_t FN1 = 0;
-uint8_t FN2 = 0;
+bool rgb_matrix_indicators_kb(void) {
+    if (!rgb_matrix_indicators_user()) {
+        return false;
+    }
 
-bool led_update_kb(led_t led_state) {
-    bool res = led_update_user(led_state);
-    if(res) {
-        if (led_state.caps_lock) {
-            CAPS = 255;
-        } else {
-            CAPS = 0;
-        }
+    if (host_keyboard_led_state().caps_lock) {
+        rgb_matrix_set_color(87, RGB_WHITE);
+    } else {
+        rgb_matrix_set_color(87, RGB_OFF);
     }
-    is31fl3733_set_color( 63+64-1, FN1, FN1, CAPS );
-    is31fl3733_set_color( 48+64-1, 0, 0, FN2 );
-    return res;
-}
 
-__attribute__((weak)) layer_state_t layer_state_set_user(layer_state_t state) {
+    layer_state_t state = layer_state|default_layer_state;
     if (state & (1UL << 1)) {
-        FN1 = 255;
+        rgb_matrix_set_color(88, RGB_WHITE);
     } else {
-        FN1 = 0;
+        rgb_matrix_set_color(88, RGB_OFF);
     }
+
     if (state & (1UL << 2)) {
-        FN2 = 255;
+        rgb_matrix_set_color(89, RGB_WHITE);
     } else {
-        FN2 = 0;
+        rgb_matrix_set_color(89, RGB_OFF);
     }
-  return state;
+
+    return true;
 }
+#endif

keyboards/novelkeys/nk87/nk87.h

@@ -1,19 +0,0 @@
-/* Copyright 2020 Yiancar
- *
- * 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
-
-#include "quantum.h"
-#include "../wilba_tech/wt_rgb_backlight_keycodes.h"

keyboards/novelkeys/nk87/readme.md

@@ -8,27 +8,20 @@ This is a standard fixed layout TKL PCB. It supports VIA and full per-key RGB.
 * Hardware Supported: A TKL keyboard with STM32F303CC
 * Hardware Availability: https://novelkeys.xyz/
 
-## Instructions
-
-### Build
-
 Make example for this keyboard (after setting up your build environment):
 
     make novelkeys/nk87: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).
+Flashing example for this keyboard:
 
-### Reset
+    make novelkeys/nk87:default:flash
+
+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).
 
-- Unplug
-- Hold Escape
-- Plug In
-- Unplug
-- Release Escape
+## Bootloader
 
-### Flash
+Enter the bootloader in 3 ways:
 
-- Unplug
-- Hold Escape
-- Plug In
-- Flash using QMK Toolbox or dfu-util (`make nk87:<keymap>:dfu-util`)
+* **Bootmagic reset**: Hold down the top left key and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

keyboards/novelkeys/nk87/rules.mk

@@ -1,13 +0,0 @@
-# Do not put the microcontroller into power saving mode
-# when we get USB suspend event. We want it to keep updating
-# backlight effects.
-NO_SUSPEND_POWER_DOWN = yes
-
-CIE1931_CURVE = yes
-I2C_DRIVER_REQUIRED = yes
-
-# project specific files
-SRC =	keyboards/wilba_tech/wt_main.c \
-		keyboards/wilba_tech/wt_rgb_backlight.c \
-		drivers/led/issi/is31fl3733.c \
-		quantum/color.c