351694a111fec804b73578951b194b09db5c383a
[jackhill/qmk/firmware.git] / keyboards / cu24 / config.h
1 /* Copyright 2018 Yiancar
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17 #ifndef CONFIG_H
18 #define CONFIG_H
19
20 #include "config_common.h"
21
22 /* USB Device descriptor parameter */
23 #define VENDOR_ID 0xFEED
24 #define PRODUCT_ID 0x0000
25 #define DEVICE_VER 0x0001
26 #define MANUFACTURER Yiancar/CapsUnlocked
27 #define PRODUCT CU24
28 #define DESCRIPTION A luxurious fully customisable numpad
29
30 /* key matrix size */
31 #define MATRIX_ROWS 6
32 #define MATRIX_COLS 4
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 { E6, F5, B4, B6, C6, C7 }
45 #define MATRIX_COL_PINS { F0, F1, D0, D1 }
46 #define UNUSED_PINS
47
48 /* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
49 #define DIODE_DIRECTION ROW2COL
50
51 /* Backlight */
52 #define BACKLIGHT_PIN B5
53 #define BACKLIGHT_BREATHING
54 #define BACKLIGHT_LEVELS 5
55
56 /* RGB Glow */
57 #define RGB_DI_PIN F4 // The pin the LED strip is connected to
58 #define RGBLED_NUM 5 // Number of LEDs in your strip
59 #define RGBLIGHT_ANIMATIONS
60
61 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
62 #define DEBOUNCING_DELAY 5
63
64 /* define if matrix has ghost (lacks anti-ghosting diodes) */
65 //#define MATRIX_HAS_GHOST
66
67 /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
68 #define LOCKING_SUPPORT_ENABLE
69 /* Locking resynchronize hack */
70 #define LOCKING_RESYNC_ENABLE
71
72 /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
73 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
74 */
75 // #define GRAVE_ESC_CTRL_OVERRIDE
76
77 /*
78 * Force NKRO
79 *
80 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
81 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
82 * makefile for this to work.)
83 *
84 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
85 * until the next keyboard reset.
86 *
87 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
88 * fully operational during normal computer usage.
89 *
90 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
91 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
92 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
93 * power-up.
94 *
95 */
96 //#define FORCE_NKRO
97
98 /*
99 * Magic Key Options
100 *
101 * Magic keys are hotkey commands that allow control over firmware functions of
102 * the keyboard. They are best used in combination with the HID Listen program,
103 * found here: https://www.pjrc.com/teensy/hid_listen.html
104 *
105 * The options below allow the magic key functionality to be changed. This is
106 * useful if your keyboard/keypad is missing keys and you want magic key support.
107 *
108 */
109
110 /* control how magic key switches layers */
111 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
112 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
113 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
114
115 /* override magic key keymap */
116 //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
117 //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
118 //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
119 //#define MAGIC_KEY_HELP1 H
120 //#define MAGIC_KEY_HELP2 SLASH
121 //#define MAGIC_KEY_DEBUG D
122 //#define MAGIC_KEY_DEBUG_MATRIX X
123 //#define MAGIC_KEY_DEBUG_KBD K
124 //#define MAGIC_KEY_DEBUG_MOUSE M
125 //#define MAGIC_KEY_VERSION V
126 //#define MAGIC_KEY_STATUS S
127 //#define MAGIC_KEY_CONSOLE C
128 //#define MAGIC_KEY_LAYER0_ALT1 ESC
129 //#define MAGIC_KEY_LAYER0_ALT2 GRAVE
130 //#define MAGIC_KEY_LAYER0 0
131 //#define MAGIC_KEY_LAYER1 1
132 //#define MAGIC_KEY_LAYER2 2
133 //#define MAGIC_KEY_LAYER3 3
134 //#define MAGIC_KEY_LAYER4 4
135 //#define MAGIC_KEY_LAYER5 5
136 //#define MAGIC_KEY_LAYER6 6
137 //#define MAGIC_KEY_LAYER7 7
138 //#define MAGIC_KEY_LAYER8 8
139 //#define MAGIC_KEY_LAYER9 9
140 //#define MAGIC_KEY_BOOTLOADER PAUSE
141 //#define MAGIC_KEY_LOCK CAPS
142 //#define MAGIC_KEY_EEPROM E
143 //#define MAGIC_KEY_NKRO N
144 //#define MAGIC_KEY_SLEEP_LED Z
145
146 /*
147 * Feature disable options
148 * These options are also useful to firmware size reduction.
149 */
150
151 /* disable debug print */
152 //#define NO_DEBUG
153
154 /* disable print */
155 //#define NO_PRINT
156
157 /* disable action features */
158 //#define NO_ACTION_LAYER
159 //#define NO_ACTION_TAPPING
160 //#define NO_ACTION_ONESHOT
161 //#define NO_ACTION_MACRO
162 //#define NO_ACTION_FUNCTION
163
164 /*
165 * MIDI options
166 */
167
168 /* Prevent use of disabled MIDI features in the keymap */
169 //#define MIDI_ENABLE_STRICT 1
170
171 /* enable basic MIDI features:
172 - MIDI notes can be sent when in Music mode is on
173 */
174 //#define MIDI_BASIC
175
176 /* enable advanced MIDI features:
177 - MIDI notes can be added to the keymap
178 - Octave shift and transpose
179 - Virtual sustain, portamento, and modulation wheel
180 - etc.
181 */
182 //#define MIDI_ADVANCED
183
184 /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
185 //#define MIDI_TONE_KEYCODE_OCTAVES 1
186
187 #endif