keyboards/handwired/aranck/config.h

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