keyboards/40percentclub/nori/config.h

   1 /* Copyright 2018
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #pragma once
  18
  19 #include "config_common.h"
  20
  21 /* USB Device descriptor parameter */
  22 #define VENDOR_ID       0xFEED
  23 #define PRODUCT_ID      0x0A0C
  24 #define DEVICE_VER      0x0444
  25 #define MANUFACTURER    di0ib
  26 #define PRODUCT         The nori Keyboard
  27 #define DESCRIPTION     A modular compact keyboard
  28
  29 /* key matrix size */
  30 #define MATRIX_ROWS 4
  31 #define MATRIX_COLS 12
  32
  33 /*
  34  * Keyboard Matrix Assignments
  35  *
  36  * Change this to how you wired your keyboard
  37  * COLS: AVR pins used for columns, left to right
  38  * ROWS: AVR pins used for rows, top to bottom
  39  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  40  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  41  *
  42 */
  43 #define MATRIX_ROW_PINS { D3, D2, D1, D0 }
  44 #define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B6, D4, C6, D7, E6 }
  45 #define UNUSED_PINS
  46
  47 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
  48 #define DIODE_DIRECTION COL2ROW
  49
  50 #define BACKLIGHT_PIN B5
  51 //#define BACKLIGHT_BREATHING
  52 #define BACKLIGHT_LEVELS 3
  53
  54 // enable RGB underglow
  55 #define RGB_DI_PIN B4
  56 #define RGBLIGHT_ANIMATIONS
  57 #define RGBLED_NUM 10
  58 #define RGBLIGHT_HUE_STEP 8
  59 #define RGBLIGHT_SAT_STEP 8
  60 #define RGBLIGHT_VAL_STEP 8
  61
  62 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  63 #define DEBOUNCING_DELAY 5
  64
  65 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  66 //#define MATRIX_HAS_GHOST
  67
  68 /* number of backlight levels */
  69
  70 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  71 #define LOCKING_SUPPORT_ENABLE
  72 /* Locking resynchronize hack */
  73 #define LOCKING_RESYNC_ENABLE
  74
  75 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  76  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  77  */
  78 // #define GRAVE_ESC_CTRL_OVERRIDE
  79
  80 /*
  81  * Force NKRO
  82  *
  83  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  84  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  85  * makefile for this to work.)
  86  *
  87  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  88  * until the next keyboard reset.
  89  *
  90  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  91  * fully operational during normal computer usage.
  92  *
  93  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  94  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  95  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  96  * power-up.
  97  *
  98  */
  99 //#define FORCE_NKRO
 100
 101 /*
 102  * Magic Key Options
 103  *
 104  * Magic keys are hotkey commands that allow control over firmware functions of
 105  * the keyboard. They are best used in combination with the HID Listen program,
 106  * found here: https://www.pjrc.com/teensy/hid_listen.html
 107  *
 108  * The options below allow the magic key functionality to be changed. This is
 109  * useful if your keyboard/keypad is missing keys and you want magic key support.
 110  *
 111  */
 112
 113 /* key combination for magic key command */
 114 #define IS_COMMAND() ( \
 115     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
 116 )
 117
 118 /* control how magic key switches layers */
 119 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 120 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 121 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 122
 123 /* override magic key keymap */
 124 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 125 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 126 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 127 //#define MAGIC_KEY_HELP1          H
 128 //#define MAGIC_KEY_HELP2          SLASH
 129 //#define MAGIC_KEY_DEBUG          D
 130 //#define MAGIC_KEY_DEBUG_MATRIX   X
 131 //#define MAGIC_KEY_DEBUG_KBD      K
 132 //#define MAGIC_KEY_DEBUG_MOUSE    M
 133 //#define MAGIC_KEY_VERSION        V
 134 //#define MAGIC_KEY_STATUS         S
 135 //#define MAGIC_KEY_CONSOLE        C
 136 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 137 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 138 //#define MAGIC_KEY_LAYER0         0
 139 //#define MAGIC_KEY_LAYER1         1
 140 //#define MAGIC_KEY_LAYER2         2
 141 //#define MAGIC_KEY_LAYER3         3
 142 //#define MAGIC_KEY_LAYER4         4
 143 //#define MAGIC_KEY_LAYER5         5
 144 //#define MAGIC_KEY_LAYER6         6
 145 //#define MAGIC_KEY_LAYER7         7
 146 //#define MAGIC_KEY_LAYER8         8
 147 //#define MAGIC_KEY_LAYER9         9
 148 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 149 //#define MAGIC_KEY_LOCK           CAPS
 150 //#define MAGIC_KEY_EEPROM         E
 151 //#define MAGIC_KEY_NKRO           N
 152 //#define MAGIC_KEY_SLEEP_LED      Z
 153
 154 /*
 155  * Feature disable options
 156  *  These options are also useful to firmware size reduction.
 157  */
 158
 159 /* disable debug print */
 160 //#define NO_DEBUG
 161
 162 /* disable print */
 163 //#define NO_PRINT
 164
 165 /* disable action features */
 166 //#define NO_ACTION_LAYER
 167 //#define NO_ACTION_TAPPING
 168 //#define NO_ACTION_ONESHOT
 169 //#define NO_ACTION_MACRO
 170 //#define NO_ACTION_FUNCTION
 171
 172 /*
 173  * MIDI options
 174  */
 175
 176 /* Prevent use of disabled MIDI features in the keymap */
 177 //#define MIDI_ENABLE_STRICT 1
 178
 179 /* enable basic MIDI features:
 180    - MIDI notes can be sent when in Music mode is on
 181 */
 182 //#define MIDI_BASIC
 183
 184 /* enable advanced MIDI features:
 185    - MIDI notes can be added to the keymap
 186    - Octave shift and transpose
 187    - Virtual sustain, portamento, and modulation wheel
 188    - etc.
 189 */
 190 //#define MIDI_ADVANCED
 191
 192 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 193 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 194
 195 /*
 196  * HD44780 LCD Display Configuration
 197  */
 198 /*
 199 #define LCD_LINES           2     //< number of visible lines of the display
 200 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 201
 202 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 203
 204 #if LCD_IO_MODE
 205 #define LCD_PORT         PORTB        //< port for the LCD lines
 206 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 207 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 208 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 209 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 210 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 211 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 212 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 213 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 214 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 215 #define LCD_RS_PIN       3            //< pin  for RS line
 216 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 217 #define LCD_RW_PIN       2            //< pin  for RW line
 218 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 219 #define LCD_E_PIN        1            //< pin  for Enable line
 220 #endif
 221 */