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