keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
a84528f853
qmk-keychron-q3-colemak-dh/keyboards/kprepublic/bm80hsrgb/readme.md

31 lines
1.4 KiB
Markdown
Raw Normal View History

rename kprepublic bm keyboards to have a standardized naming format (#15047) * change missed kprepublic readmes * fix xiudi readmes * initial change, see pr description * change readmes * changes names in readmes and device descriptors
2021-11-17 22:37:23 +01:00
# BM80HSRGB
[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 <drashna@live.com> * 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 <drashna@live.com> * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * 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 <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-28 07:00:47 +02:00
rename kprepublic bm keyboards to have a standardized naming format (#15047) * change missed kprepublic readmes * fix xiudi readmes * initial change, see pr description * change readmes * changes names in readmes and device descriptors
2021-11-17 22:37:23 +01:00
![BM80HSRGB](https://i.imgur.com/AqjEjOi.jpeg)
[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 <drashna@live.com> * 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 <drashna@live.com> * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * 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 <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-28 07:00:47 +02:00
A tkl, hotswap, in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee)
rename kprepublic bm keyboards to have a standardized naming format (#15047) * change missed kprepublic readmes * fix xiudi readmes * initial change, see pr description * change readmes * changes names in readmes and device descriptors
2021-11-17 22:37:23 +01:00
* Hardware Supported: BM80HSRGB
[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 <drashna@live.com> * 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 <drashna@live.com> * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * 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 <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-28 07:00:47 +02:00
* 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):
rename kprepublic bm keyboards to have a standardized naming format (#15047) * change missed kprepublic readmes * fix xiudi readmes * initial change, see pr description * change readmes * changes names in readmes and device descriptors
2021-11-17 22:37:23 +01:00
make kprepublic/bm80hsrgb:default
[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 <drashna@live.com> * 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 <drashna@live.com> * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * 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 <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-28 07:00:47 +02:00
Flashing example for this keyboard:
rename kprepublic bm keyboards to have a standardized naming format (#15047) * change missed kprepublic readmes * fix xiudi readmes * initial change, see pr description * change readmes * changes names in readmes and device descriptors
2021-11-17 22:37:23 +01:00
make kprepublic/bm80hsrgb:default:flash
[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 <drashna@live.com> * 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 <drashna@live.com> * move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159 * Apply suggestions from code review Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * 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 <drashna@live.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-28 07:00:47 +02:00
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).
Reference in New Issue Copy Permalink