keyboards/otaku_split/rev1/config.h

   1 /*
   2 Copyright 2019 takashiski
   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 #define VENDOR_ID       0xFEED
  24 #define PRODUCT_ID      0x0000
  25 #define DEVICE_VER      0x0001
  26 #define MANUFACTURER    takashiski
  27 #define PRODUCT         otaku_split
  28 #define DESCRIPTION     A custom keyboard
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 10
  32 #define MATRIX_COLS 8
  33
  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 { C6,D7,E6,B4,B5 }
  46 #define MATRIX_COL_PINS { F4,F5,F6,F7,B1,B3,B2,B6 }
  47 #define MATRIX_ROW_PINS_RIGHT { B5,B4,E6,D7,C6 }
  48 #define MATRIX_COL_PINS_RIGHT { B6,B2,B3,B1,F7,F6,F5,F4 }
  49 #define UNUSED_PINS
  50
  51 /* COL2ROW, ROW2COL*/
  52 #define DIODE_DIRECTION COL2ROW
  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 #define SPLIT_HAND_PIN D2 //fix pin. HIGH is left, LOW is right
  59
  60 // #define BACKLIGHT_PIN B7
  61 // #define BACKLIGHT_BREATHING
  62 // #define BACKLIGHT_LEVELS 3
  63
  64 // #define RGB_DI_PIN E2
  65 // #ifdef RGB_DI_PIN
  66 //   #define RGBLED_NUM 16
  67 //   #define RGBLIGHT_HUE_STEP 8
  68 //   #define RGBLIGHT_SAT_STEP 8
  69 //   #define RGBLIGHT_VAL_STEP 8
  70 //   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
  71 //   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
  72 // /*== all animations enable ==*/
  73 //   #define RGBLIGHT_ANIMATIONS
  74 // /*== or choose animations ==*/
  75 //   #define RGBLIGHT_EFFECT_BREATHING
  76 //   #define RGBLIGHT_EFFECT_RAINBOW_MOOD
  77 //   #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
  78 //   #define RGBLIGHT_EFFECT_SNAKE
  79 //   #define RGBLIGHT_EFFECT_KNIGHT
  80 //   #define RGBLIGHT_EFFECT_CHRISTMAS
  81 //   #define RGBLIGHT_EFFECT_STATIC_GRADIENT
  82 //   #define RGBLIGHT_EFFECT_RGB_TEST
  83 //   #define RGBLIGHT_EFFECT_ALTERNATING
  84 // /*== customize breathing effect ==*/
  85 //   /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
  86 //   #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
  87 //   /*==== use exp() and sin() ====*/
  88 //   #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
  89 //   #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
  90 // #endif
  91
  92 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  93 #define DEBOUNCE 5
  94
  95 /* define if matrix has ghost (lacks anti-ghosting diodes) */
  96 //#define MATRIX_HAS_GHOST
  97
  98 /* number of backlight levels */
  99
 100 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
 101 #define LOCKING_SUPPORT_ENABLE
 102 /* Locking resynchronize hack */
 103 #define LOCKING_RESYNC_ENABLE
 104
 105 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 106  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 107  */
 108 // #define GRAVE_ESC_CTRL_OVERRIDE
 109
 110 /*
 111  * Force NKRO
 112  *
 113  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 114  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 115  * makefile for this to work.)
 116  *
 117  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 118  * until the next keyboard reset.
 119  *
 120  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 121  * fully operational during normal computer usage.
 122  *
 123  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 124  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 125  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 126  * power-up.
 127  *
 128  */
 129 //#define FORCE_NKRO
 130
 131 /*
 132  * Magic Key Options
 133  *
 134  * Magic keys are hotkey commands that allow control over firmware functions of
 135  * the keyboard. They are best used in combination with the HID Listen program,
 136  * found here: https://www.pjrc.com/teensy/hid_listen.html
 137  *
 138  * The options below allow the magic key functionality to be changed. This is
 139  * useful if your keyboard/keypad is missing keys and you want magic key support.
 140  *
 141  */
 142
 143 /* key combination for magic key command */
 144 /* defined by default; to change, uncomment and set to the combination you want */
 145 // #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
 146
 147 /* control how magic key switches layers */
 148 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 149 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 150 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 151
 152 /* override magic key keymap */
 153 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 154 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 155 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 156 //#define MAGIC_KEY_HELP           H
 157 //#define MAGIC_KEY_HELP_ALT       SLASH
 158 //#define MAGIC_KEY_DEBUG          D
 159 //#define MAGIC_KEY_DEBUG_MATRIX   X
 160 //#define MAGIC_KEY_DEBUG_KBD      K
 161 //#define MAGIC_KEY_DEBUG_MOUSE    M
 162 //#define MAGIC_KEY_VERSION        V
 163 //#define MAGIC_KEY_STATUS         S
 164 //#define MAGIC_KEY_CONSOLE        C
 165 //#define MAGIC_KEY_LAYER0         0
 166 //#define MAGIC_KEY_LAYER0_ALT     GRAVE
 167 //#define MAGIC_KEY_LAYER1         1
 168 //#define MAGIC_KEY_LAYER2         2
 169 //#define MAGIC_KEY_LAYER3         3
 170 //#define MAGIC_KEY_LAYER4         4
 171 //#define MAGIC_KEY_LAYER5         5
 172 //#define MAGIC_KEY_LAYER6         6
 173 //#define MAGIC_KEY_LAYER7         7
 174 //#define MAGIC_KEY_LAYER8         8
 175 //#define MAGIC_KEY_LAYER9         9
 176 //#define MAGIC_KEY_BOOTLOADER     B
 177 //#define MAGIC_KEY_BOOTLOADER_ALT ESC
 178 //#define MAGIC_KEY_LOCK           CAPS
 179 //#define MAGIC_KEY_EEPROM         E
 180 //#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 181 //#define MAGIC_KEY_NKRO           N
 182 //#define MAGIC_KEY_SLEEP_LED      Z
 183
 184 /*
 185  * Feature disable options
 186  *  These options are also useful to firmware size reduction.
 187  */
 188
 189 /* disable debug print */
 190 //#define NO_DEBUG
 191
 192 /* disable print */
 193 //#define NO_PRINT
 194
 195 /* disable action features */
 196 //#define NO_ACTION_LAYER
 197 //#define NO_ACTION_TAPPING
 198 //#define NO_ACTION_ONESHOT
 199 //#define NO_ACTION_MACRO
 200 //#define NO_ACTION_FUNCTION
 201
 202 /*
 203  * MIDI options
 204  */
 205
 206 /* Prevent use of disabled MIDI features in the keymap */
 207 //#define MIDI_ENABLE_STRICT 1
 208
 209 /* enable basic MIDI features:
 210    - MIDI notes can be sent when in Music mode is on
 211 */
 212 //#define MIDI_BASIC
 213
 214 /* enable advanced MIDI features:
 215    - MIDI notes can be added to the keymap
 216    - Octave shift and transpose
 217    - Virtual sustain, portamento, and modulation wheel
 218    - etc.
 219 */
 220 //#define MIDI_ADVANCED
 221
 222 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 223 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 224
 225 /*
 226  * HD44780 LCD Display Configuration
 227  */
 228 /*
 229 #define LCD_LINES           2     //< number of visible lines of the display
 230 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 231
 232 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 233
 234 #if LCD_IO_MODE
 235 #define LCD_PORT         PORTB        //< port for the LCD lines
 236 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 237 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 238 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 239 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 240 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 241 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 242 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 243 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 244 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 245 #define LCD_RS_PIN       3            //< pin  for RS line
 246 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 247 #define LCD_RW_PIN       2            //< pin  for RW line
 248 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 249 #define LCD_E_PIN        1            //< pin  for Enable line
 250 #endif
 251 */
 252
 253 /* Bootmagic Lite key configuration */
 254 // #define BOOTMAGIC_LITE_ROW 0
 255 // #define BOOTMAGIC_LITE_COLUMN 0