summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKonstantin Đorđević <vomindoraan@gmail.com>2019-02-18 07:23:32 +0100
committerDrashna Jaelre <drashna@live.com>2019-02-17 22:23:32 -0800
commit5cb713148dbc319167517df370ca9dd774ceb31c (patch)
treead6b4cfc283b135cb93bb1f539dc8a0fade65a54
parent4e2369693f7f2ef654db35d158af5cddb98d9703 (diff)
downloadqmk_firmware-5cb713148dbc319167517df370ca9dd774ceb31c.tar.gz
qmk_firmware-5cb713148dbc319167517df370ca9dd774ceb31c.zip
Change Command keycode defaults to match corresponding Bootmagic codes (#5078)
* Change Command keycode defaults to match corresponding Bootmagic codes * Make alternate magic key keycodes consistent * Reflect changes from previous commit in tmk_core/common/command.c * Remove unnecessary MAGIC_KEY_* definitions from keymaps compatible with these changes * Swap E and BSPACE for MAGIC_KEY_EEPROM * Add MAGIC_KEY_EEPROM_CLEAR instead of MAGIC_KEY_EEPROM_ALT * Remove BOOTMAGIC_ENABLE checks around EECONFIG stuff * Update Command descriptions
-rw-r--r--docs/feature_command.md13
-rw-r--r--keyboards/xd75/keymaps/billypython/config.h3
-rw-r--r--quantum/template/avr/config.h11
-rw-r--r--tmk_core/common/command.c31
-rw-r--r--tmk_core/common/command.h34
-rw-r--r--users/billypython/config.h2
-rw-r--r--users/konstantin/config.h3
7 files changed, 48 insertions, 49 deletions
diff --git a/docs/feature_command.md b/docs/feature_command.md
index 53a140a116..deabedc1c3 100644
--- a/docs/feature_command.md
+++ b/docs/feature_command.md
@@ -29,9 +29,10 @@ If you would like to change the key assignments for Command, `#define` these in
|`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console |
|`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console |
|`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console|
-|`MAGIC_KEY_HELP1` |`H` |Print Command help to the console |
-|`MAGIC_KEY_HELP2` |`SLASH` |Print Command help to the console (alternate) |
+|`MAGIC_KEY_HELP` |`H` |Print Command help to the console |
+|`MAGIC_KEY_HELP_ALT` |`SLASH` |Print Command help to the console (alternate) |
|`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer |
+|`MAGIC_KEY_LAYER0_ALT` |`GRAVE` |Make layer 0 the default layer (alternate) |
|`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer |
|`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer |
|`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer |
@@ -41,10 +42,10 @@ If you would like to change the key assignments for Command, `#define` these in
|`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer |
|`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer |
|`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer |
-|`MAGIC_KEY_LAYER0_ALT1` |`ESC` |Make layer 0 the default layer (alternate) |
-|`MAGIC_KEY_LAYER0_ALT2` |`GRAVE` |Make layer 0 the default layer (alternate) |
-|`MAGIC_KEY_BOOTLOADER` |`PAUSE` |Enter the bootloader |
+|`MAGIC_KEY_BOOTLOADER` |`B` |Jump to bootloader |
+|`MAGIC_KEY_BOOTLOADER_ALT` |`ESC` |Jump to bootloader (alternate) |
|`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed |
-|`MAGIC_KEY_EEPROM` |`E` |Clear the EEPROM |
+|`MAGIC_KEY_EEPROM` |`E` |Print stored EEPROM config to the console |
+|`MAGIC_KEY_EEPROM_CLEAR` |`BSPACE` |Clear the EEPROM |
|`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) |
|`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping |
diff --git a/keyboards/xd75/keymaps/billypython/config.h b/keyboards/xd75/keymaps/billypython/config.h
index 275f8effba..36e6b67851 100644
--- a/keyboards/xd75/keymaps/billypython/config.h
+++ b/keyboards/xd75/keymaps/billypython/config.h
@@ -2,9 +2,6 @@
#define FORCE_NKRO
-#define MAGIC_KEY_LAYER0_ALT1 BSLS
-#define MAGIC_KEY_BOOTLOADER ESC
-
#define MOUSEKEY_DELAY 50
#define MOUSEKEY_INTERVAL 15
#define MOUSEKEY_MAX_SPEED 4
diff --git a/quantum/template/avr/config.h b/quantum/template/avr/config.h
index a31fcf236f..41e1aa0788 100644
--- a/quantum/template/avr/config.h
+++ b/quantum/template/avr/config.h
@@ -143,8 +143,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
-//#define MAGIC_KEY_HELP1 H
-//#define MAGIC_KEY_HELP2 SLASH
+//#define MAGIC_KEY_HELP H
+//#define MAGIC_KEY_HELP_ALT SLASH
//#define MAGIC_KEY_DEBUG D
//#define MAGIC_KEY_DEBUG_MATRIX X
//#define MAGIC_KEY_DEBUG_KBD K
@@ -152,9 +152,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
//#define MAGIC_KEY_VERSION V
//#define MAGIC_KEY_STATUS S
//#define MAGIC_KEY_CONSOLE C
-//#define MAGIC_KEY_LAYER0_ALT1 ESC
-//#define MAGIC_KEY_LAYER0_ALT2 GRAVE
//#define MAGIC_KEY_LAYER0 0
+//#define MAGIC_KEY_LAYER0_ALT GRAVE
//#define MAGIC_KEY_LAYER1 1
//#define MAGIC_KEY_LAYER2 2
//#define MAGIC_KEY_LAYER3 3
@@ -164,9 +163,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
//#define MAGIC_KEY_LAYER7 7
//#define MAGIC_KEY_LAYER8 8
//#define MAGIC_KEY_LAYER9 9
-//#define MAGIC_KEY_BOOTLOADER PAUSE
+//#define MAGIC_KEY_BOOTLOADER B
+//#define MAGIC_KEY_BOOTLOADER_ALT ESC
//#define MAGIC_KEY_LOCK CAPS
//#define MAGIC_KEY_EEPROM E
+//#define MAGIC_KEY_EEPROM_CLEAR BSPACE
//#define MAGIC_KEY_NKRO N
//#define MAGIC_KEY_SLEEP_LED Z
diff --git a/tmk_core/common/command.c b/tmk_core/common/command.c
index aab99290d2..d3884d9fa9 100644
--- a/tmk_core/common/command.c
+++ b/tmk_core/common/command.c
@@ -151,17 +151,17 @@ static void command_common_help(void)
"0-9: Switch to Layer 0-9\n"
#endif
- STR(MAGIC_KEY_LAYER0_ALT1 ) ": Switch to Layer 0 (alternate key 1)\n"
- STR(MAGIC_KEY_LAYER0_ALT2 ) ": Switch to Layer 0 (alternate key 2)\n"
- STR(MAGIC_KEY_BOOTLOADER ) ": Jump to Bootloader (Reset)\n"
+ STR(MAGIC_KEY_LAYER0_ALT ) ": Switch to Layer 0 (alternate)\n"
+
+ STR(MAGIC_KEY_BOOTLOADER ) ": Jump to Bootloader\n"
+ STR(MAGIC_KEY_BOOTLOADER_ALT) ": Jump to Bootloader (alternate)\n"
#ifdef KEYBOARD_LOCK_ENABLE
- STR(MAGIC_KEY_LOCK ) ": Lock\n"
+ STR(MAGIC_KEY_LOCK ) ": Lock Keyboard\n"
#endif
-#ifdef BOOTMAGIC_ENABLE
STR(MAGIC_KEY_EEPROM ) ": Print EEPROM Settings\n"
-#endif
+ STR(MAGIC_KEY_EEPROM_CLEAR) ": Clear EEPROM\n"
#ifdef NKRO_ENABLE
STR(MAGIC_KEY_NKRO ) ": NKRO Toggle\n"
@@ -265,7 +265,6 @@ static void print_status(void)
return;
}
-#ifdef BOOTMAGIC_ENABLE
static void print_eeconfig(void)
{
@@ -305,7 +304,6 @@ static void print_eeconfig(void)
#endif /* !NO_PRINT */
}
-#endif /* BOOTMAGIC_ENABLE */
static bool command_common(uint8_t code)
{
@@ -326,14 +324,17 @@ static bool command_common(uint8_t code)
break;
#endif
-#ifdef BOOTMAGIC_ENABLE
-
// print stored eeprom config
case MAGIC_KC(MAGIC_KEY_EEPROM):
print("eeconfig:\n");
print_eeconfig();
break;
-#endif
+
+ // clear eeprom
+ case MAGIC_KC(MAGIC_KEY_EEPROM_CLEAR):
+ print("Clearing EEPROM\n");
+ eeconfig_init();
+ break;
#ifdef KEYBOARD_LOCK_ENABLE
@@ -352,8 +353,8 @@ static bool command_common(uint8_t code)
#endif
// print help
- case MAGIC_KC(MAGIC_KEY_HELP1):
- case MAGIC_KC(MAGIC_KEY_HELP2):
+ case MAGIC_KC(MAGIC_KEY_HELP):
+ case MAGIC_KC(MAGIC_KEY_HELP_ALT):
command_common_help();
break;
@@ -370,6 +371,7 @@ static bool command_common(uint8_t code)
// jump to bootloader
case MAGIC_KC(MAGIC_KEY_BOOTLOADER):
+ case MAGIC_KC(MAGIC_KEY_BOOTLOADER_ALT):
clear_keyboard(); // clear to prevent stuck keys
print("\n\nJumping to bootloader... ");
#ifdef AUDIO_ENABLE
@@ -453,8 +455,7 @@ static bool command_common(uint8_t code)
// switch layers
- case MAGIC_KC(MAGIC_KEY_LAYER0_ALT1):
- case MAGIC_KC(MAGIC_KEY_LAYER0_ALT2):
+ case MAGIC_KC(MAGIC_KEY_LAYER0_ALT):
switch_default_layer(0);
break;
diff --git a/tmk_core/common/command.h b/tmk_core/common/command.h
index 052e251843..e7c7b0ea1d 100644
--- a/tmk_core/common/command.h
+++ b/tmk_core/common/command.h
@@ -50,12 +50,12 @@ bool command_proc(uint8_t code);
#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
#endif
-#ifndef MAGIC_KEY_HELP1
-#define MAGIC_KEY_HELP1 H
+#ifndef MAGIC_KEY_HELP
+#define MAGIC_KEY_HELP H
#endif
-#ifndef MAGIC_KEY_HELP2
-#define MAGIC_KEY_HELP2 SLASH
+#ifndef MAGIC_KEY_HELP_ALT
+#define MAGIC_KEY_HELP_ALT SLASH
#endif
#ifndef MAGIC_KEY_DEBUG
@@ -86,18 +86,14 @@ bool command_proc(uint8_t code);
#define MAGIC_KEY_CONSOLE C
#endif
-#ifndef MAGIC_KEY_LAYER0_ALT1
-#define MAGIC_KEY_LAYER0_ALT1 ESC
-#endif
-
-#ifndef MAGIC_KEY_LAYER0_ALT2
-#define MAGIC_KEY_LAYER0_ALT2 GRAVE
-#endif
-
#ifndef MAGIC_KEY_LAYER0
#define MAGIC_KEY_LAYER0 0
#endif
+#ifndef MAGIC_KEY_LAYER0_ALT
+#define MAGIC_KEY_LAYER0_ALT GRAVE
+#endif
+
#ifndef MAGIC_KEY_LAYER1
#define MAGIC_KEY_LAYER1 1
#endif
@@ -135,7 +131,11 @@ bool command_proc(uint8_t code);
#endif
#ifndef MAGIC_KEY_BOOTLOADER
-#define MAGIC_KEY_BOOTLOADER PAUSE
+#define MAGIC_KEY_BOOTLOADER B
+#endif
+
+#ifndef MAGIC_KEY_BOOTLOADER_ALT
+#define MAGIC_KEY_BOOTLOADER_ALT ESC
#endif
#ifndef MAGIC_KEY_LOCK
@@ -146,6 +146,10 @@ bool command_proc(uint8_t code);
#define MAGIC_KEY_EEPROM E
#endif
+#ifndef MAGIC_KEY_EEPROM_CLEAR
+#define MAGIC_KEY_EEPROM_CLEAR BSPACE
+#endif
+
#ifndef MAGIC_KEY_NKRO
#define MAGIC_KEY_NKRO N
#endif
@@ -155,5 +159,5 @@ bool command_proc(uint8_t code);
#endif
-#define XMAGIC_KC(key) KC_##key
-#define MAGIC_KC(key) XMAGIC_KC(key)
+#define XMAGIC_KC(key) KC_ ## key
+#define MAGIC_KC(key) XMAGIC_KC(key)
diff --git a/users/billypython/config.h b/users/billypython/config.h
index 705e6c934a..4609adbbea 100644
--- a/users/billypython/config.h
+++ b/users/billypython/config.h
@@ -2,8 +2,6 @@
#define FORCE_NKRO
-#define MAGIC_KEY_BOOTLOADER B
-
#define MOUSEKEY_DELAY 50
#define MOUSEKEY_INTERVAL 15
#define MOUSEKEY_MAX_SPEED 4
diff --git a/users/konstantin/config.h b/users/konstantin/config.h
index 800b8e49ba..f18c4a70e4 100644
--- a/users/konstantin/config.h
+++ b/users/konstantin/config.h
@@ -2,9 +2,6 @@
#define FORCE_NKRO
-#define MAGIC_KEY_LAYER0_ALT1 BSLS
-#define MAGIC_KEY_BOOTLOADER ESC
-
#define MOUSEKEY_DELAY 50
#define MOUSEKEY_INTERVAL 15
#define MOUSEKEY_MAX_SPEED 4