From 2742d0c4c119c35980997ee43d9ce0fc412ec250 Mon Sep 17 00:00:00 2001 From: peepeetee <43021794+peepeetee@users.noreply.github.com> Date: Tue, 28 Sep 2021 13:00:47 +0800 Subject: [Keyboard] Add BM80 Keyboard (#12948) * Initial compatibility with bm80 * move files to kprepublic directory, see #12159 * fix pin assignment * Revert "fix pin assignment" This reverts commit 5a53a74953a23bb5064c11d5d9e6daf007a54872. * add testing setup (peepeetee keymap, will use for personal purposes later), fix LED assignment, add indicator LED, LED location, count, and flags are broken * fixed flags( not sure, please check) * fixed number of LEDs * add comment about f11 * remove comment about f11, change capslock flag to be 1 rather than 1+8 as there is a standalone indicator LED * readme.md * add via keymap * add info.json with help from noroadsleft's converter * add suspended state implementation, I don't think it's working * update to my testing setup * restore erroneously included bm68rgb config * Update keyboards/kprepublic/bm80/config.h Co-authored-by: Drashna Jaelre * add reset instructions * change reset instruction grammar * remove not working sleep function, add comment for RGB flags * add LED mapping comments * change readme grammar * replace rgb light paremeters with rgb matrix paremeters, enable framebuffer effects * re-enable peepeetee/config.h, updating my disabled effect list * updating my disabled effect list * update LED struct documentation * update readme with RGB matrix effect information * Update keyboards/kprepublic/bm80/rules.mk Co-authored-by: Drashna Jaelre * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty * cleanup peepeetee keymap * update peepeetee keymap; rebase on current master * moved to /kprepublic, see #12159 * Apply suggestions from code review Co-authored-by: Drashna Jaelre * Apply suggestions from code review Co-authored-by: Ryan Co-authored-by: Drashna Jaelre Co-authored-by: ridingqwerty Co-authored-by: Ryan --- keyboards/kprepublic/bm80/readme.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 keyboards/kprepublic/bm80/readme.md (limited to 'keyboards/kprepublic/bm80/readme.md') diff --git a/keyboards/kprepublic/bm80/readme.md b/keyboards/kprepublic/bm80/readme.md new file mode 100644 index 0000000000..a0d8e8cf9a --- /dev/null +++ b/keyboards/kprepublic/bm80/readme.md @@ -0,0 +1,30 @@ +# bm80 + +![bm80](https://i.imgur.com/AqjEjOi.jpeg) + +A tkl, hotswap, in switch RGB keyboard from KPRepublic. + +* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee) +* Hardware Supported: BM80 +* Hardware Availability: [KP Republic](https://kprepublic.com/collections/new-arrival/products/bm80rgb-bm80-rgb-80-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 kprepublic/bm80:default + +Flashing example for this keyboard: + + make kprepublic/bm80:default:flash + +To reset the board into bootloader mode, do one of the following: + +* Short the two-pad footprint between the "delete" key and the "end" key while the board is plugged in +* Press the switch labled RST on the back of the PCB, near the MCU, while the board is plugged in +* Hold the Esc key while connecting the USB cable (also erases persistent settings) + +All of the RGB matrix effects are enabled by default. To disable specific ones, see [this section](https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects) for more information. + + +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). + + -- cgit v1.2.3