Adding Bear 65 Ergo Keyboard To QMK (#10384)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

keyboards/bear_65/bear_65.c

@@ -0,0 +1,17 @@
+/* Copyright 2020 MudkipMao
+ *
+ * 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 "bear_65.h"

keyboards/bear_65/bear_65.h

@@ -0,0 +1,46 @@
+/* Copyright 2020 MudkipMao
+ *
+ * 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"
+
+#define LAYOUT_all( \
+      K31, K00, K01, K02, K03, K04, K05, K06,      K07, K08, K09, K0A, K0B, K0C, K0D, K0E,   K4E, \
+     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,   K2D,         \
+           K30,   K32, K33, K34, K35, K36,         K37, K38, K39, K3A, K3B, K3C,   K3D, K3E,      \
+           K40,     K43,    K45,      K46,               K48,     K4A,             K4B, K4C, K4D  \
+) { \
+    { 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,   KC_NO, K2D,   K2E   }, \
+    { K30,   K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   K3D,   K3E   }, \
+    { K40,   KC_NO, KC_NO, K43,   KC_NO, K45,   K46,   KC_NO, K48,   KC_NO, K4A,   K4B,   K4C,   K4D,   K4E   }, \
+}
+
+#define LAYOUT_full_bs( \
+      K31, K00, K01, K02, K03, K04, K05, K06,      K07, K08, K09, K0A, K0B, K0C,   K0D,      K4E, \
+     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,   K2D,         \
+           K30,   K32, K33, K34, K35, K36,         K37, K38, K39, K3A, K3B, K3C,   K3D, K3E,      \
+           K40,     K43,    K45,      K46,               K48,     K4A,             K4B, K4C, K4D  \
+) { \
+    { K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K0A,   K0B,   K0C,   K0D,   KC_NO }, \
+    { 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,   KC_NO, K2D,   K2E   }, \
+    { K30,   K31,   K32,   K33,   K34,   K35,   K36,   K37,   K38,   K39,   K3A,   K3B,   K3C,   K3D,   K3E   }, \
+    { K40,   KC_NO, KC_NO, K43,   KC_NO, K45,   K46,   KC_NO, K48,   KC_NO, K4A,   K4B,   K4C,   K4D,   K4E   }, \
+}

keyboards/bear_65/config.h

@@ -0,0 +1,76 @@
+/*
+Copyright 2020 MudkipMao
+
+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       0xA13B // Jacky's vendor ID, arbitrarily selected by MudkipMao
+#define PRODUCT_ID      0x000A
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Jacky
+#define PRODUCT         Jacky Bear 65 Ergo
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 15
+
+/*
+ * 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)
+ *
+ */
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, B7 }
+#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, F7, F6, F5, F4, F1, F0 }
+
+/* Setting the matrix value of top left key for bootmagic lite */
+#define BOOTMAGIC_LITE_ROW      3
+#define BOOTMAGIC_LITE_COLUMN   1
+
+#define DIODE_DIRECTION ROW2COL
+
+#define BACKLIGHT_PIN B6
+#define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 4
+
+#define RGB_DI_PIN E2
+#ifdef RGB_DI_PIN
+    #define RGBLED_NUM 15
+    #define RGBLIGHT_HUE_STEP 8
+    #define RGBLIGHT_SAT_STEP 8
+    #define RGBLIGHT_VAL_STEP 8
+    #define RGBLIGHT_LIMIT_VAL 139 /* 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
+#endif

keyboards/bear_65/keymaps/default/keymap.c

