keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Keyboard] MechWild BB Steno (#17163)

Browse Source 
* allowing the kt60 file to be modified so I can do things while waiting for it to be fixed upstream

* Initial commit

* testing modes

* working on puckbuddy firmware. This is all working for now but need to clean it up and personalize it.

* needs to be updated from vial build

* prepping for PR

* added rgb mode cycling to fn1 since it isn't on the encoder for these maps

* shipping firmware built. Need to clean up readme and info.json layout

* removing puckbuddy files from this branch

* readme done, prepping for PR

* info.json updated prepping for PR

* Restore cirque driver that was modified from puckbuddy testing on this branch

* applying changes from review

* Update keyboards/mechwild/bbs/bbs.c

* Fixed info.json

* Apply suggestions from code review
This commit is contained in:
Kyle McCreery 2022-07-14 02:26:13 -04:00 committed by GitHub
parent 99e9e1b8e7
commit acc11f4941
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 268 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
keyboards/mechwild/bbs/bbs.c Normal file
View File

@ -0,0 +1,22 @@
// Copyright 2022 Kyle McCreery (@kylemccreery)
// SPDX-License-Identifier: GPL-2.0-or-later
#include "bbs.h"
#ifdef DIP_SWITCH_ENABLE
bool dip_switch_update_kb(uint8_t index, bool active) {
if (!dip_switch_update_user(index, active)) { return false; }
switch (index) {
case 0:
if(active) { tap_code(KC_CLCK); }
break;
break;
}
return true;
}
#endif
void eeconfig_init_kb() {
steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT
eeconfig_init_user();
}

26
keyboards/mechwild/bbs/bbs.h Normal file
View File

@ -0,0 +1,26 @@
// Copyright 2022 Kyle McCreery (@kylemccreery)
// SPDX-License-Identifier: GPL-2.0-or-later
#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( \
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B,\
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B,\
k23, k24, k25, k26, k27, k28 \
) { \
{ k00, k01, k02, k03, k04, k05 }, \
{ k06, k07, k08, k09, k0A, k0B }, \
{ k10, k11, k12, k13, k14, k15 }, \
{ k16, k17, k18, k19, k1A, k1B }, \
{ k26, k27, k28, k23, k24, k25 } \
}

96
keyboards/mechwild/bbs/config.h Normal file
View File

@ -0,0 +1,96 @@
// Copyright 2022 Kyle McCreery (@kylemccreery)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include "config_common.h"
/* USB Device descriptor parameter */
#define VENDOR_ID 0x6D77 // mw = "MechWild"
#define PRODUCT_ID 0x170E
#define DEVICE_VER 0x0001
#define MANUFACTURER MechWild
#define PRODUCT BB Steno
/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 6
/* allows the "key" button on the blackpill to toggle caps lock for user testing before soldering */
#define DIP_SWITCH_PINS { A0 }
/* status light pins using the on board LED for the blackpill */
#define LED_CAPS_LOCK_PIN C13
#define LED_PIN_ON_STATE 0
/*
* 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 { B12, B10, B13, B1, B14 }
#define MATRIX_COL_PINS { B0, A7, A6, A5, A4, A3 }
#define UNUSED_PINS
/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5
/* 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
/* Bootmagic Lite key configuration */
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0

43
keyboards/mechwild/bbs/info.json Normal file
View File

