[Keyboard] bm68rgb (#12128)

* add support for Bbm68rgb

* pull request changes filled

* pull request changes filled(this time for real)

* added new line to files that did not have new lines at end of file

* updated modifier keys for rgb effects

* Update keyboards/bm68rgb/readme.md

* Apply suggestions from code review

* Apply suggestions from code review

* add nkro suppport

* Update keyboards/bm68rgb/rules.mk

* modified keymap to better correspond to physical layout

* updated comment style
This commit is contained in:
peepeetee 2021-03-06 17:13:20 -06:00 committed by GitHub
parent 788b1854b4
commit 9b85b1b638
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 429 additions and 0 deletions

View file

@ -0,0 +1,59 @@
/* Copyright 2021 peepeetee
*
* 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 "bm68rgb.h"
#ifdef RGB_MATRIX_ENABLE
led_config_t g_led_config = { {
// Key Matrix to LED Index
{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 },
{ 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29 },
{ 30, NO_LED, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43 },
{ NO_LED, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57 },
{ 58, 59, 60, NO_LED, NO_LED, NO_LED, 61, NO_LED, NO_LED, 62, 63, 64, 65, 66, 67 }
}, {
// LED Index to Physical Position
//I have no idea how to calculate this based on a templete, nor do have a good enough ruler to measure this.
// Esc, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, -, =, Backspace, Delete
{ 0, 0 }, { 15, 0 }, { 30, 0 }, { 45, 0 }, { 60, 0 }, { 75, 0 }, { 90, 0 }, { 105, 0 }, { 120, 0 }, { 135, 0 }, { 150, 0 }, { 165, 0 }, { 180, 0 }, { 202, 0 }, { 225, 0 },
// Tab, Q, W, E, R, T, Y, U, I, O, P, [, ], backslash , Home
{ 4, 16 }, { 22, 16 }, { 37, 16 }, { 52, 16 }, { 67, 16 }, { 82, 16 }, { 97, 16 }, { 112, 16 }, { 127, 16 }, { 142, 16 }, { 157, 16 }, { 172, 16 }, { 187, 16 }, { 206, 16 }, { 225, 16 },
// Capslock, A, S, D, F, G, H, J, K, L, ;, ', Enter, Page up
{ 6, 32 }, { 26, 32 }, { 41, 32 }, { 56, 32 }, { 71, 32 }, { 86, 32 }, { 101, 32 }, { 116, 32 }, { 131, 32 }, { 146, 32 }, { 161, 32 }, { 176, 32 }, { 201, 32 }, { 225, 32 },
// LShift, Z, X, C, V, B, N, M, ,, ., /, Shift, Up, Page Down
{ 9, 48 }, { 34, 48 }, { 49, 48 }, { 64, 48 }, { 79, 48 }, { 94, 48 }, { 109, 48 }, { 124, 48 }, { 139, 48 }, { 154, 48 }, { 169, 48 }, { 189, 48 }, { 210, 48 }, { 225, 48 },
// Ctrl, GUI, Alt, Space, RAlt, FN, Ctrl, Left, Down, Right
{ 2, 64 }, { 21, 64 }, { 39, 64 }, { 94, 64 }, { 148, 64 }, { 163, 64 }, { 178, 64 }, { 193, 64 }, { 208, 64 }, { 225, 64 },
// UNDERGLOW
{ 185, 45 }, { 160, 45 }, { 125, 45 }, { 95, 45 }, { 60, 45 }, { 25, 45 }
}, {
// LED Index to Flag
//need to recheck what should be a modifier
// Esc, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, -, =, Backspace, Delete
1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1,
// Tab, Q, W, E, R, T, Y, U, I, O, P, [, ], backslash , Home
1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
// Capslock, A, S, D, F, G, H, J, K, L, ;, ', Enter, Page up
1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1,
// LShift, Z, X, C, V, B, N, M, ,, ., /, Shift, Up, Page Down
1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 1, 1,
// Ctrl, GUI, Alt, Space, RAlt, FN, Ctrl, Left, Down, Right
1, 1, 1, 4, 1, 1, 1, 1, 1, 1,
// UNDERGLOW
2, 2, 2, 2, 2, 2
} };
#endif

View file

@ -0,0 +1,41 @@
/* Copyright 2021 peepeetee
*
* 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_65_ansi( \
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, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E,\
k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D, k3E,\
k40, k41, k42, k46, k49, k4A, k4B, k4C, k4D, k4E\
) { \
{ 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, KC_NO, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B, k2C, k2D, k2E }, \
{ KC_NO, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A, k3B, k3C, k3D, k3E }, \
{ k40, k41, k42, KC_NO, KC_NO, KC_NO, k46, KC_NO, KC_NO, k49, k4A, k4B, k4C, k4D, k4E }, \
}

144
keyboards/bm68rgb/config.h Normal file
View file

@ -0,0 +1,144 @@
/*
Copyright 2021 peepeetee
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 0x4B50 //KP
#define PRODUCT_ID 0xEF6F
#define DEVICE_VER 0x0001
#define MANUFACTURER KPRepublic
#define PRODUCT bm68rgb
/* 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, \
E6 }
#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, B5, B6, C6, C7, F7, F6 }
#define UNUSED_PINS
/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW
// The pin connected to the data pin of the LEDs
#define RGB_DI_PIN E2
// The number of LEDs connected
#define DRIVER_LED_TOTAL 74
#ifdef RGB_DI_PIN
#define RGBLED_NUM 74
//# define RGBLIGHT_HUE_STEP 8
//# define RGBLIGHT_SAT_STEP 8
//# define RGBLIGHT_VAL_STEP 8
//# define RGBLIGHT_LIMIT_VAL 255 /* 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
/*== customize breathing effect ==*/
/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
//# define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
/*==== use exp() and sin() ====*/
//# define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
//# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
#endif
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5
/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
#define LOCKING_SUPPORT_ENABLE
/* Locking resynchronize hack */
#define LOCKING_RESYNC_ENABLE
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
* This is useful for the Windows task manager shortcut (ctrl+shift+esc).
*/
//#define GRAVE_ESC_CTRL_OVERRIDE
/*
* Force NKRO
*
* Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
* state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
* makefile for this to work.)
*
* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
* until the next keyboard reset.
*
* NKRO may prevent your keystrokes from being detected in the BIOS, but it is
* fully operational during normal computer usage.
*
* For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
* or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
* bootmagic, NKRO mode will always be enabled until it is toggled again during a
* power-up.
*
*/
//#define FORCE_NKRO
/*
* Feature disable options
* These options are also useful to firmware size reduction.
*/
/* disable debug print */
//#define NO_DEBUG
/* disable print */
//#define NO_PRINT
/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION
/* Bootmagic Lite key configuration */
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0

View file

@ -0,0 +1,81 @@
{
"keyboard_name": "bm68rgb",
"url": "",
"maintainer": "peepeetee",
"width": 15,
"height": 5,
"layouts": {
"LAYOUT_65_ansi": {
"layout": [
{"label":"K00 (B0,D0)", "x":0, "y":0},
{"label":"K01 (B0,D1)", "x":1, "y":0},
{"label":"K02 (B0,D2)", "x":2, "y":0},
{"label":"K03 (B0,D3)", "x":3, "y":0},
{"label":"K04 (B0,D5)", "x":4, "y":0},
{"label":"K05 (B0,D4)", "x":5, "y":0},
{"label":"K06 (B0,D6)", "x":6, "y":0},
{"label":"K07 (B0,D7)", "x":7, "y":0},
{"label":"K08 (B0,B4)", "x":8, "y":0},
{"label":"K09 (B0,B5)", "x":9, "y":0},
{"label":"K0A (B0,B6)", "x":10, "y":0},
{"label":"K0B (B0,C6)", "x":11, "y":0},
{"label":"K0C (B0,C7)", "x":12, "y":0},
{"label":"K0D (B0,F7)", "x":13, "y":0, "w":2},
{"label":"K0E (B0,F6)", "x":15, "y":0},
{"label":"K10 (B1,D0)", "x":0, "y":1, "w":1.5},
{"label":"K11 (B1,D1)", "x":1.5, "y":1},
{"label":"K12 (B1,D2)", "x":2.5, "y":1},
{"label":"K13 (B1,D3)", "x":3.5, "y":1},
{"label":"K14 (B1,D5)", "x":4.5, "y":1},
{"label":"K15 (B1,D4)", "x":5.5, "y":1},
{"label":"K16 (B1,D6)", "x":6.5, "y":1},
{"label":"K17 (B1,D7)", "x":7.5, "y":1},
{"label":"K18 (B1,B4)", "x":8.5, "y":1},
{"label":"K19 (B1,B5)", "x":9.5, "y":1},
{"label":"K1A (B1,B6)", "x":10.5, "y":1},
{"label":"K1B (B1,C6)", "x":11.5, "y":1},
{"label":"K1C (B1,C7)", "x":12.5, "y":1},
{"label":"K1D (B1,F7)", "x":13.5, "y":1, "w":1.5},
{"label":"K1E (B1,F6)", "x":15, "y":1},
{"label":"K20 (B2,D0)", "x":0, "y":2, "w":1.75},
{"label":"K22 (B2,D2)", "x":1.75, "y":2},
{"label":"K23 (B2,D3)", "x":2.75, "y":2},
{"label":"K24 (B2,D5)", "x":3.75, "y":2},
{"label":"K25 (B2,D4)", "x":4.75, "y":2},
{"label":"K26 (B2,D6)", "x":5.75, "y":2},
{"label":"K27 (B2,D7)", "x":6.75, "y":2},
{"label":"K28 (B2,B4)", "x":7.75, "y":2},
{"label":"K29 (B2,B5)", "x":8.75, "y":2},
{"label":"K2A (B2,B6)", "x":9.75, "y":2},
{"label":"K2B (B2,C6)", "x":10.75, "y":2},
{"label":"K2C (B2,C7)", "x":11.75, "y":2},
{"label":"K2D (B2,F7)", "x":12.75, "y":2, "w":2.25},
{"label":"K2E (B2,F6)", "x":15, "y":2},
{"label":"K31 (B3,D1)", "x":0, "y":3, "w":2.25},
{"label":"K32 (B3,D2)", "x":2.25, "y":3},
{"label":"K33 (B3,D3)", "x":3.25, "y":3},
{"label":"K34 (B3,D5)", "x":4.25, "y":3},
{"label":"K35 (B3,D4)", "x":5.25, "y":3},
{"label":"K36 (B3,D6)", "x":6.25, "y":3},
{"label":"K37 (B3,D7)", "x":7.25, "y":3},
{"label":"K38 (B3,B4)", "x":8.25, "y":3},
{"label":"K39 (B3,B5)", "x":9.25, "y":3},
{"label":"K3A (B3,B6)", "x":10.25, "y":3},
{"label":"K3B (B3,C6)", "x":11.25, "y":3},
{"label":"K3C (B3,C7)", "x":12.25, "y":3, "w":1.75},
{"label":"K3D (B3,F7)", "x":14, "y":3},
{"label":"K3E (B3,F6)", "x":15, "y":3},
{"label":"K40 (E6,D0)", "x":0, "y":4, "w":1.25},
{"label":"K41 (E6,D1)", "x":1.25, "y":4, "w":1.25},
{"label":"K42 (E6,D2)", "x":2.5, "y":4, "w":1.25},
{"label":"K46 (E6,D6)", "x":3.75, "y":4, "w":6.25},
{"label":"K49 (E6,B5)", "x":10, "y":4},
{"label":"K4A (E6,B6)", "x":11, "y":4},
{"label":"K4B (E6,C6)", "x":12, "y":4},
{"label":"K4C (E6,C7)", "x":13, "y":4},
{"label":"K4D (E6,F7)", "x":14, "y":4},
{"label":"K4E (E6,F6)", "x":15, "y":4}
]
}
}
}

View file

@ -0,0 +1,52 @@
/* Copyright 2021 peepeetee
*
* 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] = {
[0] = LAYOUT_65_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_DEL,
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_HOME,
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_PGUP,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_LSFT, KC_UP, KC_PGDN,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1),KC_RCTRL, KC_LEFT, KC_DOWN, KC_RGHT
),
[1] = LAYOUT_65_ansi(
KC_GRAVE, 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_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
};
/*
Templete
[ ] = LAYOUT_65_ansi(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
*/

View file

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

View file

@ -0,0 +1,24 @@
# bm68rgb
![bm68rgb](https://i.imgur.com/uuYP8OIl.jpeg)
A 65% hotswap in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee)
* Hardware Supported: BM68 RGB
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm68rgb-bm68-rgb-65-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-full-rgb-switch-underglow-type-c)
Make example for this keyboard (after setting up your build environment):
make bm68rgb:default
Flashing example for this keyboard:
make bm68rgb:default:flash
To reset the board into bootloader mode, do one of the following:
* Short the two-pad footprint to the left of the spacebar switch while the board is plugged in
* Hold the Esc key while connecting the USB cable (also erases persistent settings)
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).

View file

@ -0,0 +1,27 @@
# 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 = yes # USB Nkey Rollover
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no # Enable Bluetooth
AUDIO_ENABLE = no # Audio output
RGB_MATRIX_ENABLE = yes
RGB_MATRIX_DRIVER = WS2812
#LTO_ENABLE = yes
LAYOUTS = 65_ansi