[Keyboard] Move Nyquist/Iris rules.mk files, update READMEs (#7196)
[jackhill/qmk/firmware.git] / keyboards / kinesis / config.h
1 /*
2 Copyright 2012 Jun Wako <wakojun@gmail.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 MANUFACTURER You
26 #define PRODUCT Kinesis Advantage/Contoured
27 #define DESCRIPTION A custom keyboard
28
29 // Mouse
30 #define MOUSEKEY_DELAY 60
31 #define MOUSEKEY_INTERVAL 20
32 #define MOUSEKEY_MAX_SPEED 4
33 #define MOUSEKEY_TIME_TO_MAX 10
34 #define MOUSEKEY_WHEEL_MAX_SPEED 1
35 #define MOUSEKEY_WHEEL_DELTA 1
36 #define MOUSEKEY_WHEEL_TIME_TO_MAX 1
37
38 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
39 #define DEBOUNCE 5
40
41 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
42 #define LOCKING_SUPPORT_ENABLE
43 /* Locking resynchronize hack */
44 #define LOCKING_RESYNC_ENABLE
45
46 /*
47 * Force NKRO
48 *
49 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
50 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
51 * makefile for this to work.)
52 *
53 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
54 * until the next keyboard reset.
55 *
56 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
57 * fully operational during normal computer usage.
58 *
59 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
60 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
61 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
62 * power-up.
63 *
64 */
65 //#define FORCE_NKRO
66
67 /*
68 * Magic Key Options
69 *
70 * Magic keys are hotkey commands that allow control over firmware functions of
71 * the keyboard. They are best used in combination with the HID Listen program,
72 * found here: https://www.pjrc.com/teensy/hid_listen.html
73 *
74 * The options below allow the magic key functionality to be changed. This is
75 * useful if your keyboard/keypad is missing keys and you want magic key support.
76 *
77 */
78
79 /* control how magic key switches layers */
80 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
81 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
82 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
83
84 /* override magic key keymap */
85 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
86 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
87 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
88 //#define MAGIC_KEY_HELP1 H
89 //#define MAGIC_KEY_HELP2 SLASH
90 //#define MAGIC_KEY_DEBUG D
91 //#define MAGIC_KEY_DEBUG_MATRIX X
92 //#define MAGIC_KEY_DEBUG_KBD K
93 //#define MAGIC_KEY_DEBUG_MOUSE M
94 //#define MAGIC_KEY_VERSION V
95 //#define MAGIC_KEY_STATUS S
96 //#define MAGIC_KEY_CONSOLE C
97 //#define MAGIC_KEY_LAYER0_ALT1 ESC
98 //#define MAGIC_KEY_LAYER0_ALT2 GRAVE
99 //#define MAGIC_KEY_LAYER0 0
100 //#define MAGIC_KEY_LAYER1 1
101 //#define MAGIC_KEY_LAYER2 2
102 //#define MAGIC_KEY_LAYER3 3
103 //#define MAGIC_KEY_LAYER4 4
104 //#define MAGIC_KEY_LAYER5 5
105 //#define MAGIC_KEY_LAYER6 6
106 //#define MAGIC_KEY_LAYER7 7
107 //#define MAGIC_KEY_LAYER8 8
108 //#define MAGIC_KEY_LAYER9 9
109 //#define MAGIC_KEY_BOOTLOADER PAUSE
110 //#define MAGIC_KEY_LOCK CAPS
111 //#define MAGIC_KEY_EEPROM E
112 //#define MAGIC_KEY_NKRO N
113 //#define MAGIC_KEY_SLEEP_LED Z
114
115 /*
116 * Feature disable options
117 * These options are also useful to firmware size reduction.
118 */
119
120 /* disable debug print */
121 //#define NO_DEBUG
122
123 /* disable print */
124 //#define NO_PRINT
125
126 /* disable action features */
127 //#define NO_ACTION_LAYER
128 //#define NO_ACTION_TAPPING
129 //#define NO_ACTION_ONESHOT
130 //#define NO_ACTION_MACRO
131 //#define NO_ACTION_FUNCTION
132
133 #ifdef SUBPROJECT_alvicstep
134 #include "alvicstep/config.h"
135 #endif
136 #ifdef SUBPROJECT_stapelberg
137 #include "stapelberg/config.h"
138 #endif
139
140 #endif