qmk_firmware/keyboards/ergodox_ez/config.h

/*
Copyright 2012 Jun Wako <wakojun@gmail.com>
Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef ERGODOX_EZ_CONFIG_H
#define ERGODOX_EZ_CONFIG_H

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0x1307
#define DEVICE_VER      0x0001
#define MANUFACTURER    ErgoDox EZ
#define PRODUCT         ErgoDox EZ
#define DESCRIPTION     QMK keyboard firmware for Ergodox EZ

/* key matrix size */
#define MATRIX_ROWS 14
#define MATRIX_COLS 6

#define MOUSEKEY_INTERVAL       20
#define MOUSEKEY_DELAY          0
#define MOUSEKEY_TIME_TO_MAX    60
#define MOUSEKEY_MAX_SPEED      7
#define MOUSEKEY_WHEEL_DELAY 0

#define TAPPING_TOGGLE  1

/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST

#define TAPPING_TERM    200
#define IGNORE_MOD_TAP_INTERRUPT // this makes it possible to do rolling combos (zx) with keys that convert to other keys on hold (z becomes ctrl when you hold it, and when this option isn't enabled, z rapidly followed by x actually sends Ctrl-x. That's bad.)

/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
#define LOCKING_SUPPORT_ENABLE
/* Locking resynchronize hack */
#define LOCKING_RESYNC_ENABLE

/* key combination for command */
#define IS_COMMAND() ( \
    keyboard_report->mods == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL)) || \
    keyboard_report->mods == (MOD_BIT(KC_LSFT) | MOD_BIT(KC_RSFT)) \
)

/* number of backlight levels */
#define BACKLIGHT_LEVELS 3

#define LED_BRIGHTNESS_LO       15
#define LED_BRIGHTNESS_HI       255

/* ws2812 RGB LED */
#define RGB_DI_PIN D7
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 15     // Number of LEDs
#define RGBLIGHT_HUE_STEP 12
#define RGBLIGHT_SAT_STEP 255
#define RGBLIGHT_VAL_STEP 12

/* fix space cadet rollover issue */
#define DISABLE_SPACE_CADET_ROLLOVER

// #define RGB_MIDI
#define RGBW_BB_TWI

#define RGBW 1

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE    15

#define PREVENT_STUCK_MODIFIERS

#define USB_MAX_POWER_CONSUMPTION 500

// #define RGBLIGHT_COLOR_LAYER_0 0x00, 0x00, 0xFF
/* #define RGBLIGHT_COLOR_LAYER_1 0x00, 0x00, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_2 0xFF, 0x00, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_3 0x00, 0xFF, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_4 0xFF, 0xFF, 0x00 */
/* #define RGBLIGHT_COLOR_LAYER_5 0x00, 0xFF, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_6 0xFF, 0x00, 0xFF */
/* #define RGBLIGHT_COLOR_LAYER_7 0xFF, 0xFF, 0xFF */

/*
 * Feature disable options
 *  These options are also useful to firmware size reduction.
 */

/* disable debug print */
// #define NO_DEBUG

/* disable print */
// #define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
//#define NO_ACTION_MACRO
//#define NO_ACTION_FUNCTION
//#define DEBUG_MATRIX_SCAN_RATE

#endif
added ergodox 2015-10-26 21:32:37 +01:00			`/*`
			`Copyright 2012 Jun Wako <wakojun@gmail.com>`
			`Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com>`

			`This program is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation, either version 2 of the License, or`
			`(at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`
			`*/`

Fix config.h include guards 2016-07-10 11:01:28 +02:00			`#ifndef ERGODOX_EZ_CONFIG_H`
			`#define ERGODOX_EZ_CONFIG_H`
added ergodox 2015-10-26 21:32:37 +01:00
fix infinity 2016-11-22 02:17:32 +01:00			`#include "config_common.h"`

added ergodox 2015-10-26 21:32:37 +01:00			`/* USB Device descriptor parameter */`
			`#define VENDOR_ID 0xFEED`
			`#define PRODUCT_ID 0x1307`
			`#define DEVICE_VER 0x0001`
			`#define MANUFACTURER ErgoDox EZ`
			`#define PRODUCT ErgoDox EZ`
Improves debounce 2016-07-04 18:01:10 +02:00			`#define DESCRIPTION QMK keyboard firmware for Ergodox EZ`
added ergodox 2015-10-26 21:32:37 +01:00
			`/* key matrix size */`
			`#define MATRIX_ROWS 14`
			`#define MATRIX_COLS 6`

Creates a layouts/ folder for keymaps shared between keyboards (#1609) * include variables and .h files as pp directives * start layout compilation * split ergodoxes up * don't compile all layouts for everything * might seg fault * reset layouts variable * actually reset layouts * include rules.mk instead * remove includes from rules.mk * update variable setting * load visualizer from path * adds some more examples * adds more layouts * more boards added * more boards added * adds documentation for layouts * use lowercase names for LAYOUT_ * add layout.json files for each layout * add community folder, default keymaps for layouts * touch-up default layouts * touch-up layouts, some keyboard rules.mk * update documentation for layouts * fix up serial/i2c switches 2017-08-24 04:29:07 +02:00			`#define MOUSEKEY_INTERVAL 20`
			`#define MOUSEKEY_DELAY 0`
			`#define MOUSEKEY_TIME_TO_MAX 60`
			`#define MOUSEKEY_MAX_SPEED 7`
			`#define MOUSEKEY_WHEEL_DELAY 0`

			`#define TAPPING_TOGGLE 1`

			`/* define if matrix has ghost */`
			`//#define MATRIX_HAS_GHOST`

			`#define TAPPING_TERM 200`
			`#define IGNORE_MOD_TAP_INTERRUPT // this makes it possible to do rolling combos (zx) with keys that convert to other keys on hold (z becomes ctrl when you hold it, and when this option isn't enabled, z rapidly followed by x actually sends Ctrl-x. That's bad.)`

			`/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */`
			`#define LOCKING_SUPPORT_ENABLE`
			`/* Locking resynchronize hack */`
			`#define LOCKING_RESYNC_ENABLE`

			`/* key combination for command */`
			`#define IS_COMMAND() ( \`
			`keyboard_report->mods == (MOD_BIT(KC_LCTL) \| MOD_BIT(KC_RCTL)) \|\| \`
			`keyboard_report->mods == (MOD_BIT(KC_LSFT) \| MOD_BIT(KC_RSFT)) \`
			`)`

added ergodox 2015-10-26 21:32:37 +01:00			`/* number of backlight levels */`
			`#define BACKLIGHT_LEVELS 3`

