[Keyboard] Add keebformom ortho 4x10 (qmk#18104)

Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: jack <0x6a73@protonmail.com>
4pplet · Feb 3, 2023 · 4d09bfa · 4d09bfa
1 parent c3406eb
commit 4d09bfa
Show file tree

Hide file tree

Showing 10 changed files with 357 additions and 0 deletions.
diff --git a/keyboards/keebformom/config.h b/keyboards/keebformom/config.h
@@ -0,0 +1,60 @@
+/* Copyright 2022 Sandipratama <https://github.com/nendezkombet>
+
+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
+
+/*
+ * 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)
+ *
+ */
+/* KFM PCB default pin-out */
+#define MATRIX_ROW_PINS { F5, F6, F7, B1 }
+#define MATRIX_COL_PINS { B3, B2, D1, D0, D4, C6, D7, E6, B4, B5 }
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define RGB_DI_PIN F4
+#ifdef RGB_DI_PIN
+#define RGBLED_NUM 40
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#define RGBLIGHT_LIMIT_VAL 150 /* The maximum brightness level */
+#define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+#    define RGBLIGHT_EFFECT_BREATHING
+#    define RGBLIGHT_EFFECT_RAINBOW_MOOD
+#    define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
diff --git a/keyboards/keebformom/info.json b/keyboards/keebformom/info.json
@@ -0,0 +1,60 @@
+{
+    "keyboard_name": "Keeb For Mom",
+    "url": "",
+    "maintainer": "qmk",
+    "manufacturer": "nendezkombet/sandipratama",
+    "usb": {
+        "vid": "0x458F",
+        "pid": "0x14E2",
+        "device_version": "1.0.0"
+    },
+    "processor": "atmega32u4",
+    "bootloader": "caterina",
+    "layouts": {
+        "LAYOUT_ortho_4x10": {
+            "layout": [
+                {"x":0, "y":0},
+                {"x":1, "y":0},
+                {"x":2, "y":0},
+                {"x":3, "y":0},
+                {"x":4, "y":0},
+                {"x":5, "y":0},
+                {"x":6, "y":0},
+                {"x":7, "y":0},
+                {"x":8, "y":0},
+                {"x":9, "y":0},
+                {"x":0, "y":1},
+                {"x":1, "y":1},
+                {"x":2, "y":1},
+                {"x":3, "y":1},
+                {"x":4, "y":1},
+                {"x":5, "y":1},
+                {"x":6, "y":1},
+                {"x":7, "y":1},
+                {"x":8, "y":1},
+                {"x":9, "y":1},
+                {"x":0, "y":2},
+                {"x":1, "y":2},
+                {"x":2, "y":2},
+                {"x":3, "y":2},
+                {"x":4, "y":2},
+                {"x":5, "y":2},
+                {"x":6, "y":2},
+                {"x":7, "y":2},
+                {"x":8, "y":2},
+                {"x":9, "y":2},
+                {"x":0, "y":3},
+                {"x":1, "y":3},
+                {"x":2, "y":3},
+                {"x":3, "y":3},
+                {"x":4, "y":3},
+                {"x":5, "y":3},
+                {"x":6, "y":3},
+                {"x":7, "y":3},
+                {"x":8, "y":3},
+                {"x":9, "y":3}
+
+            ]
+        }
+    }
+}
diff --git a/keyboards/keebformom/keebformom.c b/keyboards/keebformom/keebformom.c
@@ -0,0 +1,17 @@
+/* Copyright 2022 Sandipratama <https://github.com/nendezkombet>
+
+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 "keebformom.h"
diff --git a/keyboards/keebformom/keebformom.h b/keyboards/keebformom/keebformom.h
@@ -0,0 +1,40 @@
+/* Copyright 2022 Sandipratama <https://github.com/nendezkombet>
+
+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"
+
+/* 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.
+ */
+#define LAYOUT_ortho_4x10( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09,   \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19,   \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,   \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39    \
+) \
+{ \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09,  }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19,  }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,  }, \
+    { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39   }  \
+}
diff --git a/keyboards/keebformom/keymaps/default/config.h b/keyboards/keebformom/keymaps/default/config.h
@@ -0,0 +1,19 @@
+/* Copyright 2022 Sandipratama <https://github.com/nendezkombet>
+
+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
+
+#define COMBO_COUNT 7
diff --git a/keyboards/keebformom/keymaps/default/keymap.c b/keyboards/keebformom/keymaps/default/keymap.c
@@ -0,0 +1,117 @@
+/* Copyright 2022 Sandipratama
+ *
+ * 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
+
+
+enum layers {
+    _FIRST = 0,
+    _SECOND,
+    _THIRD,
+    _FOURTH
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* FIRST
+ * ,---------------------------------------------------------------------.
+ * |   Q (ESC) W |   E  |   R  |   T  |   Y  |   U  |   I  |   O(DEL) P  |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * |   A (TAB) S |   D  |   F  |   G(TO 1)H  |   J  |   K  |   L(CAPS);: |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * |   Z  |   X  |   C  |   V  |   B(TO 2)N  |   M  |  ,<  |  .>(TO3)/?  |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * | CTRL |  ALT | SHIFT|  L2  |ENTER | SPACE|   L1 | MUTE | PLAY | BSPC |
+ * `---------------------------------------------------------------------'
+ */
+[_FIRST] = LAYOUT_ortho_4x10(
+  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,
+  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN,
+  KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,
+  KC_LCTL, KC_LALT, KC_LSFT, MO(1),   KC_ENT,  KC_SPC, MO(2),    KC_MUTE, KC_MPLY, KC_BSPC
+),
+/* SECOND
+ * ,---------------------------------------------------------------------.
+ * |   !  |   @  |   {  |   }  |   '  |   "  |   -  |   7  |   8  |   9  |
+ * |------+------+------+------+------+-------------+------+------+------|
+ * |   #  |   $  |   (  |   )  |   ^  |   _  |   +  |   4  |   5  |   6  |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * |   %  |   &  |   [  |   ]  |   *  |      |      |   1  |   2  |   3  |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * | BASE |      |   \  |   |  |      |      |      |   =  |   0  | BSPC |
+ * `---------------------------------------------------------------------'
+ */
+
+[_SECOND] = LAYOUT_ortho_4x10(
+  KC_EXLM,    KC_AT,     KC_LCBR,    KC_RCBR,   KC_QUOT,   KC_DQT,     KC_PLUS,     KC_7,       KC_8,       KC_9,
+  KC_HASH,    KC_DLR,    KC_LPRN,    KC_RPRN,   KC_CIRC,   KC_UNDS,     KC_MINS,    KC_4,       KC_5,       KC_6,
+  KC_PERC,    KC_AMPR,   KC_LBRC,    KC_RBRC,   KC_ASTR,   _______,    _______,     KC_1,       KC_2,       KC_3,
+  TO(0),      _______,   KC_BSLS,    KC_PIPE,   _______,   _______,    _______,     KC_EQL,     KC_0,       KC_BSPC
+),              
+
+/* THIRD
+ * ,---------------------------------------------------------------------.
+ * |  INS | HOME | PGUP |      | CAPT |SELECT|      |      |  UP  |      |
+ * |------+------+------+------+------+-------------+------+------+------|
+ * |  DEL | END  | PGDN |      | SAVE | COPY |      | LEFT | DOWN | RGHT |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      | MYCMP| PASTE|      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * | BASE |      |      |      |      |      |      | VOLD |      | VOLU |
+ * `---------------------------------------------------------------------'
+ */
+[_THIRD] = LAYOUT_ortho_4x10(
+  KC_INS,  KC_HOME, KC_PGUP, KC_NO,    SGUI(KC_S),   LCTL(KC_A),   KC_NO,    KC_NO,   KC_UP,   KC_NO,
+  KC_DEL,  KC_END,  KC_PGDN, KC_NO,    LCTL(KC_S),   LCTL(KC_C),   KC_NO,    KC_LEFT, KC_DOWN, KC_RGHT, 
+  KC_NO,   KC_NO,   KC_NO,   KC_NO,    LWIN(KC_E),   LCTL(KC_V),   KC_NO,    KC_NO,   KC_NO,   KC_NO,
+  TO(0),   _______, _______, _______,  _______,      _______,      _______,  KC_VOLD, _______, KC_VOLU
+),    
+/* FOURTH
+ * ,---------------------------------------------------------------------.
+ * |RGB M+|  HUD |  HUI |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |
+ * |------+------+------+------+------+-------------+------+------+------|
+ * |RGB M-|  SAD |  SAI |      |  F7  |  F8  |  F9  |  F10 | F11  | F12  |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * |RGB TG|  VAD |  VAI |      |      |      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------|
+ * | BASE |      |      |      |      |      |      |      |      |      |
+ * `---------------------------------------------------------------------'
+ */
+[_FOURTH] = LAYOUT_ortho_4x10(
+  RGB_MOD, RGB_HUD, RGB_HUI, KC_NO,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,
+  RGB_RMOD,RGB_SAD, RGB_SAI, KC_NO,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,
+  RGB_TOG, RGB_VAD, RGB_VAI, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,
+  TO(0),   _______, _______, _______, _______, _______, _______, _______, _______, _______
+)
+};
+
+// Combo key
+const uint16_t PROGMEM test_combo1[] = {KC_Q, KC_W, COMBO_END};
+const uint16_t PROGMEM test_combo2[] = {KC_MPLY, KC_BSPC, COMBO_END};
+const uint16_t PROGMEM test_combo3[] = {KC_L, KC_SCLN, COMBO_END};
+const uint16_t PROGMEM test_combo4[] = {KC_A, KC_S, COMBO_END};
+const uint16_t PROGMEM test_combo5[] = {KC_G, KC_H, COMBO_END};
+const uint16_t PROGMEM test_combo6[] = {KC_B, KC_N, COMBO_END};
+const uint16_t PROGMEM test_combo7[] = {KC_O, KC_P, COMBO_END};
+combo_t key_combos[COMBO_COUNT] = {
+    COMBO(test_combo1, KC_ESC),
+    COMBO(test_combo2, TO(3)),
+    COMBO(test_combo3, KC_CAPS),
+    COMBO(test_combo4, KC_TAB),
+    COMBO(test_combo5, TO(1)),
+    COMBO(test_combo6, TO(2)),
+    COMBO(test_combo7, KC_DEL),
+};
diff --git a/keyboards/keebformom/keymaps/default/readme.md b/keyboards/keebformom/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for Keeb For Mom
diff --git a/keyboards/keebformom/keymaps/default/rules.mk b/keyboards/keebformom/keymaps/default/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes
diff --git a/keyboards/keebformom/readme.md b/keyboards/keebformom/readme.md
@@ -0,0 +1,27 @@
+# Keeb For Mom
+
+![KeebForMom](https://i.imgur.com/MvBatHSh.jpg)
+
+KFM is a low cost 4x5 modular mechanical keyboard that everyone can build. Modular it's mean two PCBs can be combined become one 40% keyboard, so you can use the PCB board as single 4x5 macro pad or 4x10 ortholinier mechanical keyboard. The PCB board has some feature like south facing switches orientation, RGB perkey and passive buzzer supported which can be used as layer indicator.
+
+* Keyboard Maintainer: [sandipratama](https://github.com/nendezkombet)
+* Hardware Supported: KFM PCB
+* Hardware Availability: https://github.com/nendezkombet/Keeb-For-Mom
+
+Make example for this keyboard (after setting up your build environment):
+
+    make keebformom:default
+
+Flashing example for this keyboard:
+
+    make keebformom:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
diff --git a/keyboards/keebformom/rules.mk b/keyboards/keebformom/rules.mk
@@ -0,0 +1,15 @@
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = no            # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no       # Enable keyboard RGB underglow
+AUDIO_ENABLE = no          # Audio output
+LTO_ENABLE = yes
+NO_USB_STARTUP_CHECK = yes  
+LAYOUTS = ortho_4x10