add keyboard: bemeier/bmek (revisited) (qmk#10144)

* bmek keyboard support * Update keyboards/bemeier/bmek/bmek.h Co-authored-by: Drashna Jaelre <[email protected]> * Update keyboards/bemeier/bmek/rules.mk Co-authored-by: Drashna Jaelre <[email protected]> * moved shutdown behavior to shutdown hook * removed dynamic macro option statement * Apply suggestions from code review Co-authored-by: James Young <[email protected]> * Apply suggestions from code review Co-authored-by: James Young <[email protected]> * change layout name in via * move/copy root rules to revs * Apply suggestions from code review Co-authored-by: Drashna Jaelre <[email protected]> * Apply suggestions from code review Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: James Young <[email protected]>
kjganz · Sep 9, 2020 · a433761 · a433761
1 parent c8099f3
commit a433761
Show file tree

Hide file tree

Showing 22 changed files with 654 additions and 0 deletions.
diff --git a/keyboards/bemeier/bmek/README.md b/keyboards/bemeier/bmek/README.md
@@ -0,0 +1,30 @@
+# BMEK
+
+![BMEK](https://i.imgur.com/p1KFi6ql.jpg)
+
+BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source.
+
+* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier)
+* Hardware Supported: BMEK PCB rev1, rev2, rev3
+* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek)
+
+Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment):
+
+    make bemeier/bmek/rev3:default
+
+Make the VIA compatible firmware:
+
+    make bemeier/bmek/rev3:via
+
+The ```rev3```, denotes the version of the PCB.
+Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3).
+
+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).
+
+# Layouts
+
+Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported:
+
+![layouts](https://i.imgur.com/XuFxwthl.png)
+
+Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder).
diff --git a/keyboards/bemeier/bmek/bmek.c b/keyboards/bemeier/bmek/bmek.c
@@ -0,0 +1,23 @@
+/* Copyright 2020 bemeier
+ *
+ * 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 "bmek.h"
+
+__attribute__((weak))
+void shutdown_user() {
+#ifdef RGBLIGHT_ENABLE
+    rgblight_setrgb(255, 0, 0);
+#endif
+}
diff --git a/keyboards/bemeier/bmek/bmek.h b/keyboards/bemeier/bmek/bmek.h
@@ -0,0 +1,58 @@
+/* Copyright 2020 bemeier
+ *
+ * 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/>.
+ */
+#pragma once
+
+#include "quantum.h"
+
+#if defined(KEYBOARD_bemeier_bmek_rev1)
+#    include "rev1.h"
+#elif defined(KEYBOARD_bemeier_bmek_rev2)
+#    include "rev2.h"
+#elif defined(KEYBOARD_bemeier_bmek_rev3)
+#    include "rev3.h"
+#endif
+
+#define XXX KC_NO  // makes the switch matrix easier to read
+
+// This layout is supported by all revisions
+#define LAYOUT_hhkb(\
+       K00, K01, K02, K03, K04, K05, K06, K07,     K08, K09, K0A, K0B, K0C, K0D, K0E, K1E,\
+      K10,  K11,  K12, K13, K14, K15, K16,        K17, K18, K19, K1A, K1B, K1C, K1D,   K2E,\
+     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,  K3D,    K3E,\
+                    K42,   K43,      K45,             K48,      K4A,  K4B                     \
+   ) { \
+    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E }, \
+    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E }, \
+    { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, K2E }, \
+    { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E }, \
+    { XXX, XXX, K42, K43, XXX, K45, XXX, XXX, K48, XXX, K4A, K4B, XXX, XXX, XXX }  \
+}
+
+// Layout exposing all keys (adding the ISO-style split left shift, which is supported starting rev3)
+#define LAYOUT_all(\
+       K00, K01, K02, K03, K04, K05, K06, K07,     K08, K09, K0A, K0B, K0C, K0D, K0E, K1E,\
+      K10,  K11,  K12, K13, K14, K15, K16,        K17, K18, K19, K1A, K1B, K1C, K1D,   K2E,\
+     K20,   K21,   K22, K23, K24, K25, K26,        K27, K28, K29, K2A, K2B,     K2C,    K2D,\
+    K30,  K31, K41, K32,   K33, K34, K35, K36,   K37, K38, K39, K3A,  K3B, K3C,  K3D,    K3E,\
+                    K42,   K43,      K45,             K48,      K4A,  K4B                     \
+   ) { \
+    { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E }, \
+    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E }, \
+    { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, K2E }, \
+    { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E }, \
+    { XXX, K41, K42, K43, XXX, K45, XXX, XXX, K48, XXX, K4A, K4B, XXX, XXX, XXX }  \
+}
diff --git a/keyboards/bemeier/bmek/config.h b/keyboards/bemeier/bmek/config.h
@@ -0,0 +1,47 @@
+/* Copyright 2020 bemeier
+ *
+ * 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/>.
+ */
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x626D // BeMeier
+#define PRODUCT_ID 0x656B // ErgonomicKeyboard
+#define MANUFACTURER Bemeier
+#define PRODUCT BMEK
+
+#define DYNAMIC_KEYMAP_LAYER_COUNT 5
+#define VIA_EEPROM_CUSTOM_CONFIG_SIZE 20 
+
+/* Keyboard Matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 15
+
+#define DIODE_DIRECTION COL2ROW
+
+#define RGBLIGHT_EFFECT_BREATHING
+#define RGBLIGHT_EFFECT_RAINBOW_MOOD
+#define RGBLIGHT_MODE_STATIC_GRADIENT
+
+#define RGBLED_NUM 6
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#define RGBLIGHT_LIMIT_VAL 255
+
+#define DEBOUNCE 5
+//#define RETRO_TAPPING
+#define TAPPING_TERM 175
diff --git a/keyboards/bemeier/bmek/info.json b/keyboards/bemeier/bmek/info.json
@@ -0,0 +1,25 @@
+{
+    "keyboard_name": "bmek", 
+    "url": "https://github.com/Bemeier/bmek", 
+    "maintainer": "Bemeier", 
+    "width": 18, 
+    "height": 5,
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [
+                {"label":"Home", "x":0, "y":0}, {"label":"Esc", "x":1.5, "y":0}, {"label":"!", "x":2.5, "y":0}, {"label":"@", "x":3.5, "y":0}, {"label":"#", "x":4.5, "y":0}, {"label":"$", "x":5.5, "y":0}, {"label":"%", "x":6.5, "y":0}, {"label":"^", "x":7.5, "y":0}, {"label":"&", "x":10, "y":0}, {"label":"*", "x":11, "y":0}, {"label":"(", "x":12, "y":0}, {"label":")", "x":13, "y":0}, {"label":"_", "x":14, "y":0}, {"label":"+", "x":15, "y":0}, {"label":"|", "x":16, "y":0}, {"label":"~", "x":17, "y":0},
+                {"label":"PgUp", "x":0, "y":1}, {"label":"Tab", "x":1.5, "y":1, "w":1.5}, {"label":"Q", "x":3, "y":1}, {"label":"W", "x":4, "y":1}, {"label":"E", "x":5, "y":1}, {"label":"R", "x":6, "y":1}, {"label":"T", "x":7, "y":1}, {"label":"Y", "x":9.5, "y":1}, {"label":"U", "x":10.5, "y":1}, {"label":"I", "x":11.5, "y":1}, {"label":"O", "x":12.5, "y":1}, {"label":"P", "x":13.5, "y":1}, {"label":"{", "x":14.5, "y":1}, {"label":"}", "x":15.5, "y":1}, {"label":"Backspace", "x":16.5, "y":1, "w":1.5},
+                {"label":"PgDn", "x":0, "y":2}, {"label":"Ctrl", "x":1.5, "y":2, "w":1.75}, {"label":"A", "x":3.25, "y":2}, {"label":"S", "x":4.25, "y":2}, {"label":"D", "x":5.25, "y":2}, {"label":"F", "x":6.25, "y":2}, {"label":"G", "x":7.25, "y":2}, {"label":"H", "x":9.75, "y":2}, {"label":"J", "x":10.75, "y":2}, {"label":"K", "x":11.75, "y":2}, {"label":"L", "x":12.75, "y":2}, {"label":":", "x":13.75, "y":2}, {"label":"\"", "x":14.75, "y":2}, {"label":"Enter", "x":15.75, "y":2, "w":2.25},
+                {"label":"End", "x":0, "y":3}, {"label":"Shift", "x":1.5, "y":3, "w":1.25}, {"label":"~", "x":2.75, "y":3}, {"label":"Z", "x":3.75, "y":3}, {"label":"X", "x":4.75, "y":3}, {"label":"C", "x":5.75, "y":3}, {"label":"V", "x":6.75, "y":3}, {"label":"B", "x":7.75, "y":3}, {"label":"B", "x":9.25, "y":3}, {"label":"N", "x":10.25, "y":3}, {"label":"M", "x":11.25, "y":3}, {"label":"<", "x":12.25, "y":3}, {"label":">", "x":13.25, "y":3}, {"label":"?", "x":14.25, "y":3}, {"label":"Shift", "x":15.25, "y":3, "w":1.75}, {"label":"Fn", "x":17, "y":3}, {"label":"Win", "x":3.75, "y":4}, {"label":"Alt", "x":4.75, "y":4, "w":1.25}, {"x":6, "y":4, "w":2.75}, {"x":9.25, "y":4, "w":2.75}, {"label":"Alt", "x":12, "y":4, "w":1.25}, {"label":"Win", "x":13.25, "y":4}
+            ]
+        },
+        "LAYOUT_hhkb": {
+            "layout": [
+                {"label":"Home", "x":0, "y":0}, {"label":"Esc", "x":1.5, "y":0}, {"label":"!", "x":2.5, "y":0}, {"label":"@", "x":3.5, "y":0}, {"label":"#", "x":4.5, "y":0}, {"label":"$", "x":5.5, "y":0}, {"label":"%", "x":6.5, "y":0}, {"label":"^", "x":7.5, "y":0}, {"label":"&", "x":10, "y":0}, {"label":"*", "x":11, "y":0}, {"label":"(", "x":12, "y":0}, {"label":")", "x":13, "y":0}, {"label":"_", "x":14, "y":0}, {"label":"+", "x":15, "y":0}, {"label":"|", "x":16, "y":0}, {"label":"~", "x":17, "y":0},
+                {"label":"PgUp", "x":0, "y":1}, {"label":"Tab", "x":1.5, "y":1, "w":1.5}, {"label":"Q", "x":3, "y":1}, {"label":"W", "x":4, "y":1}, {"label":"E", "x":5, "y":1}, {"label":"R", "x":6, "y":1}, {"label":"T", "x":7, "y":1}, {"label":"Y", "x":9.5, "y":1}, {"label":"U", "x":10.5, "y":1}, {"label":"I", "x":11.5, "y":1}, {"label":"O", "x":12.5, "y":1}, {"label":"P", "x":13.5, "y":1}, {"label":"{", "x":14.5, "y":1}, {"label":"}", "x":15.5, "y":1}, {"label":"Backspace", "x":16.5, "y":1, "w":1.5},
+                {"label":"PgDn", "x":0, "y":2}, {"label":"Ctrl", "x":1.5, "y":2, "w":1.75}, {"label":"A", "x":3.25, "y":2}, {"label":"S", "x":4.25, "y":2}, {"label":"D", "x":5.25, "y":2}, {"label":"F", "x":6.25, "y":2}, {"label":"G", "x":7.25, "y":2}, {"label":"H", "x":9.75, "y":2}, {"label":"J", "x":10.75, "y":2}, {"label":"K", "x":11.75, "y":2}, {"label":"L", "x":12.75, "y":2}, {"label":":", "x":13.75, "y":2}, {"label":"\"", "x":14.75, "y":2}, {"label":"Enter", "x":15.75, "y":2, "w":2.25},
+                {"label":"End", "x":0, "y":3}, {"label":"Shift", "x":1.5, "y":3, "w":2.25}, {"label":"Z", "x":3.75, "y":3}, {"label":"X", "x":4.75, "y":3}, {"label":"C", "x":5.75, "y":3}, {"label":"V", "x":6.75, "y":3}, {"label":"B", "x":7.75, "y":3}, {"label":"B", "x":9.25, "y":3}, {"label":"N", "x":10.25, "y":3}, {"label":"M", "x":11.25, "y":3}, {"label":"<", "x":12.25, "y":3}, {"label":">", "x":13.25, "y":3}, {"label":"?", "x":14.25, "y":3}, {"label":"Shift", "x":15.25, "y":3, "w":1.75}, {"label":"Fn", "x":17, "y":3}, {"label":"Win", "x":3.75, "y":4}, {"label":"Alt", "x":4.75, "y":4, "w":1.25}, {"x":6, "y":4, "w":2.75}, {"x":9.25, "y":4, "w":2.75}, {"label":"Alt", "x":12, "y":4, "w":1.25}, {"label":"Win", "x":13.25, "y":4}
+            ]
+        }
+    }
+}
diff --git a/keyboards/bemeier/bmek/keymaps/default/README.md b/keyboards/bemeier/bmek/keymaps/default/README.md
@@ -0,0 +1,4 @@
+# Default BMEK Keymap
+This is the default keymap for the BMEK, besides the left macro columns and the split spacebars.
+It's uses the HHKB-like layout options (no split left shift, split backspace and split right shift).
+Please checkout the diagrams in ```keymap.c``` for an overview of the keymap.