keyboards/ai03/orbit/config.h

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