Browse Source

KBDfans KBD19x: add LAYOUT_iso (#16240)

James Young 4 years ago
parent
commit
ac6283e836

+ 122 - 3
keyboards/kbdfans/kbd19x/info.json

@@ -1,7 +1,7 @@
 {
     "keyboard_name": "KBD19x",
     "url": "https://github.com/qmk/qmk_firmware/tree/master/keyboards/kbdfans/kbd19x",
-    "maintainer": "qmk",
+    "maintainer": "jshuf, mechmerlin",
     "layouts": {
         "LAYOUT_ansi": {
             "layout": [
@@ -23,6 +23,7 @@
                 {"label":"Pause", "x":16.5, "y":0},
                 {"label":"Insert", "x":17.5, "y":0},
                 {"label":"Home", "x":18.5, "y":0},
+
                 {"label":"`~", "x":0, "y":1.5},
                 {"label":"1!", "x":1, "y":1.5},
                 {"label":"2@", "x":2, "y":1.5},
@@ -41,6 +42,7 @@
                 {"label":"/", "x":16.5, "y":1.5},
                 {"label":"*", "x":17.5, "y":1.5},
                 {"label":"-", "x":18.5, "y":1.5},
+
                 {"label":"Tab", "x":0, "y":2.5, "w":1.5},
                 {"label":"Q", "x":1.5, "y":2.5},
                 {"label":"W", "x":2.5, "y":2.5},
@@ -59,6 +61,7 @@
                 {"label":"8", "x":16.5, "y":2.5},
                 {"label":"9", "x":17.5, "y":2.5},
                 {"label":"+", "x":18.5, "y":2.5, "h":2},
+
                 {"label":"Caps Lock", "x":0, "y":3.5, "w":1.75},
                 {"label":"A", "x":1.75, "y":3.5},
                 {"label":"S", "x":2.75, "y":3.5},
@@ -75,6 +78,7 @@
                 {"label":"4", "x":15.5, "y":3.5},
                 {"label":"5", "x":16.5, "y":3.5},
                 {"label":"6", "x":17.5, "y":3.5},
+
                 {"label":"Shift", "x":0, "y":4.5, "w":2.25},
                 {"label":"Z", "x":2.25, "y":4.5},
                 {"label":"X", "x":3.25, "y":4.5},
@@ -92,6 +96,7 @@
                 {"label":"2", "x":16.5, "y":4.5},
                 {"label":"3", "x":17.5, "y":4.5},
                 {"label":"Enter", "x":18.5, "y":4.5, "h":2},
+
                 {"label":"Control", "x":0, "y":5.5, "w":1.25},
                 {"label":"GUI", "x":1.25, "y":5.5},
                 {"label":"Alt", "x":2.25, "y":5.5, "w":1.25},
@@ -100,8 +105,117 @@
                 {"label":"Fn", "x":10.75, "y":5.5},
                 {"label":"Control", "x":11.75, "y":5.5, "w":1.25},
                 {"label":"Left", "x":13.25, "y":5.75},
-                {"label":"Right", "x":14.25, "y":5.75},
-                {"label":"Down", "x":15.25, "y":5.75},
+                {"label":"Down", "x":14.25, "y":5.75},
+                {"label":"Right", "x":15.25, "y":5.75},
+                {"label":"0", "x":16.5, "y":5.5},
+                {"label":".", "x":17.5, "y":5.5}
+            ]
+        },
+        "LAYOUT_iso": {
+            "layout": [
+                {"label":"Esc", "x":0, "y":0},
+                {"label":"F1", "x":1.25, "y":0},
+                {"label":"F2", "x":2.25, "y":0},
+                {"label":"F3", "x":3.25, "y":0},
+                {"label":"F4", "x":4.25, "y":0},
+                {"label":"F5", "x":5.5, "y":0},
+                {"label":"F6", "x":6.5, "y":0},
+                {"label":"F7", "x":7.5, "y":0},
+                {"label":"F8", "x":8.5, "y":0},
+                {"label":"F9", "x":9.75, "y":0},
+                {"label":"F10", "x":10.75, "y":0},
+                {"label":"F11", "x":11.75, "y":0},
+                {"label":"F12", "x":12.75, "y":0},
+                {"label":"Extra Esc", "x":14, "y":0},
+                {"label":"PrtSc", "x":15.5, "y":0},
+                {"label":"Pause", "x":16.5, "y":0},
+                {"label":"Insert", "x":17.5, "y":0},
+                {"label":"Home", "x":18.5, "y":0},
+
+                {"label":"`\u00ac", "x":0, "y":1.5},
+                {"label":"1!", "x":1, "y":1.5},
+                {"label":"2\"", "x":2, "y":1.5},
+                {"label":"3\u00a3", "x":3, "y":1.5},
+                {"label":"4$", "x":4, "y":1.5},
+                {"label":"5%", "x":5, "y":1.5},
+                {"label":"6^", "x":6, "y":1.5},
+                {"label":"7&", "x":7, "y":1.5},
+                {"label":"8*", "x":8, "y":1.5},
+                {"label":"9(", "x":9, "y":1.5},
+                {"label":"0)", "x":10, "y":1.5},
+                {"label":"-_", "x":11, "y":1.5},
+                {"label":"=+", "x":12, "y":1.5},
+                {"label":"Backspace", "x":13, "y":1.5, "w":2},
+                {"label":"Num Lock", "x":15.5, "y":1.5},
+                {"label":"/", "x":16.5, "y":1.5},
+                {"label":"*", "x":17.5, "y":1.5},
+                {"label":"-", "x":18.5, "y":1.5},
+
+                {"label":"Tab", "x":0, "y":2.5, "w":1.5},
+                {"label":"Q", "x":1.5, "y":2.5},
+                {"label":"W", "x":2.5, "y":2.5},
+                {"label":"E", "x":3.5, "y":2.5},
+                {"label":"R", "x":4.5, "y":2.5},
+                {"label":"T", "x":5.5, "y":2.5},
+                {"label":"Y", "x":6.5, "y":2.5},
+                {"label":"U", "x":7.5, "y":2.5},
+                {"label":"I", "x":8.5, "y":2.5},
+                {"label":"O", "x":9.5, "y":2.5},
+                {"label":"P", "x":10.5, "y":2.5},
+                {"label":"[{", "x":11.5, "y":2.5},
+                {"label":"]}", "x":12.5, "y":2.5},
+                {"label":"7", "x":15.5, "y":2.5},
+                {"label":"8", "x":16.5, "y":2.5},
+                {"label":"9", "x":17.5, "y":2.5},
+                {"label":"+", "x":18.5, "y":2.5, "h":2},
+
+                {"label":"Caps Lock", "x":0, "y":3.5, "w":1.75},
+                {"label":"A", "x":1.75, "y":3.5},
+                {"label":"S", "x":2.75, "y":3.5},
+                {"label":"D", "x":3.75, "y":3.5},
+                {"label":"F", "x":4.75, "y":3.5},
+                {"label":"G", "x":5.75, "y":3.5},
+                {"label":"H", "x":6.75, "y":3.5},
+                {"label":"J", "x":7.75, "y":3.5},
+                {"label":"K", "x":8.75, "y":3.5},
+                {"label":"L", "x":9.75, "y":3.5},
+                {"label":";:", "x":10.75, "y":3.5},
+                {"label":"'@", "x":11.75, "y":3.5},
+                {"label":"#~", "x":12.75, "y":3.5},
+                {"label":"Enter", "x":13.75, "y":2.5, "w":1.25, "h":2},
+                {"label":"4", "x":15.5, "y":3.5},
+                {"label":"5", "x":16.5, "y":3.5},
+                {"label":"6", "x":17.5, "y":3.5},
+
+                {"label":"Shift", "x":0, "y":4.5, "w":1.25},
+                {"label":"\\|", "x":1.25, "y":4.5},
+                {"label":"Z", "x":2.25, "y":4.5},
+                {"label":"X", "x":3.25, "y":4.5},
+                {"label":"C", "x":4.25, "y":4.5},
+                {"label":"V", "x":5.25, "y":4.5},
+                {"label":"B", "x":6.25, "y":4.5},
+                {"label":"N", "x":7.25, "y":4.5},
+                {"label":"M", "x":8.25, "y":4.5},
+                {"label":",<", "x":9.25, "y":4.5},
+                {"label":".>", "x":10.25, "y":4.5},
+                {"label":"/?", "x":11.25, "y":4.5},
+                {"label":"Shift", "x":12.25, "y":4.5, "w":1.75},
+                {"label":"Up", "x":14.25, "y":4.75},
+                {"label":"1", "x":15.5, "y":4.5},
+                {"label":"2", "x":16.5, "y":4.5},
+                {"label":"3", "x":17.5, "y":4.5},
+                {"label":"Enter", "x":18.5, "y":4.5, "h":2},
+
+                {"label":"Control", "x":0, "y":5.5, "w":1.25},
+                {"label":"GUI", "x":1.25, "y":5.5},
+                {"label":"Alt", "x":2.25, "y":5.5, "w":1.25},
+                {"label":"Space", "x":3.5, "y":5.5, "w":6.25},
+                {"label":"Alt", "x":9.75, "y":5.5},
+                {"label":"Fn", "x":10.75, "y":5.5},
+                {"label":"Control", "x":11.75, "y":5.5, "w":1.25},
+                {"label":"Left", "x":13.25, "y":5.75},
+                {"label":"Down", "x":14.25, "y":5.75},
+                {"label":"Right", "x":15.25, "y":5.75},
                 {"label":"0", "x":16.5, "y":5.5},
                 {"label":".", "x":17.5, "y":5.5}
             ]
@@ -126,6 +240,7 @@
                 {"label":"Pause", "x":16.5, "y":0},
                 {"label":"Insert", "x":17.5, "y":0},
                 {"label":"Home", "x":18.5, "y":0},
+
                 {"label":"`~", "x":0, "y":1.5},
                 {"label":"1!", "x":1, "y":1.5},
                 {"label":"2@", "x":2, "y":1.5},
@@ -145,6 +260,7 @@
                 {"label":"/", "x":16.5, "y":1.5},
                 {"label":"*", "x":17.5, "y":1.5},
                 {"label":"-", "x":18.5, "y":1.5},
+
                 {"label":"Tab", "x":0, "y":2.5, "w":1.5},
                 {"label":"Q", "x":1.5, "y":2.5},
                 {"label":"W", "x":2.5, "y":2.5},
@@ -163,6 +279,7 @@
                 {"label":"8", "x":16.5, "y":2.5},
                 {"label":"9", "x":17.5, "y":2.5},
                 {"label":"Split + (Top)", "x":18.5, "y":2.5},
+
                 {"label":"Caps Lock", "x":0, "y":3.5, "w":1.75},
                 {"label":"A", "x":1.75, "y":3.5},
                 {"label":"S", "x":2.75, "y":3.5},
@@ -180,6 +297,7 @@
                 {"label":"5", "x":16.5, "y":3.5},
                 {"label":"6", "x":17.5, "y":3.5},
                 {"label":"Split + (Bottom)", "x":18.5, "y":3.5},
+
                 {"label":"Shift", "x":0, "y":4.5, "w":1.25},
                 {"label":"ISO Backslash", "x":1.25, "y":4.5},
                 {"label":"Z", "x":2.25, "y":4.5},
@@ -198,6 +316,7 @@
                 {"label":"2", "x":16.5, "y":4.5},
                 {"label":"3", "x":17.5, "y":4.5},
                 {"label":"Split Enter (Top)", "x":18.5, "y":4.5},
+
                 {"label":"Ctrl", "x":0, "y":5.5, "w":1.25},
                 {"label":"GUI", "x":1.25, "y":5.5},
                 {"label":"Alt", "x":2.25, "y":5.5, "w":1.25},

+ 37 - 29
keyboards/kbdfans/kbd19x/kbd19x.h

@@ -32,37 +32,26 @@ inline void kbd19x_nmlk_led_off(void)   { writePinLow(LED_NUM_LOCK_PIN); }
 // readability
 #define XXX KC_NO
 
-/* This is a shortcut to help you visually see your layout.
- *
- * The first section contains all of the arguments representing the physical
- * layout of the board and position of the keys.
- *
- * The second converts the arguments into a two-dimensional array which
- * represents the switch matrix.
+/*
+ *              ┌───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┬───┬───┬───┐┌───┐ ┌───┬───┬───┬───┐
+ *              │00 ││01 │02 │03 │04 ││60 │61 │62 │63 ││05 │06 │07 │08 ││72 │ │09 │0A │0B │0C │
+ *              └───┘└───┴───┴───┴───┘└───┴───┴───┴───┘└───┴───┴───┴───┘└───┘ └───┴───┴───┴───┘
+ *              ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐ ┌───┬───┬───┬───┐    ┌───────┐
+ *              │10 │11 │12 │13 │14 │64 │65 │66 │67 │15 │16 │17 │18 │70 │71 │ │19 │1A │1B │1C │    │71     │ 2u Backspace
+ *              ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤ ├───┼───┼───┼───┤    └─┬─────┤                ┌───┐
+ *              │20   │21 │22 │23 │24 │68 │69 │6a │6b │25 │26 │27 │28 │73   │ │29 │2A │2B │2C │      │     │                │   │
+ *  2.25u       ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ ├───┼───┼───┼───┤   ┌──┴┐38  │ ISO Enter      │2C │ 2u Plus
+ *  LShift      │30    │31 │32 │33 │34 │6c │75 │76 │77 │35 │36 │37 │38      │ │39 │3A │3B │3C │   │73 │    │                │   │
+ * ┌────────┐   ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┘ ├───┼───┼───┼───┤   └───┴────┘                ├───┤
+ * │40      │   │40  │41 │42 │43 │44 │78 │79 │7a │7b │45 │46 │47 │48    │┌───┐│49 │4A │4B │4C │                             │   │
+ * └────────┘   ├────┼───┼───┴┬──┴───┴───┴───┴───┴───┴─┬─┴─┬─┴─┬─┴──┬───┘│74 │└───┼───┼───┼───┤                             │4C │ 2u Enter
+ *              │50  │51 │52  │59                      │55 │56 │57  │┌───┼───┼───┐│5A │5B │5C │                             │   │
+ *              └────┴───┴────┴────────────────────────┴───┴───┴────┘│58 │53 │54 │└───┴───┴───┘                             └───┘
+ *              ┌─────┬─────┬───────────────────────────┬─────┬─────┐└───┴───┴───┘
+ *              │50   │52   │59                         │55   │57   │ WKL
+ *              └─────┴─────┴───────────────────────────┴─────┴─────┘
  */
 
-// 2u backspace: XXX, k71
-// split backspace: k70, k71
-
-// 2u numpad +: k2c, XXX
-// split numpad +: k2c, k3c
-
-// 2u numpad enter: k4c, XXX
-// split numpad enter: k4c, k5c
-
-// 2.25u lshift: k40, XXX
-// split (1.25u, 1u) lshift: k40, k41
-
-// ANSI enter or ISO enter: k38
-// Key next to ISO enter: k72
-// backslash or NUHS: k73
-
-// left winkey: k50, k51, k52
-// left WKL: k50, XXX, k52
-
-// right winkey: k55, k56, k57
-// right WKL: k55, XXX, k57
-
 #define LAYOUT_all( \
   k00,  k01, k02, k03, k04,  k60, k61, k62, k63,  k05, k06, k07, k08,   k72,  k09, k0a, k0b, k0c, \
   k10, k11, k12, k13, k14, k64, k65, k66, k67, k15, k16, k17, k18, k70, k71,  k19, k1a, k1b, k1c, \
@@ -100,3 +89,22 @@ inline void kbd19x_nmlk_led_off(void)   { writePinLow(LED_NUM_LOCK_PIN); }
   {k60, k61, k62, k63, k64, k65, k66, k67, k68, k69, k6a, k6b, k6c},\
   {XXX, k71, k72, k73, k74, k75, k76, k77, k78, k79, k7a, k7b, XXX},\
 }
+
+#define LAYOUT_iso( \
+  k00,  k01, k02, k03, k04,  k60, k61, k62, k63,  k05, k06, k07, k08, k72,     k09, k0a, k0b, k0c, \
+  k10, k11, k12, k13, k14, k64, k65, k66, k67, k15, k16, k17, k18,    k71,     k19, k1a, k1b, k1c, \
+  k20,  k21, k22, k23, k24, k68, k69, k6a, k6b, k25, k26, k27, k28,            k29, k2a, k2b, k2c, \
+  k30,    k31, k32, k33, k34, k6c, k75, k76, k77, k35, k36, k37, k73, k38,     k39, k3a, k3b,      \
+  k40, k41, k42, k43, k44, k78, k79, k7a, k7b, k45, k46, k47,    k48,   k74,   k49, k4a, k4b, k4c, \
+  k50, k51, k52,                k59,            k55, k56, k57,     k58, k53, k54,   k5a, k5b       \
+)\
+{\
+  {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c},\
+  {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c},\
+  {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c},\
+  {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, XXX},\
+  {k40, k41, k42, k43, k44, k45, k46, k47, k48, k49, k4a, k4b, k4c},\
+  {k50, k51, k52, k53, k54, k55, k56, k57, k58, k59, k5a, k5b, XXX},\
+  {k60, k61, k62, k63, k64, k65, k66, k67, k68, k69, k6a, k6b, k6c},\
+  {XXX, k71, k72, k73, k74, k75, k76, k77, k78, k79, k7a, k7b, XXX},\
+}

+ 36 - 0
keyboards/kbdfans/kbd19x/keymaps/default_iso/keymap.c

@@ -0,0 +1,36 @@
+/*
+Copyright 2018 Jeff Shufelt <jshuf@puppyfish.com> @jshuf
+
+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/>.
+*/
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_iso( /* Base */
+    KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  BL_STEP,          KC_PSCR, KC_SLCK, KC_PAUS, KC_PGDN,
+    KC_GRV,  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_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
+    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_P7,   KC_P8,   KC_P9,   KC_PPLS,
+    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_NUHS, KC_ENT,           KC_P4,   KC_P5,   KC_P6,
+    KC_LSFT, KC_NUBS, 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_P1,   KC_P2,   KC_P3,   KC_PENT,
+    KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                    KC_RALT, MO(1),   KC_RCTL,     KC_LEFT, KC_DOWN, KC_RGHT,      KC_P0,   KC_PDOT
+  ),
+  [1] = LAYOUT_iso( /* Func */
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  RGB_TOG,         _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  RESET,           _______, _______, _______, _______,
+    _______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______,                   _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,          _______, _______, _______,
+    _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,     _______,      _______, _______, _______, _______,
+    _______, _______, _______,                            _______,                   _______, _______, _______,     _______, _______, _______,      _______, _______
+  ),
+};

+ 12 - 3
keyboards/kbdfans/kbd19x/readme.md

@@ -8,14 +8,23 @@
 
 The KBD19x is a compact-1800 keyboard kit produced by KBDfans, offering a number of layout options.
 
-**Reset Sequence:** Using this firmware sets `BOOTLOADER_ENABLE` to `lite`. While plugging in, hold the top left key, commonly programmed as `Esc` to put your board into bootloader mode. 
-
 * Keyboard Maintainer: [jshuf](https://github.com/jshuf), [MechMerlin](https://github.com/mechmerlin)
 * Hardware Supported: KBD19x PCB
-* Hardware Availability: [KBDfans](https://kbdfans.cn)
+* Hardware Availability: [~~KBDfans~~](https://kbdfans.com/collections/95-kbd19x/products/kbdfans-kbd19x-pcb), [~~AliExpress~~](https://www.aliexpress.com/item/32835566884.html) (no longer available)
 
 Make example for this keyboard (after setting up your build environment):
 
     make kbdfans/kbd19x:default
 
+Flashing example for this keyboard:
+
+    make kbdfans/kbd19x:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Bootmagic reset**: Hold the `Esc` key while connecting the USB cable (also erases persistent settings)
+* **Keycode in keymap**: Press the key mapped to `RESET` if it is available (`Fn`+`Backspace` by default)
+
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).