Defined a new safe range for custom keycodes in keymap.c

qmk · drashna · Jul 9, 2018 · Jun 28, 2018 · Jun 28, 2018 · Jun 28, 2018
commit ae82aa6efe67ed9fecca67d3cde0250606a6d9fb
diff --git a/keyboards/mxss/keymaps/default/keymap.c b/keyboards/mxss/keymaps/default/keymap.c
@@ -27,6 +27,12 @@ const hs_set layer_colors[] = {
 };
 const size_t lc_size = sizeof(layer_colors) / sizeof(uint16_t);
 
+// Use NEW_SAFE_RANGE to define new custom keycodes in order to not overwrite the ones used for front LED control
+enum custom_keycodes {
+  MY_KEYCODE = NEW_SAFE_RANGE, 
+};
+
+
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 	LAYOUT( /* Base */
 	KC_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,

diff --git a/keyboards/mxss/mxss_frontled.h b/keyboards/mxss/mxss_frontled.h
@@ -66,7 +66,8 @@ typedef struct _hs_set {
 enum fled_keycodes {
   FLED_MOD = SAFE_RANGE,
   FLED_VAI,
-  FLED_VAD
+  FLED_VAD,
+  NEW_SAFE_RANGE // define a new safe range
 };
 
 bool eeprom_is_valid(void);         // Check if EEPROM has been set up

diff --git a/keyboards/mxss/readme.md b/keyboards/mxss/readme.md
@@ -47,4 +47,8 @@ Colors for FLED_INDI mode are hardcoded as hue/saturation values, the caps lock
 
  - FLED_MOD - Cycle between the 3 modes (FLED_OFF -> FLED_RGB -> FLED_INDI)
  - FLED_VAI - Increase front LED brightness
- - FLED_VAD - Decrease front LED brightness
+ - FLED_VAD - Decrease front LED brightness
+
+ # Further Notes
+
+ As SAFE_RANGE is used for defining the custom keycodes seen above, please use NEW_SAFE_RANGE as the starting value for any custom keycodes in keymap.c, as per the example.
diff --git a/keyboards/mxss/templates/keymap.c b/keyboards/mxss/templates/keymap.c
@@ -31,6 +31,12 @@ hs_set layer_colors[] = {
 };
 const size_t lc_size = sizeof(layer_colors) / sizeof(uint16_t);
 
+// Use NEW_SAFE_RANGE to define new custom keycodes in order to not overwrite the ones used for front LED control
+enum custom_keycodes {
+  MY_KEYCODE = NEW_SAFE_RANGE, 
+};
+
+
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 __KEYMAP_GOES_HERE__
 };