mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-27 05:36:52 +00:00
acd3e79add
* Nk65 initial commit
* Minor fix for compatibility
* Make everything pretty
* Update keyboards/nk65/config.h
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update keyboards/nk65/readme.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Chmod Dummy
* Update getting_started_introduction.md
* Revert "Update getting_started_introduction.md"
This reverts commit daf446acf7.
155 lines
5.3 KiB
C
Executable File
155 lines
5.3 KiB
C
Executable File
/*
|
|
Copyright 2019 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 "config_common.h"
|
|
|
|
/* USB Device descriptor parameter */
|
|
#define VENDOR_ID 0x8968
|
|
#define PRODUCT_ID 0x4E4B
|
|
#define DEVICE_VER 0x0001
|
|
#define MANUFACTURER Yiancar-Designs
|
|
#define PRODUCT NK65
|
|
#define DESCRIPTION A 65-percent, tool-free RGB keyboard
|
|
|
|
/* key matrix size */
|
|
#define MATRIX_ROWS 5
|
|
#define MATRIX_COLS 15
|
|
|
|
#define MATRIX_ROW_PINS { B3, B4, B5, A8, A4 }
|
|
#define MATRIX_COL_PINS { A13, A10, A9, A14, A15, B8, B9, C13, C14, C15, A0, A1, A2, A3, A5 }
|
|
// To enable debugger set A13 A14 -> A5 A7
|
|
|
|
/* COL2ROW, ROW2COL*/
|
|
#define DIODE_DIRECTION COL2ROW
|
|
|
|
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
|
|
#define DEBOUNCING_DELAY 5
|
|
|
|
/* define if matrix has ghost (lacks anti-ghosting diodes) */
|
|
//#define MATRIX_HAS_GHOST
|
|
|
|
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
|
|
* This is userful for the Windows task manager shortcut (ctrl+shift+esc).
|
|
*/
|
|
// #define GRAVE_ESC_CTRL_OVERRIDE
|
|
|
|
/*
|
|
* Force NKRO
|
|
*
|
|
* Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
|
|
* state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
|
|
* makefile for this to work.)
|
|
*
|
|
* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
|
|
* until the next keyboard reset.
|
|
*
|
|
* NKRO may prevent your keystrokes from being detected in the BIOS, but it is
|
|
* fully operational during normal computer usage.
|
|
*
|
|
* For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
|
|
* or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
|
|
* bootmagic, NKRO mode will always be enabled until it is toggled again during a
|
|
* power-up.
|
|
*
|
|
*/
|
|
//#define FORCE_NKRO
|
|
|
|
/*
|
|
* Magic Key Options
|
|
*
|
|
* Magic keys are hotkey commands that allow control over firmware functions of
|
|
* the keyboard. They are best used in combination with the HID Listen program,
|
|
* found here: https://www.pjrc.com/teensy/hid_listen.html
|
|
*
|
|
* The options below allow the magic key functionality to be changed. This is
|
|
* useful if your keyboard/keypad is missing keys and you want magic key support.
|
|
*
|
|
*/
|
|
|
|
/* Backlight options */
|
|
|
|
#define RGB_BACKLIGHT_ENABLED 1
|
|
|
|
#define RGB_BACKLIGHT_NK65
|
|
|
|
// 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 255
|
|
|
|
// 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 DRIVER_COUNT 2
|
|
#define DRIVER_LED_TOTAL 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
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b0110000000000001
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b0100000000000001
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0110000000000001
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b0111000000000001
|
|
#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b0111111000000111
|
|
|
|
#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 }
|
|
|
|
// TODO: refactor with new user EEPROM code (coming soon)
|
|
#define EEPROM_MAGIC 0x451F
|
|
#define EEPROM_MAGIC_ADDR 32
|
|
// Bump this every time we change what we store
|
|
// This will automatically reset the EEPROM with defaults
|
|
// and avoid loading invalid data from the EEPROM
|
|
#define EEPROM_VERSION 0x08
|
|
#define EEPROM_VERSION_ADDR 34
|
|
|
|
// Backlight config starts after EEPROM version
|
|
#define RGB_BACKLIGHT_CONFIG_EEPROM_ADDR 35
|
|
// Dynamic keymap starts after backlight config (35+32)
|
|
#define DYNAMIC_KEYMAP_EEPROM_ADDR 67
|
|
#define DYNAMIC_KEYMAP_LAYER_COUNT 4
|
|
// Dynamic macro starts after dynamic keymaps (67+(4*5*15*2)) = (67+600)
|
|
#define DYNAMIC_KEYMAP_MACRO_EEPROM_ADDR 667
|
|
#define DYNAMIC_KEYMAP_MACRO_EEPROM_SIZE 398
|
|
#define DYNAMIC_KEYMAP_MACRO_COUNT 16
|