[Keyboard] QWERTYYdox refactor (qmk#6446)

* Delete null key `__` key in keymap.c doesn't actually exist on the physical hardware. Removed key from keymap.c and removed its argument from the layout macro. * Delete unused keycode aliases * Replace layer index definitions with an enum * Replace redundant numpad keycodes with native aliases * Use native layer change keycodes instead of aliases * Visually align the keycodes It makes the keymap pretty. * Correct Configurator layout data * Clean up header files - convert to pragma once include guard - remove redundant definitions - remove commented code blocks * Delete LAYOUT_kc macro Was copied from ergotravel; not valid for this keyboard. * Consolidate rev1 rules.mk settings to keyboard level Previous codebase enabled Backlight at keyboard level then disabled it at revision level. * Delete unused rules * Consolidate config.h settings from keymap level to keyboard level * Modernize keyboard's config.h file Aligns the keyboard-level config.h file more closely with the current QMK template for AVR keyboards.
ridingqwerty · Aug 1, 2019 · d2645b5 · d2645b5
1 parent 7480884
commit d2645b5
Show file tree

Hide file tree

Showing 9 changed files with 265 additions and 159 deletions.
diff --git a/keyboards/qwertyydox/config.h b/keyboards/qwertyydox/config.h
@@ -15,8 +15,7 @@ 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 REV1_CONFIG_H
-#define REV1_CONFIG_H
+#pragma once
 
 #include "config_common.h"
 
@@ -33,37 +32,156 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define MATRIX_ROWS 8
 #define MATRIX_COLS 7
 
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+*/
 // wiring of each half
 #define MATRIX_ROW_PINS { B6, B2, B3, B1 }
 #define MATRIX_COL_PINS { F7, F6, F5, C6, D7, D4, D1 }
 
 /* COL2ROW or ROW2COL */
 #define DIODE_DIRECTION COL2ROW
 
-/* define if matrix has ghost */
-//#define MATRIX_HAS_GHOST
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0
 
-/* number of backlight levels */
-// #define BACKLIGHT_LEVELS 3
+// #define BACKLIGHT_PIN E6
+// #define BACKLIGHT_BREATHING
+// #define BACKLIGHT_LEVELS 5
 
-/* Set 0 if debouncing isn't needed */
+#define RGB_DI_PIN D6
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 12
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+    #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+    /*== all animations enable ==*/
+    #define RGBLIGHT_ANIMATIONS
+    // /*== or choose animations ==*/
+    //     #define RGBLIGHT_EFFECT_BREATHING
+    //     #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+    //     #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+    //     #define RGBLIGHT_EFFECT_SNAKE
+    //     #define RGBLIGHT_EFFECT_KNIGHT
+    //     #define RGBLIGHT_EFFECT_CHRISTMAS
+    //     #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+    //     #define RGBLIGHT_EFFECT_RGB_TEST
+    //     #define RGBLIGHT_EFFECT_ALTERNATING
+    // /*== customize breathing effect ==*/
+    //     /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+    //     #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+    //     /*==== use exp() and sin() ====*/
+    //     #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+    //     #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 #define DEBOUNCE 5
 
-/* serial.c configuration for split keyboard */
-#define SOFT_SERIAL_PIN D0
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
 
 /* 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
 
-#define BACKLIGHT_PIN E6
-#define BACKLIGHT_LEVELS 5
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+// #define GRAVE_ESC_CTRL_OVERRIDE
 
-/* ws2812 RGB LED */
-#define RGB_DI_PIN D6
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+/* defined by default; to change, uncomment and set to the combination you want */
+// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
 
-#define RGBLED_NUM 12    // Number of LEDs
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#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
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#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
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#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
+
+#define MOUSEKEY_DELAY             150
+#define MOUSEKEY_INTERVAL          20
+#define MOUSEKEY_MAX_SPEED         10
+#define MOUSEKEY_TIME_TO_MAX       10
+#define MOUSEKEY_WHEEL_MAX_SPEED   8
+#define MOUSEKEY_WHEEL_TIME_TO_MAX 40
 
 /*
  * Feature disable options
@@ -83,4 +201,57 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 //#define NO_ACTION_MACRO
 //#define NO_ACTION_FUNCTION
 
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+//#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 1
+
+/*
+ * HD44780 LCD Display Configuration
+ */
+/*
+#define LCD_LINES           2     //< number of visible lines of the display
+#define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
+
+#define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
+
+#if LCD_IO_MODE
+#define LCD_PORT         PORTB        //< port for the LCD lines
+#define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
+#define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
+#define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
+#define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
+#define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
+#define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
+#define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
+#define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
+#define LCD_RS_PORT      LCD_PORT     //< port for RS line
+#define LCD_RS_PIN       3            //< pin  for RS line
+#define LCD_RW_PORT      LCD_PORT     //< port for RW line
+#define LCD_RW_PIN       2            //< pin  for RW line
+#define LCD_E_PORT       LCD_PORT     //< port for Enable line
+#define LCD_E_PIN        1            //< pin  for Enable line
 #endif
+*/
+
+/* Bootmagic Lite key configuration */
+// #define BOOTMAGIC_LITE_ROW 0
+// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/qwertyydox/info.json b/keyboards/qwertyydox/info.json
@@ -5,12 +5,66 @@
   "url": "",
   "maintainer": "qmk",
   "processor": "atmega32u4",
-  "width": 16,
+  "width": 16.25,
   "height": 5,
   "layouts": {
     "LAYOUT": {
       "key_count": 53,
-      "layout": [{"label":"L00", "x":0, "y":0.375}, {"label":"L01", "x":1, "y":0.25}, {"label":"L02", "x":2, "y":0.125}, {"label":"L03", "x":3, "y":0}, {"label":"L04", "x":4, "y":0.125}, {"label":"L05", "x":5, "y":0.25}, {"label":"L06", "x":6, "y":0.5}, {"label":"R00", "x":9, "y":0.5}, {"label":"R01", "x":10, "y":0.25}, {"label":"R02", "x":11, "y":0.125}, {"label":"R03", "x":12, "y":0}, {"label":"R04", "x":13, "y":0.125}, {"label":"R05", "x":14, "y":0.25}, {"label":"R06", "x":15, "y":0.375}, {"label":"L10", "x":0, "y":1.375}, {"label":"L11", "x":1, "y":1.25}, {"label":"L12", "x":2, "y":1.125}, {"label":"L13", "x":3, "y":1}, {"label":"L14", "x":4, "y":1.125}, {"label":"L15", "x":5, "y":1.25}, {"label":"L16", "x":6, "y":1.5}, {"label":"R10", "x":9, "y":1.5}, {"label":"R11", "x":10, "y":1.25}, {"label":"R12", "x":11, "y":1.125}, {"label":"R13", "x":12, "y":1}, {"label":"R14", "x":13, "y":1.125}, {"label":"R15", "x":14, "y":1.25}, {"label":"R16", "x":15, "y":1.375}, {"label":"L20", "x":0, "y":2.375}, {"label":"L21", "x":1, "y":2.25}, {"label":"L22", "x":2, "y":2.125}, {"label":"L23", "x":3, "y":2}, {"label":"L24", "x":4, "y":2.125}, {"label":"L25", "x":5, "y":2.25}, {"label":"L26", "x":6.5, "y":3}, {"label":"R20", "x":8.5, "y":3}, {"label":"R21", "x":10, "y":2.25}, {"label":"R22", "x":11, "y":2.125}, {"label":"R23", "x":12, "y":2}, {"label":"R24", "x":13, "y":2.125}, {"label":"R25", "x":14, "y":2.25}, {"label":"R26", "x":15, "y":2.375}, {"label":"L30", "x":0, "y":3.375}, {"label":"L31", "x":1, "y":3.25}, {"label":"L32", "x":2, "y":3.125}, {"label":"L33", "x":3, "y":3}, {"label":"L34", "x":5.5, "y":4}, {"label":"L35", "x":6.5, "y":4}, {"label":"R30", "x":8.5, "y":4}, {"label":"R31", "x":9.5, "y":4}, {"label":"R32", "x":12, "y":3}, {"label":"R33", "x":13, "y":3.125}, {"label":"R34", "x":14, "y":3.25}, {"label":"R35", "x":15, "y":3.375}]
+      "layout": [
+        {"label":"Tab", "x":0, "y":0},
+        {"label":"Q", "x":1, "y":0},
+        {"label":"W", "x":2, "y":0},
+        {"label":"E", "x":3, "y":0},
+        {"label":"R", "x":4, "y":0},
+        {"label":"T", "x":5, "y":0},
+        {"label":"Y", "x":6, "y":0},
+        {"label":"Y", "x":9, "y":0},
+        {"label":"U", "x":10, "y":0},
+        {"label":"I", "x":11, "y":0},
+        {"label":"O", "x":12, "y":0},
+        {"label":"P", "x":13, "y":0},
+        {"label":"{", "x":14, "y":0},
+        {"label":"}", "x":15, "y":0},
+        {"label":"Caps Lock", "x":0.25, "y":1},
+        {"label":"A", "x":1.25, "y":1},
+        {"label":"S", "x":2.25, "y":1},
+        {"label":"D", "x":3.25, "y":1},
+        {"label":"F", "x":4.25, "y":1},
+        {"label":"G", "x":5.25, "y":1},
+        {"label":"H", "x":9.25, "y":1},
+        {"label":"J", "x":10.25, "y":1},
+        {"label":"K", "x":11.25, "y":1},
+        {"label":"L", "x":12.25, "y":1},
+        {"label":":", "x":13.25, "y":1},
+        {"label":"\"", "x":14.25, "y":1},
+        {"label":"|", "x":15.25, "y":1},
+        {"label":"Shift", "x":0.75, "y":2},
+        {"label":"Z", "x":1.75, "y":2},
+        {"label":"X", "x":2.75, "y":2},
+        {"label":"C", "x":3.75, "y":2},
+        {"label":"V", "x":4.75, "y":2},
+        {"label":"B", "x":5.75, "y":2},
+        {"label":"N", "x":9.75, "y":2},
+        {"label":"M", "x":10.75, "y":2},
+        {"label":"<", "x":11.75, "y":2},
+        {"label":">", "x":12.75, "y":2},
+        {"label":"?", "x":13.75, "y":2},
+        {"label":"Shift", "x":14.75, "y":2},
+        {"label":"Ctrl", "x":0.75, "y":3},
+        {"label":"GUI", "x":1.75, "y":3},
+        {"label":"Alt", "x":2.75, "y":3},
+        {"label":"\"-QWERTY\"", "x":3.75, "y":3},
+        {"label":"Enter", "x":4.75, "y":3.33},
+        {"label":"Delete", "x":5.75, "y":3.67},
+        {"label":"TO(_NUM)", "x":6.75, "y":4},
+        {"label":"TO(_NAV)", "x":8.75, "y":4},
+        {"label":"Space", "x":9.75, "y":3.67},
+        {"label":"Back Space", "x":10.75, "y":3.33},
+        {"label":"Left", "x":11.75, "y":3},
+        {"label":"Alt", "x":12.75, "y":3},
+        {"label":"GUI", "x":13.75, "y":3},
+        {"label":"Ctrl", "x":14.75, "y":3}
+      ]
     }
   }
 }
diff --git a/keyboards/qwertyydox/keymaps/default/config.h b/keyboards/qwertyydox/keymaps/default/config.h
@@ -27,17 +27,3 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // #define MASTER_LEFT
 #define MASTER_RIGHT
 // #define EE_HANDS
-
-#undef RGBLED_NUM
-#define RGBLIGHT_ANIMATIONS
-#define RGBLED_NUM 12
-#define RGBLIGHT_HUE_STEP 8
-#define RGBLIGHT_SAT_STEP 8
-#define RGBLIGHT_VAL_STEP 8
-
-#define MOUSEKEY_DELAY             150
-#define MOUSEKEY_INTERVAL          20
-#define MOUSEKEY_MAX_SPEED         10
-#define MOUSEKEY_TIME_TO_MAX       10
-#define MOUSEKEY_WHEEL_MAX_SPEED   8
-#define MOUSEKEY_WHEEL_TIME_TO_MAX 40