keyboards/plaid/config.h

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