keyboards/hid_liber/config.h

   1 /* Copyright 2012 Jun Wako <wakojun@gmail.com>: Original Configuration
   2  * Copyright 2018 bakageta <amo@bakageta.com>
   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 #ifndef CONFIG_H
  19 #define CONFIG_H
  20
  21 #include "config_common.h"
  22
  23 /* USB Device descriptor parameter */
  24 #define VENDOR_ID       0xFEED
  25 #define PRODUCT_ID      0xB919
  26 #define DEVICE_VER      0x0001
  27 #define MANUFACTURER    "bpiphany"
  28 #define USBSTR_MANUFACTURER 'b', '\x00', 'p', '\x00', 'i', '\x00', 'p', '\x00', 'h', '\x00', 'a', '\x00', 'n', '\x00', 'y', '\x00'
  29 #define PRODUCT         "HIDLiberation"
  30 #define USBSTR_PRODUCT 'H', '\x00', 'I', '\x00', 'D', '\x00', ' ', '\x00', 'L', '\x00', 'i', '\x00', 'b', '\x00', 'e', '\x00', 'r', '\x00', 'a', '\x00', 't', '\x00', 'i', '\x00', 'o', '\x00', 'n', '\x00'
  31 #define DESCRIPTION     "HID Liberation powered by QMK"
  32
  33 /* key matrix size */
  34 #define MATRIX_ROWS 18
  35 #define MATRIX_COLS 8
  36
  37 // HID Liberation Device uses custom matrix code to accomodate a 74HC238 3 to 8 decoder on pins B1, B2 and B3.
  38 #define DIODE_DIRECTION CUSTOM_MATRIX
  39
  40 // #define BACKLIGHT_PIN B7
  41 // #define BACKLIGHT_BREATHING
  42 // #define BACKLIGHT_LEVELS 3
  43
  44 /* define if matrix has ghost */
  45 //#define MATRIX_HAS_GHOST
  46
  47 /* Set 0 if debouncing isn't needed */
  48 #define DEBOUNCING_DELAY 5
  49
  50 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
  51 #define LOCKING_SUPPORT_ENABLE
  52 /* Locking resynchronize hack */
  53 #define LOCKING_RESYNC_ENABLE
  54
  55 /*
  56  * Force NKRO
  57  *
  58  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
  59  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
  60  * makefile for this to work.)
  61  *
  62  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
  63  * until the next keyboard reset.
  64  *
  65  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
  66  * fully operational during normal computer usage.
  67  *
  68  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
  69  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
  70  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
  71  * power-up.
  72  *
  73  */
  74 //#define FORCE_NKRO
  75
  76 /*
  77  * Magic Key Options
  78  *
  79  * Magic keys are hotkey commands that allow control over firmware functions of
  80  * the keyboard. They are best used in combination with the HID Listen program,
  81  * found here: https://www.pjrc.com/teensy/hid_listen.html
  82  *
  83  * The options below allow the magic key functionality to be changed. This is
  84  * useful if your keyboard/keypad is missing keys and you want magic key support.
  85  *
  86  */
  87
  88 /* key combination for magic key command */
  89 #define IS_COMMAND() ( \
  90     keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
  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 #endif