Saka68 Hotswap Refactor (#14595)

* rename LAYOUT to LAYOUT_68_ansi * tidy-up keymaps Adjusts indenting for readability/aesthetics. * remove default keymap readme * add LAYOUT_68_iso macro * enable Community Layout support * remove KBFirmware Parser references * correct keyboard metadata * specify keyboard variant in info.json and config.h * correct maintainer field in info.json
qmk · Sep 25, 2021 · 5c2d155 · 5c2d155
1 parent aee0b00
commit 5c2d155
Show file tree

Hide file tree

Showing 7 changed files with 165 additions and 76 deletions.
diff --git a/keyboards/cmm_studio/saka68/hotswap/config.h b/keyboards/cmm_studio/saka68/hotswap/config.h
@@ -25,7 +25,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define PRODUCT_ID      0x5348
 #define DEVICE_VER      0x0001
 #define MANUFACTURER    CMM.Studio
-#define PRODUCT         Saka68
+#define PRODUCT         Saka68 Hotswap
 
 /* key matrix size */
 #define MATRIX_ROWS 5
@@ -45,7 +45,3 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define MATRIX_COL_PINS { D4, D6, D7, B4, B5, B6, C6, F5, F4, F1, F0, B1, B2, B3, D3, D5 }
 
 #define DIODE_DIRECTION COL2ROW
-
-
-// generated by KBFirmware JSON to QMK Parser
-// https://noroadsleft.github.io/kbf_qmk_converter/
diff --git a/keyboards/cmm_studio/saka68/hotswap/hotswap.h b/keyboards/cmm_studio/saka68/hotswap/hotswap.h
@@ -14,23 +14,34 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
- #pragma once
+#pragma once
 
- #include "quantum.h"
+#include "quantum.h"
 
- #define LAYOUT( \
-     K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D,       K0E, K0F,  \
-     K10,   K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D,     K1E, K1F,  \
-     K20,    K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2D,                    \
-     K30,       K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C,           K3E,       \
-     K40,  K41,  K42,              K46,                K49,  K4A,  K4B,     K4D, K4E, K4F   \
- ) { \
-     { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   K0D,   K0E,   K0F   }, \
-     { K10,   K11,   K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K1A,   K1B,   K1C,   K1D,   K1E,   K1F   }, \
-     { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   KC_NO, K2D,   KC_NO, KC_NO }, \
-     { K30,   KC_NO, K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   KC_NO, K3E,   KC_NO }, \
-     { K40,   K41,   K42,   KC_NO, KC_NO, KC_NO, K46,   KC_NO, KC_NO, K49,   K4A,   K4B,   KC_NO, K4D,   K4E,   K4F   }, \
- }
+#define LAYOUT_68_ansi( \
+    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D,       K0E, K0F,  \
+    K10,   K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D,     K1E, K1F,  \
+    K20,    K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2D,                    \
+    K30,       K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C,           K3E,       \
+    K40,  K41,  K42,              K46,                K49,  K4A,  K4B,     K4D, K4E, K4F   \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   K0D,   K0E,   K0F   }, \
+    { K10,   K11,   K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K1A,   K1B,   K1C,   K1D,   K1E,   K1F   }, \
+    { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   KC_NO, K2D,   KC_NO, KC_NO }, \
+    { K30,   KC_NO, K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   KC_NO, K3E,   KC_NO }, \
+    { K40,   K41,   K42,   KC_NO, KC_NO, KC_NO, K46,   KC_NO, KC_NO, K49,   K4A,   K4B,   KC_NO, K4D,   K4E,   K4F   }, \
+}
 
