keyboards/keebio/ergodicity/config.h

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