keyboards/duck/jetfire/config.h

   1 /*
   2 Copyright 2018 MechMerlin
   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       0x444B // Duck ("DK")
  24 #define PRODUCT_ID      0x4A46 // Jetfire ("JF")
  25 #define DEVICE_VER      0x0001
  26 #define MANUFACTURER    Duck
  27 #define PRODUCT         Jetfire
  28 #define DESCRIPTION     A custom keyboard
  29
  30 /* key matrix size */
  31 #define MATRIX_ROWS 6
  32 #define MATRIX_COLS 20
  33
  34 /* COL2ROW, ROW2COL*/
  35 #define DIODE_DIRECTION COL2ROW
  36
  37 #define BACKLIGHT_LEVELS 1
  38
  39 #define RGB_DI_PIN D6
  40 // #ifdef RGB_DI_PIN
  41 #define RGBLIGHT_ANIMATIONS
  42 #define RGBLED_NUM 23
  43 // #define RGBLIGHT_HUE_STEP 8
  44 // #define RGBLIGHT_SAT_STEP 8
  45 // #define RGBLIGHT_VAL_STEP 8
  46 // #endif
  47
  48 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
  49 #define DEBOUNCE 5
  50
  51 /* Set to top left most key */
  52 #define BOOTMAGIC_LITE_ROW 5
  53 #define BOOTMAGIC_LITE_COLUMN 10
  54
  55 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
  56  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
  57  */
  58 // #define GRAVE_ESC_CTRL_OVERRIDE
  59
  60 /*
  61  * Force NKRO
  62  *
  63  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  64  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  65  * makefile for this to work.)
  66  *
  67  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  68  * until the next keyboard reset.
  69  *
  70  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  71  * fully operational during normal computer usage.
  72  *
  73  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  74  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  75  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  76  * power-up.
  77  *
  78  */
  79 //#define FORCE_NKRO
  80
  81 /*
  82  * Magic Key Options
  83  *
  84  * Magic keys are hotkey commands that allow control over firmware functions of
  85  * the keyboard. They are best used in combination with the HID Listen program,
  86  * found here: https://www.pjrc.com/teensy/hid_listen.html
  87  *
  88  * The options below allow the magic key functionality to be changed. This is
  89  * useful if your keyboard/keypad is missing keys and you want magic key support.
  90  *
  91  */
  92
  93 /* control how magic key switches layers */
  94 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
  95 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
  96 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
  97
  98 /* override magic key keymap */
  99 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 100 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 101 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 102 //#define MAGIC_KEY_HELP1          H
 103 //#define MAGIC_KEY_HELP2          SLASH
 104 //#define MAGIC_KEY_DEBUG          D
 105 //#define MAGIC_KEY_DEBUG_MATRIX   X
 106 //#define MAGIC_KEY_DEBUG_KBD      K
 107 //#define MAGIC_KEY_DEBUG_MOUSE    M
 108 //#define MAGIC_KEY_VERSION        V
 109 //#define MAGIC_KEY_STATUS         S
 110 //#define MAGIC_KEY_CONSOLE        C
 111 //#define MAGIC_KEY_LAYER0_ALT1    ESC
 112 //#define MAGIC_KEY_LAYER0_ALT2    GRAVE
 113 //#define MAGIC_KEY_LAYER0         0
 114 //#define MAGIC_KEY_LAYER1         1
 115 //#define MAGIC_KEY_LAYER2         2
 116 //#define MAGIC_KEY_LAYER3         3
 117 //#define MAGIC_KEY_LAYER4         4
 118 //#define MAGIC_KEY_LAYER5         5
 119 //#define MAGIC_KEY_LAYER6         6
 120 //#define MAGIC_KEY_LAYER7         7
 121 //#define MAGIC_KEY_LAYER8         8
 122 //#define MAGIC_KEY_LAYER9         9
 123 //#define MAGIC_KEY_BOOTLOADER     PAUSE
 124 //#define MAGIC_KEY_LOCK           CAPS
 125 //#define MAGIC_KEY_EEPROM         E
 126 //#define MAGIC_KEY_NKRO           N
 127 //#define MAGIC_KEY_SLEEP_LED      Z
 128
 129 /*
 130  * Feature disable options
 131  *  These options are also useful to firmware size reduction.
 132  */
 133
 134 /* disable debug print */
 135 //#define NO_DEBUG
 136
 137 /* disable print */
 138 //#define NO_PRINT
 139
 140 /* disable action features */
 141 //#define NO_ACTION_LAYER
 142 //#define NO_ACTION_TAPPING
 143 //#define NO_ACTION_ONESHOT
 144 //#define NO_ACTION_MACRO
 145 //#define NO_ACTION_FUNCTION
 146
 147 /*
 148  * MIDI options
 149  */
 150
 151 /* Prevent use of disabled MIDI features in the keymap */
 152 //#define MIDI_ENABLE_STRICT 1
 153
 154 /* enable basic MIDI features:
 155    - MIDI notes can be sent when in Music mode is on
 156 */
 157 //#define MIDI_BASIC
 158
 159 /* enable advanced MIDI features:
 160    - MIDI notes can be added to the keymap
 161    - Octave shift and transpose
 162    - Virtual sustain, portamento, and modulation wheel
 163    - etc.
 164 */
 165 //#define MIDI_ADVANCED
 166
 167 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 168 //#define MIDI_TONE_KEYCODE_OCTAVES 1
 169
 170 /*
 171  * HD44780 LCD Display Configuration
 172  */
 173 /*
 174 #define LCD_LINES           2     //< number of visible lines of the display
 175 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 176
 177 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 178
 179 #if LCD_IO_MODE
 180 #define LCD_PORT         PORTB        //< port for the LCD lines
 181 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 182 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 183 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 184 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 185 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 186 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 187 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 188 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 189 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
 190 #define LCD_RS_PIN       3            //< pin  for RS line
 191 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
 192 #define LCD_RW_PIN       2            //< pin  for RW line
 193 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
 194 #define LCD_E_PIN        1            //< pin  for Enable line
 195 #endif
 196 */