keyboards/suihankey/config.h

   1 /*
   2 Copyright 2019 kakunpc
   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    kakunpc
  27 #define PRODUCT         Suihankey
  28 #define DESCRIPTION     A custom keyboard
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 8
  32 #define MATRIX_COLS 5
  33
  34 /*
  35  * Keyboard Matrix Assignments
  36  *
  37  * Change this to how you wired your keyboard
  38  * COLS: AVR pins used for columns, left to right
  39  * ROWS: AVR pins used for rows, top to bottom
  40  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
  41  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
  42  *
  43 */
  44 #define MATRIX_ROW_PINS { F4, F5, F6, F7 }
  45 #define MATRIX_COL_PINS { D4, C6, D7, E6, B4 }
  46 #define UNUSED_PINS
  47 #define USE_I2C
  48 #undef USE_SERIAL
  49
  50 /* COL2ROW, ROW2COL*/
  51 #define DIODE_DIRECTION COL2ROW
  52
  53 /*
  54  * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
  55  */
  56 #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
  57 #define SPLIT_HAND_PIN D2
  58
  59 // #define BACKLIGHT_PIN B7
  60 // #define BACKLIGHT_BREATHING
  61 // #define BACKLIGHT_LEVELS 3
  62
  63 #define RGB_DI_PIN D3
  64 #ifdef RGB_DI_PIN
  65    #define RGBLED_NUM 18
  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 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  92 #define LOCKING_SUPPORT_ENABLE
  93 /* Locking resynchronize hack */
  94 #define LOCKING_RESYNC_ENABLE
  95
  96 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  97  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  98  */
  99 // #define GRAVE_ESC_CTRL_OVERRIDE
 100
 101 /*
 102  * Force NKRO
 103  *
 104  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 105  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 106  * makefile for this to work.)
 107  *
 108  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 109  * until the next keyboard reset.
 110  *
 111  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 112  * fully operational during normal computer usage.
 113  *
 114  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 115  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 116  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 117  * power-up.
 118  *
 119  */
 120 //#define FORCE_NKRO
 121
 122 /*
 123  * Magic Key Options
 124  *
 125  * Magic keys are hotkey commands that allow control over firmware functions of
 126  * the keyboard. They are best used in combination with the HID Listen program,
 127  * found here: https://www.pjrc.com/teensy/hid_listen.html
 128  *
 129  * The options below allow the magic key functionality to be changed. This is
 130  * useful if your keyboard/keypad is missing keys and you want magic key support.
 131  *
 132  */
 133
 134 /* key combination for magic key command */
 135 /* defined by default; to change, uncomment and set to the combination you want */
 136 // #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
 137
 138 /* control how magic key switches layers */
 139 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 140 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 141 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 142
 143 /* override magic key keymap */
 144 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 145 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 146 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 147 //#define MAGIC_KEY_HELP           H
 148 //#define MAGIC_KEY_HELP_ALT       SLASH
 149 //#define MAGIC_KEY_DEBUG          D
 150 //#define MAGIC_KEY_DEBUG_MATRIX   X
 151 //#define MAGIC_KEY_DEBUG_KBD      K
 152 //#define MAGIC_KEY_DEBUG_MOUSE    M
 153 //#define MAGIC_KEY_VERSION        V
 154 //#define MAGIC_KEY_STATUS         S
 155 //#define MAGIC_KEY_CONSOLE        C
 156 //#define MAGIC_KEY_LAYER0         0
 157 //#define MAGIC_KEY_LAYER0_ALT     GRAVE
 158 //#define MAGIC_KEY_LAYER1         1
 159 //#define MAGIC_KEY_LAYER2         2
 160 //#define MAGIC_KEY_LAYER3         3
 161 //#define MAGIC_KEY_LAYER4         4
 162 //#define MAGIC_KEY_LAYER5         5
 163 //#define MAGIC_KEY_LAYER6         6
 164 //#define MAGIC_KEY_LAYER7         7
 165 //#define MAGIC_KEY_LAYER8         8
 166 //#define MAGIC_KEY_LAYER9         9
 167 //#define MAGIC_KEY_BOOTLOADER     B
 168 //#define MAGIC_KEY_BOOTLOADER_ALT ESC
 169 //#define MAGIC_KEY_LOCK           CAPS
 170 //#define MAGIC_KEY_EEPROM         E
 171 //#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 172 //#define MAGIC_KEY_NKRO           N
 173 //#define MAGIC_KEY_SLEEP_LED      Z
 174
 175 /*
 176  * Feature disable options
 177  *  These options are also useful to firmware size reduction.
 178  */
 179
 180 /* disable debug print */
 181 //#define NO_DEBUG
 182
 183 /* disable print */
 184 //#define NO_PRINT
 185
 186 /* disable action features */
 187 //#define NO_ACTION_LAYER
 188 //#define NO_ACTION_TAPPING
 189 //#define NO_ACTION_ONESHOT
 190 //#define NO_ACTION_MACRO
 191 //#define NO_ACTION_FUNCTION
 192
 193 /*
 194  * MIDI options
 195  */
 196
 197 /* Prevent use of disabled MIDI features in the keymap */
 198 //#define MIDI_ENABLE_STRICT 1
 199
 200 /* enable basic MIDI features:
 201    - MIDI notes can be sent when in Music mode is on
 202 */
 203 //#define MIDI_BASIC
 204
 205 /* enable advanced MIDI features:
 206    - MIDI notes can be added to the keymap
 207    - Octave shift and transpose
 208    - Virtual sustain, portamento, and modulation wheel
 209    - etc.
 210 */
 211 //#define MIDI_ADVANCED
 212
 213 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 214 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 215
 216 /*
 217  * HD44780 LCD Display Configuration
 218  */
 219 /*
 220 #define LCD_LINES           2     //< number of visible lines of the display
 221 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 222
 223 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 224
 225 #if LCD_IO_MODE
 226 #define LCD_PORT         PORTB        //< port for the LCD lines
 227 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 228 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 229 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 230 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 231 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 232 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 233 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 234 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 235 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 236 #define LCD_RS_PIN       3            //< pin  for RS line
 237 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 238 #define LCD_RW_PIN       2            //< pin  for RW line
 239 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 240 #define LCD_E_PIN        1            //< pin  for Enable line
 241 #endif
 242 */
 243
 244 /* Bootmagic Lite key configuration */
 245 // #define BOOTMAGIC_LITE_ROW 0
 246 // #define BOOTMAGIC_LITE_COLUMN 0
 247
 248 // #define RGBLED_SPLIT {18,18}