@@ -0,0 +1,39 @@
+/* Copyright 2020 MudkipMao
+ *
+ * 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
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT_all(
+             KC_ESC,  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_GRV,     KC_DEL,
+            KC_PGUP,  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_PGDN,   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_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
+                      KC_LCTL,     KC_LALT, KC_SPC, KC_LGUI,                KC_SPC,     MO(_FN),                        KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [_FN] = LAYOUT_all(
+             RESET,   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,          KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______, _______,     _______,
+            RGB_MOD,  _______, KC_BRID, KC_BRIU, _______, _______, _______,                 _______, _______, _______, _______, _______, RGB_VAD, RGB_VAI, _______,
+           RGB_TOG,   _______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______,                _______, _______, _______, _______,  _______,   _______,   _______,
+                      _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______,                _______, _______, _______, _______, _______, _______, _______, _______,
+                      _______,     _______, _______, _______,                _______,     _______,                        _______, _______,_______ 
+    )
+};

keyboards/bear_65/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for bear_65

keyboards/bear_65/keymaps/via/keymap.c

@@ -0,0 +1,47 @@
+/* Copyright 2020 MudkipMao
+ *
+ * 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_full_bs(
+             KC_ESC,  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_DEL,
+            KC_PGUP,  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_PGDN,   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_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
+                      KC_LCTL,     KC_LALT, KC_SPC, KC_LGUI,                KC_SPC,     MO(1),                        KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+    [1] = LAYOUT_full_bs(
+             RESET,   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,          KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,     _______,
+            RGB_MOD,  _______, KC_BRID, KC_BRIU, _______, _______, _______,                 _______, _______, _______, _______, _______, RGB_VAD, RGB_VAI, _______,
+           RGB_TOG,   _______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______,                _______, _______, _______, _______,  _______,   _______,   _______,
+                      _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______,                _______, _______, _______, _______, _______, _______, _______, _______,
+                      _______,     _______, _______, _______,                _______,     _______,                        _______, _______,_______ 
+    ),
+    [2] = LAYOUT_full_bs(
+             _______,   _______, _______,   _______,   _______,   _______,   _______,   _______,          _______,   _______,   _______,   _______,  _______,  _______,  _______,     _______,
+            _______,  _______, _______, _______, _______, _______, _______,                 _______, _______, _______, _______, _______, _______, _______, _______,
+           _______,   _______, _______, _______, _______, _______, _______,                _______, _______, _______, _______,  _______,   _______,   _______,
+                      _______, _______, _______, _______, _______, _______,                _______, _______, _______, _______, _______, _______, _______, _______,
+                      _______,     _______, _______, _______,                _______,     _______,                        _______, _______,_______ 
+    ),
+    [3] = LAYOUT_full_bs(
+             _______,   _______, _______,   _______,   _______,   _______,   _______,   _______,          _______,   _______,   _______,   _______,  _______,  _______,  _______,     _______,
+            _______,  _______, _______, _______, _______, _______, _______,                 _______, _______, _______, _______, _______, _______, _______, _______,
+           _______,   _______, _______, _______, _______, _______, _______,                _______, _______, _______, _______,  _______,   _______,   _______,
+                      _______, _______, _______, _______, _______, _______,                _______, _______, _______, _______, _______, _______, _______, _______,
+                      _______,     _______, _______, _______,                _______,     _______,                        _______, _______,_______ 
+    )
+};

keyboards/bear_65/keymaps/via/readme.md

@@ -0,0 +1 @@
+# The via keymap for bear_65

keyboards/bear_65/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/bear_65/readme.md

@@ -0,0 +1,19 @@
+# Bear 65
+
+![Bear 65](https://i.imgur.com/W1sVP1Tl.jpg)
+
+A gasket-mounted 65% keyboard inspired by the [TGR Alice](https://github.com/qmk/qmk_firmware/tree/master/keyboards/tgr/alice). Designed and produced by [jacky](https://geekhack.org/index.php?action=profile;u=63864) from Geekhack.
+
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: Bear 65
+* Hardware Availability: The GB happened July 15th 2020, units are still in production
+
+Make example for this keyboard (after setting up your build environment):
+
+    make bear_65:default
+
+Flashing example for this keyboard:
+
+    make bear_65: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).

keyboards/bear_65/rules.mk

@@ -0,0 +1,24 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+
+LTO_ENABLE = yes            # Use LTO flags to reduce firmware size