keyboards/abstract/ellipse/rev1/config.h

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