Skip to content

Convert novelkeys/nk87 to use RGB Matrix #26349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zvecr wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Convert novelkeys/nk87 to use RGB Matrix #26349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 4 additions & 71 deletions keyboards/novelkeys/nk87/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
32 changes: 3 additions & 29 deletions keyboards/novelkeys/nk87/halconf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>

148 changes: 147 additions & 1 deletion keyboards/novelkeys/nk87/keyboard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"bootmagic": true,
"extrakey": true,
"mousekey": true,
"rgb_matrix": true,
"nkro": true
},
"matrix_pins": {
Expand All @@ -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"
Expand Down
41 changes: 14 additions & 27 deletions keyboards/novelkeys/nk87/keymaps/default/keymap.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
};
7 changes: 0 additions & 7 deletions keyboards/novelkeys/nk87/keymaps/default/readme.md
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions keyboards/novelkeys/nk87/matrix_diagram.md
View file
Open in desktop

This file was deleted.

Loading