Move some of the Ergodox config settings to shared 2016-07-09 10:26:15 +02:00			`#define LED_BRIGHTNESS_LO 15`
			`#define LED_BRIGHTNESS_HI 255`

enable rgblight by default for ez 2016-11-29 06:09:56 +01:00			`/* ws2812 RGB LED */`
			`#define RGB_DI_PIN D7`
			`#define RGBLIGHT_ANIMATIONS`
			`#define RGBLED_NUM 15 // Number of LEDs`
			`#define RGBLIGHT_HUE_STEP 12`
			`#define RGBLIGHT_SAT_STEP 255`
			`#define RGBLIGHT_VAL_STEP 12`

disables space cadet rollover 2017-04-03 21:11:42 +02:00			`/* fix space cadet rollover issue */`
			`#define DISABLE_SPACE_CADET_ROLLOVER`

turn off rgb_midi in ez 2017-01-23 19:55:24 +01:00			`// #define RGB_MIDI`
enable rgblight by default for ez 2016-11-29 06:09:56 +01:00			`#define RGBW_BB_TWI`

rgb clean-up, api clean-up 2016-12-19 17:18:18 +01:00			`#define RGBW 1`
Move some of the Ergodox config settings to shared 2016-07-09 10:26:15 +02:00
added ergodox 2015-10-26 21:32:37 +01:00			`/* Set 0 if debouncing isn't needed */`
Change to per-key eager debouncing for ErgoDox EZ. Empirically, waiting for N consecutive identical scans as a debouncing strategy doesn't work very well for the ErgoDox EZ where scans are very slow compared to most keyboards. Instead, debounce the signals by eagerly reporting a change as soon as one scan observes it, but then ignoring further changes from that key for the next N scans. This is implemented by keeping an extra matrix of uint8 countdowns, such that only keys whose countdown is currently zero are eligible to change. When we do observe a change, we bump that key's countdown to DEBOUNCE. During each scan, every nonzero countdown is decremented. With this approach to debouncing, much higher debounce constants are tolerable, because latency does not increase with the constant, and debounce countdowns on one key do not interfere with events on other keys. The only negative effect of increasing the constant is that the minimum duration of a keypress increases. Perhaps I'm just extremely unlucky w.r.t. key switch quality, but I saw occasional bounces even with DEBOUNCE=10; with 15, I've seen none so far. That's around 47ms, which seems like an absolutely insane amount of time for a key to be bouncy, but at least it works. 2017-04-27 00:29:39 +02:00			`#define DEBOUNCE 15`
added ergodox 2015-10-26 21:32:37 +01:00
Adds prevent stuck modifiers to EZ default 2017-05-29 02:05:37 +02:00			`#define PREVENT_STUCK_MODIFIERS`

Update config.h 2017-01-02 15:57:39 +01:00			`#define USB_MAX_POWER_CONSUMPTION 500`
Allow power consumption to be set per-keyboard. 2016-12-15 05:24:40 +01:00
adds indication up to layer 7 2017-11-06 15:00:05 +01:00			`// #define RGBLIGHT_COLOR_LAYER_0 0x00, 0x00, 0xFF`
disables Shine LED layer indication for now 2017-11-09 14:12:43 +01:00			`/* #define RGBLIGHT_COLOR_LAYER_1 0x00, 0x00, 0xFF */`
			`/* #define RGBLIGHT_COLOR_LAYER_2 0xFF, 0x00, 0x00 */`
			`/* #define RGBLIGHT_COLOR_LAYER_3 0x00, 0xFF, 0x00 */`
			`/* #define RGBLIGHT_COLOR_LAYER_4 0xFF, 0xFF, 0x00 */`
			`/* #define RGBLIGHT_COLOR_LAYER_5 0x00, 0xFF, 0xFF */`
			`/* #define RGBLIGHT_COLOR_LAYER_6 0xFF, 0x00, 0xFF */`
			`/* #define RGBLIGHT_COLOR_LAYER_7 0xFF, 0xFF, 0xFF */`
adds indication up to layer 7 2017-11-06 15:00:05 +01:00
added ergodox 2015-10-26 21:32:37 +01:00			`/*`
			`* Feature disable options`
			`* These options are also useful to firmware size reduction.`
			`*/`

			`/* disable debug print */`
			`// #define NO_DEBUG`

			`/* disable print */`
			`// #define NO_PRINT`

			`/* disable action features */`
			`//#define NO_ACTION_LAYER`
			`//#define NO_ACTION_TAPPING`
			`//#define NO_ACTION_ONESHOT`
			`//#define NO_ACTION_MACRO`
			`//#define NO_ACTION_FUNCTION`
			`//#define DEBUG_MATRIX_SCAN_RATE`

			`#endif`