- // generated by KBFirmware JSON to QMK Parser
- // https://noroadsleft.github.io/kbf_qmk_converter/
+#define LAYOUT_68_iso( \
+    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D,       K0E, K0F,  \
+    K10,   K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C,          K1E, K1F,  \
+    K20,    K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D,               \
+    K30,  K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C,           K3E,       \
+    K40,  K41,  K42,              K46,                K49,  K4A,  K4B,     K4D, K4E, K4F   \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   K0D,   K0E,   K0F   }, \
+    { K10,   K11,   K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K1A,   K1B,   K1C,   KC_NO, K1E,   K1F   }, \
+    { K20,   K21,   K22,   K23,   K24,   K25,   K26,   K27,   K28,   K29,   K2A,   K2B,   K2C,   K2D,   KC_NO, KC_NO }, \
+    { K30,   K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   KC_NO, K3E,   KC_NO }, \
+    { K40,   K41,   K42,   KC_NO, KC_NO, KC_NO, K46,   KC_NO, KC_NO, K49,   K4A,   K4B,   KC_NO, K4D,   K4E,   K4F   }, \
+}
diff --git a/keyboards/cmm_studio/saka68/hotswap/info.json b/keyboards/cmm_studio/saka68/hotswap/info.json
@@ -1,9 +1,12 @@
 {
-    "keyboard_name": "CMM.Studio Saka68",
+    "keyboard_name": "CMM.Studio Saka68 Hotswap",
     "url": "",
-    "maintainer": "qmk",
+    "maintainer": "CMMS-Freather",
+    "layout_aliases": {
+        "LAYOUT": "LAYOUT_68_ansi"
+    },
     "layouts": {
-        "LAYOUT": {
+        "LAYOUT_68_ansi": {
             "layout": [
                 {"label":"K00 (D2,D4)", "x":0, "y":0},
                 {"label":"K01 (D2,D6)", "x":1, "y":0},
@@ -21,6 +24,7 @@
                 {"label":"K0D (D2,B3)", "x":13, "y":0, "w":2},
                 {"label":"K0E (D2,D3)", "x":15.25, "y":0},
                 {"label":"K0F (D2,D5)", "x":16.25, "y":0},
+
                 {"label":"K10 (D1,D4)", "x":0, "y":1, "w":1.5},
                 {"label":"K11 (D1,D6)", "x":1.5, "y":1},
                 {"label":"K12 (D1,D7)", "x":2.5, "y":1},
@@ -37,6 +41,7 @@
                 {"label":"K1D (D1,B3)", "x":13.5, "y":1, "w":1.5},
                 {"label":"K1E (D1,D3)", "x":15.25, "y":1},
                 {"label":"K1F (D1,D5)", "x":16.25, "y":1},
+
                 {"label":"K20 (B0,D4)", "x":0, "y":2, "w":1.75},
                 {"label":"K21 (B0,D6)", "x":1.75, "y":2},
                 {"label":"K22 (B0,D7)", "x":2.75, "y":2},
@@ -50,6 +55,7 @@
                 {"label":"K2A (B0,F0)", "x":10.75, "y":2},
                 {"label":"K2B (B0,B1)", "x":11.75, "y":2},
                 {"label":"K2D (B0,B3)", "x":12.75, "y":2, "w":2.25},
+
                 {"label":"K30 (F6,D4)", "x":0, "y":3, "w":2.25},
                 {"label":"K32 (F6,D7)", "x":2.25, "y":3},
                 {"label":"K33 (F6,B4)", "x":3.25, "y":3},
@@ -63,6 +69,84 @@
                 {"label":"K3B (F6,B1)", "x":11.25, "y":3},
                 {"label":"K3C (F6,B2)", "x":12.25, "y":3, "w":2.75},
                 {"label":"K3E (F6,D3)", "x":15.25, "y":3},
+
+                {"label":"K40 (F7,D4)", "x":0, "y":4, "w":1.25},
+                {"label":"K41 (F7,D6)", "x":1.25, "y":4, "w":1.25},
+                {"label":"K42 (F7,D7)", "x":2.5, "y":4, "w":1.25},
+                {"label":"K46 (F7,C6)", "x":3.75, "y":4, "w":6.25},
+                {"label":"K49 (F7,F1)", "x":10, "y":4, "w":1.25},
+                {"label":"K4A (F7,F0)", "x":11.25, "y":4, "w":1.25},
+                {"label":"K4B (F7,B1)", "x":12.5, "y":4, "w":1.25},
+                {"label":"K4D (F7,B3)", "x":14.25, "y":4},
+                {"label":"K4E (F7,D3)", "x":15.25, "y":4},
+                {"label":"K4F (F7,D5)", "x":16.25, "y":4}
+            ]
+        },
+        "LAYOUT_68_iso": {
+            "layout": [
+                {"label":"K00 (D2,D4)", "x":0, "y":0},
+                {"label":"K01 (D2,D6)", "x":1, "y":0},
+                {"label":"K02 (D2,D7)", "x":2, "y":0},
+                {"label":"K03 (D2,B4)", "x":3, "y":0},
+                {"label":"K04 (D2,B5)", "x":4, "y":0},
+                {"label":"K05 (D2,B6)", "x":5, "y":0},
+                {"label":"K06 (D2,C6)", "x":6, "y":0},
+                {"label":"K07 (D2,F5)", "x":7, "y":0},
+                {"label":"K08 (D2,F4)", "x":8, "y":0},
+                {"label":"K09 (D2,F1)", "x":9, "y":0},
+                {"label":"K0A (D2,F0)", "x":10, "y":0},
+                {"label":"K0B (D2,B1)", "x":11, "y":0},
+                {"label":"K0C (D2,B2)", "x":12, "y":0},
+                {"label":"K0D (D2,B3)", "x":13, "y":0, "w":2},
+                {"label":"K0E (D2,D3)", "x":15.25, "y":0},
+                {"label":"K0F (D2,D5)", "x":16.25, "y":0},
+
+                {"label":"K10 (D1,D4)", "x":0, "y":1, "w":1.5},
+                {"label":"K11 (D1,D6)", "x":1.5, "y":1},
+                {"label":"K12 (D1,D7)", "x":2.5, "y":1},
+                {"label":"K13 (D1,B4)", "x":3.5, "y":1},
+                {"label":"K14 (D1,B5)", "x":4.5, "y":1},
+                {"label":"K15 (D1,B6)", "x":5.5, "y":1},
+                {"label":"K16 (D1,C6)", "x":6.5, "y":1},
+                {"label":"K17 (D1,F5)", "x":7.5, "y":1},
+                {"label":"K18 (D1,F4)", "x":8.5, "y":1},
+                {"label":"K19 (D1,F1)", "x":9.5, "y":1},
+                {"label":"K1A (D1,F0)", "x":10.5, "y":1},
+                {"label":"K1B (D1,B1)", "x":11.5, "y":1},
+                {"label":"K1C (D1,B2)", "x":12.5, "y":1},
+                {"label":"K1E (D1,D3)", "x":15.25, "y":1},
+                {"label":"K1F (D1,D5)", "x":16.25, "y":1},
+
+                {"label":"K20 (B0,D4)", "x":0, "y":2, "w":1.75},
+                {"label":"K21 (B0,D6)", "x":1.75, "y":2},
+                {"label":"K22 (B0,D7)", "x":2.75, "y":2},
+                {"label":"K23 (B0,B4)", "x":3.75, "y":2},
+                {"label":"K24 (B0,B5)", "x":4.75, "y":2},
+                {"label":"K25 (B0,B6)", "x":5.75, "y":2},
+                {"label":"K26 (B0,C6)", "x":6.75, "y":2},
+                {"label":"K27 (B0,F5)", "x":7.75, "y":2},
+                {"label":"K28 (B0,F4)", "x":8.75, "y":2},
+                {"label":"K29 (B0,F1)", "x":9.75, "y":2},
+                {"label":"K2A (B0,F0)", "x":10.75, "y":2},
+                {"label":"K2B (B0,B1)", "x":11.75, "y":2},
+                {"label":"K2C (B0,B2)", "x":12.75, "y":2},
+                {"label":"K2D (B0,B3)", "x":13.75, "y":1, "w":1.25, "h":2},
+
+                {"label":"K30 (F6,D4)", "x":0, "y":3, "w":1.25},
+                {"label":"K31 (F6,D6)", "x":1.25, "y":3},
+                {"label":"K32 (F6,D7)", "x":2.25, "y":3},
+                {"label":"K33 (F6,B4)", "x":3.25, "y":3},
+                {"label":"K34 (F6,B5)", "x":4.25, "y":3},
+                {"label":"K35 (F6,B6)", "x":5.25, "y":3},
+                {"label":"K36 (F6,C6)", "x":6.25, "y":3},
+                {"label":"K37 (F6,F5)", "x":7.25, "y":3},
+                {"label":"K38 (F6,F4)", "x":8.25, "y":3},
+                {"label":"K39 (F6,F1)", "x":9.25, "y":3},
+                {"label":"K3A (F6,F0)", "x":10.25, "y":3},
+                {"label":"K3B (F6,B1)", "x":11.25, "y":3},
+                {"label":"K3C (F6,B2)", "x":12.25, "y":3, "w":2.75},
+                {"label":"K3E (F6,D3)", "x":15.25, "y":3},
+
                 {"label":"K40 (F7,D4)", "x":0, "y":4, "w":1.25},
                 {"label":"K41 (F7,D6)", "x":1.25, "y":4, "w":1.25},
                 {"label":"K42 (F7,D7)", "x":2.5, "y":4, "w":1.25},
@@ -76,5 +160,4 @@
             ]
         }
     }
-    ,"meta": "https://noroadsleft.github.io/kbf_qmk_converter/"
 }
diff --git a/keyboards/cmm_studio/saka68/hotswap/keymaps/default/keymap.c b/keyboards/cmm_studio/saka68/hotswap/keymaps/default/keymap.c
@@ -14,23 +14,23 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
- #include QMK_KEYBOARD_H
+#include QMK_KEYBOARD_H
 
- const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-     [0] = LAYOUT(
-         KC_ESC,  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,            KC_INS,  KC_SPC,
-         KC_TAB,      KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,        KC_DEL,  KC_SPC,
-         KC_CAPS,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
-         KC_LSFT,            KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,                  KC_UP,
-         KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_LALT,   MO(1),   KC_RCTL,        KC_LEFT, KC_DOWN, KC_RGHT
-     ),
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_68_ansi(
+        KC_ESC,  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,            KC_INS,  KC_SPC,
+        KC_TAB,      KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,        KC_DEL,  KC_SPC,
+        KC_CAPS,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,
+        KC_LSFT,            KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,                   KC_UP,
+        KC_LCTL,   KC_LGUI,   KC_LALT,                       KC_SPC,                              KC_LALT,   MO(1),     KC_RCTL,        KC_LEFT, KC_DOWN, KC_RGHT
+    ),
 
-     [1] = LAYOUT(
-      KC_TRNS,  KC_F1,   KC_F2,   KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,    KC_F11, KC_F12,  KC_TRNS,            KC_TRNS,  KC_TRNS,
-      KC_TRNS,      KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS, KC_TRNS, KC_TRNS,        KC_TRNS,  KC_TRNS,
-      KC_TRNS,       KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS, KC_TRNS, KC_TRNS,
-      KC_TRNS,            KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS, KC_TRNS,  KC_TRNS, KC_TRNS,                   KC_TRNS,
-      KC_TRNS,   KC_TRNS,   KC_TRNS,                       KC_TRNS,                              KC_TRNS,  KC_TRNS,   KC_TRNS,        KC_TRNS, KC_TRNS, KC_TRNS
-  ),
+    [1] = LAYOUT_68_ansi(
+        KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_TRNS,            KC_TRNS, KC_TRNS,
+        KC_TRNS,     KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,        KC_TRNS, KC_TRNS,
+        KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS,            KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,                   KC_TRNS,
+        KC_TRNS,   KC_TRNS,   KC_TRNS,                       KC_TRNS,                             KC_TRNS,   KC_TRNS,   KC_TRNS,        KC_TRNS, KC_TRNS, KC_TRNS
+    ),
 
- };
+};
diff --git a/keyboards/cmm_studio/saka68/hotswap/keymaps/default/readme.md b/keyboards/cmm_studio/saka68/hotswap/keymaps/default/readme.md