@ -0,0 +1,43 @@
{
"keyboard_name": "BBS",
"maintainer": "kylemccreery",
"url": "https://mechwild.com/product/bb-steno/",
"layouts": {
"LAYOUT": {
"layout": [
{"label":"k00", "x":0, "y":0.5},
{"label":"k01", "x":1, "y":0.5},
{"label":"k02", "x":2, "y":0.25},
{"label":"k03", "x":3, "y":0.125},
{"label":"k04", "x":4, "y":0.25},
{"label":"k05", "x":5, "y":0.25},
{"label":"k06", "x":6.75, "y":0.25},
{"label":"k07", "x":7.75, "y":0.25},
{"label":"k08", "x":8.75, "y":0.125},
{"label":"k09", "x":9.75, "y":0.25},
{"label":"k0A", "x":10.75, "y":0.5},
{"label":"k0B", "x":11.75, "y":0.5},
{"label":"k10", "x":0, "y":1.5},
{"label":"k11", "x":1, "y":1.5},
{"label":"k12", "x":2, "y":1.25},
{"label":"k13", "x":3, "y":1.125},
{"label":"k14", "x":4, "y":1.25},
{"label":"k15", "x":5, "y":1.25},
{"label":"k16", "x":6.75, "y":1.25},
{"label":"k17", "x":7.75, "y":1.25},
{"label":"k18", "x":8.75, "y":1.125},
{"label":"k19", "x":9.75, "y":1.25},
{"label":"k1A", "x":10.75, "y":1.5},
{"label":"k1B", "x":11.75, "y":1.5},
{"label":"k23", "x":2.75, "y":3.25, "h":1.5},
{"label":"k24", "x":3.75, "y":3.25, "h":1.5},
{"label":"k25", "x":4.75, "y":3, "h":1.5},
{"label":"k26", "x":7, "y":3, "h":1.5},
{"label":"k27", "x":8, "y":3.25, "h":1.5},
{"label":"k28", "x":9, "y":3.25, "h":1.5}
]
}
}
}

31
keyboards/mechwild/bbs/keymaps/default/keymap.c Normal file
View File

@ -0,0 +1,31 @@
// Copyright 2022 Kyle McCreery (@kylemccreery)
// SPDX-License-Identifier: GPL-2.0-or-later
#include QMK_KEYBOARD_H
#include "keymap_steno.h"
// Defines names for use in layer keycodes and the keymap
enum layer_names {
_BASE,
_FN1
};
/*
* k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B,\
* k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B,\
* k23, k24, k25, k26, k27, k28 \
*/
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base */
[_BASE] = LAYOUT(
STN_RES1, STN_S1, STN_TL, STN_PL, STN_HL, STN_ST1, STN_ST3, STN_FR, STN_PR, STN_LR, STN_TR, STN_DR,
STN_RES2, STN_S2, STN_KL, STN_WL, STN_RL, STN_ST2, STN_ST4, STN_RR, STN_BR, STN_GR, STN_SR, STN_ZR,
STN_A, STN_O, STN_N1, STN_N2, STN_E, STN_U
),
[_FN1] = LAYOUT(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
)
};

27
keyboards/mechwild/bbs/readme.md Normal file
View File

@ -0,0 +1,27 @@
# BB Steno (BBS)
![BBS](https://i.imgur.com/XIjlzKOh.png)
A bare-bones stenography keyboard. No bells or whistles. Simple, cheap, effective, steno.
* Keyboard Maintainer: [Kyle McCreery](https://github.com/kylemccreery)
* Hardware Supported: BBS v0.1
* Hardware Availability: [BBS on MechWild](https://mechwild.com/product/bb-steno/)
Make example for this keyboard (after setting up your build environment):
make mechwild/bbs:default
Flashing example for this keyboard:
make mechwild/bbs: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 (assigned to the top left key) and plug in the keyboard while holding it.
* **Physical reset button**: Press and hold the boot0 button on the blackpill, tap and release the nrst button on the blackpill, then release the boot0 button.
* **Keycode in layout**: Press the key mapped to `RESET` if it is available.

23
keyboards/mechwild/bbs/rules.mk Normal file
View File

@ -0,0 +1,23 @@
# MCU name
MCU = STM32F401
# Bootloader selection
BOOTLOADER = stm32-dfu
# Build Options
# change yes to no to disable
#
BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
MOUSEKEY_ENABLE = no # Mouse keys
EXTRAKEY_ENABLE = no # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = no # Commands for debug and configuration
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
AUDIO_ENABLE = no # Audio output
DIP_SWITCH_ENABLE = yes # Dip Switch Enabled
# Necessary for stenography functionality
STENO_ENABLE = yes # Enable stenography endpoint
NKRO_ENABLE = yes # Enable N-Key Rollover
KEYBOARD_SHARED_EP = yes # Needed to free up an endpoint in blackpill