Skip to content

Commit

Permalink
Merge remote-tracking branch 'qmk/develop' into develop
Browse files Browse the repository at this point in the history
* qmk/develop:
  [Docs] Add examples to RGB Matrix Indicators docs (qmk#12797)
  Add support for lazydesigners/cassette8 (qmk#14145)
  New Keyboard - V4n4g0rth0n (qmk#14152)
  Update readme files (qmk#14172)
  Move to correct location (qmk#14171)
  Skeletn87 - Fix RGB pin (qmk#14170)
  • Loading branch information
Carlos Cardoso committed Aug 28, 2021
2 parents 1065904 + 29ec2d8 commit 2fed089
Show file tree
Hide file tree
Showing 51 changed files with 769 additions and 80 deletions.
39 changes: 39 additions & 0 deletions docs/feature_rgb_matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -741,3 +741,42 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
}
}
```
#### Examples :id=indicator-examples
This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).
```c
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
HSV hsv = {0, 255, 255};
if (layer_state_is(layer_state, 2)) {
hsv = {130, 255, 255};
} else {
hsv = {30, 255, 255};
}
if (hsv.v > rgb_matrix_get_val()) {
hsv.v = rgb_matrix_get_val();
}
RGB rgb = hsv_to_rgb(hsv);
for (uint8_t i = led_min; i <= led_max; i++) {
if (HAS_FLAGS(g_led_config.flags[i], 0x01)) { // 0x01 == LED_FLAG_MODIFIER
rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
}
}
}
```

If you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key:

```c
void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
if (host_keyboard_led_state().caps_lock) {
RGB_MATRIX_INDICATOR_SET_COLOR(5, 255, 255, 255); // assuming caps lock is at led #5
} else {
RGB_MATRIX_INDICATOR_SET_COLOR(5, 0, 0, 0);
}
}
```
8 changes: 4 additions & 4 deletions keyboards/kprepublic/bm16a/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

A 16 key macropad, with USB C, RGB underglow and backlight.

Keyboard Maintainer: QMK Community
Hardware Supported: The PCBs, controllers supported
Hardware Availability: [KPrepublic](https://kprepublic.com/products/bm16a-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx); [AliExpress](https://www.aliexpress.com/store/product/bm16a-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom/3034003_32970629907.html)
* Keyboard Maintainer: QMK Community
* Hardware Supported: The PCBs, controllers supported
* Hardware Availability: [KPrepublic](https://kprepublic.com/products/bm16a-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx); [AliExpress](https://www.aliexpress.com/store/product/bm16a-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom/3034003_32970629907.html)

Make example for this keyboard (after setting up your build environment):

make bm16a:default
make kprepublic/bm16a:default

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).
8 changes: 4 additions & 4 deletions keyboards/kprepublic/bm16s/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

A 16-key macropad, with USB C and per-key RGB backlighting. This is a variant of the BM16A, but with low profile Choc switches.

Keyboard Maintainer: QMK Community
Hardware Supported: The PCBs, controllers supported
Hardware Availability: [KPrepublic](https://kprepublic.com/collections/pcb/products/bm16s-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch-leds-choc-switch); [AliExpress](https://www.aliexpress.com/item/bm16s-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch/32999247908.html); [Massdrop](https://www.massdrop.com/buy/78169)
* Keyboard Maintainer: QMK Community
* Hardware Supported: The PCBs, controllers supported
* Hardware Availability: [KPrepublic](https://kprepublic.com/collections/pcb/products/bm16s-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch-leds-choc-switch); [AliExpress](https://www.aliexpress.com/item/bm16s-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch/32999247908.html); [Massdrop](https://www.massdrop.com/buy/78169)

Make example for this keyboard (after setting up your build environment):

make bm16s:default
make kprepublic/bm16s:default

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).
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm40hsrgb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ This firmware was originally taken from a kbfirmware.json and manually converted

Make example for this keyboard (after setting up your build environment):

make bm40hsrgb:default
make kprepublic/bm40hsrgb:default

Flashing example for this keyboard:

make bm40hsrgb:default:flash
make kprepublic/bm40hsrgb: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).
9 changes: 4 additions & 5 deletions keyboards/kprepublic/bm43a/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ A 40% mechanical keyboard.

This firmware was originally taken from a kbfirmware.json and converted through [kbf_qmk_converter](https://noroadsleft.github.io/kbf_qmk_converter/). You may find the original `.json` files [here](https://drive.google.com/drive/folders/11DowBYrFN_uCNa9Q9bXwuMn91vmZYBcG).


Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
Hardware Supported: bm43a PCB
Hardware Availability: [KPRepublic](https://kprepublic.com/products/bm43a-bm43-43-keys-40-custom-mechanical-keyboard-pcb-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx)
* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
* Hardware Supported: bm43a PCB
* Hardware Availability: [KPRepublic](https://kprepublic.com/products/bm43a-bm43-43-keys-40-custom-mechanical-keyboard-pcb-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx)

Make example for this keyboard (after setting up your build environment):

make bm43a:default
make kprepublic/bm43a:default

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).
4 changes: 1 addition & 3 deletions keyboards/kprepublic/bm60poker/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ A 60% hotswap inswitch RGB (north facing) keyboard from KP Republic.

Make example for this keyboard (after setting up your build environment):

make bm60poker:default
make kprepublic/bm60poker:default

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).

Video tutorials for customizing the layout: [QMK Tutorials](https://www.youtube.com/playlist?list=PLZlceRZZjRugJFL-vnenYnDrbMc6wu_e_) - By MechMerlin
2 changes: 1 addition & 1 deletion keyboards/kprepublic/bm60rgb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ A 60% hotswap inswitch RGB keyboard from KP Republic.

Make example for this keyboard (after setting up your build environment):

make bm60rgb:default
make kprepublic/bm60rgb:default

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).
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm60rgb_iso/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ A 60% ISO hotswap inswitch RGB keyboard.

Make example for this keyboard (after setting up your build environment):

make bm60rgb_iso:default
make kprepublic/bm60rgb_iso:default

Flashing example for this keyboard:

make bm60rgb_iso:default:flash
make kprepublic/bm60rgb_iso: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).
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm65iso/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A 65% hotswap in switch RGB keyboard from KPRepublic.

Make example for this keyboard (after setting up your build environment):

make bm65iso:default
make kprepublic/bm65iso:default

Flashing example for this keyboard:

make bm65iso:default:flash
make kprepublic/bm65iso:default:flash

To reset the board into bootloader mode, do one of the following:

Expand Down
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm68rgb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A 65% hotswap in switch RGB keyboard from KPRepublic.

Make example for this keyboard (after setting up your build environment):

make bm68rgb:default
make kprepublic/bm68rgb:default

Flashing example for this keyboard:

make bm68rgb:default:flash
make kprepublic/bm68rgb:default:flash

To reset the board into bootloader mode, do one of the following:

Expand Down
2 changes: 1 addition & 1 deletion keyboards/kprepublic/cospad/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Supported Layouts:

Make example for this keyboard (after setting up your build environment):

make cospad:default
make kprepublic/cospad:default

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).
4 changes: 2 additions & 2 deletions keyboards/kprepublic/jj40/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress.

Make example for this keyboard (after setting up your build environment):

make jj40:default
make kprepublic/jj40:default

Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

make jj40:default:flash
make kprepublic/jj40:default:flash

**Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard.

Expand Down
4 changes: 2 additions & 2 deletions keyboards/kprepublic/jj4x4/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off versio

Make example for this keyboard (after setting up your build environment):

make jj4x4:default
make kprepublic/jj4x4:default

Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

make jj4x4:default:flash
make kprepublic/jj4x4:default:flash

**Reset Key**:

Expand Down
4 changes: 2 additions & 2 deletions keyboards/kprepublic/jj50/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ A compact 50% (5x12) ortholinear keyboard made and sold by KPrepublic.

Make example for this keyboard (after setting up your build environment):

make jj50:default
make kprepublic/jj50:default

Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

make jj50:default:flash
make kprepublic/jj50:default:flash

**Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard.

Expand Down
2 changes: 1 addition & 1 deletion keyboards/ktec/daisy/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ A 40% keyboard kit sold by KPrepublic.

Make example for this keyboard (after setting up your build environment):

make daisy:default
make ktec/daisy:default

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).
15 changes: 5 additions & 10 deletions keyboards/ktec/ergodone/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
ErgoDone
========
# ErgoDone

![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)

Expand All @@ -12,17 +11,13 @@ The ErgoDone is a modified version of the ErgoDox, made by K.T.E.C., with pre-so
- [AliExpress](https://www.aliexpress.com/store/product/ergodone-Custom-Mechanical-Keyboard-TKG-TOOLS-PCB-programmed-Ergonomic-Keyboard-Kit-similar-with-infinity-ergodox/3034003_32830050940.html)
- [KBDfans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping)

# Building the firmware
Make example for this keyboard (after setting up your build environment):

[Install the build tools.](https://docs.qmk.fm/#/getting_started_build_tools)
make ktec/ergodone:default

In the root directory of the repository, build the firmware with a command like:
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).

make ergodone:default

For more information on the layout option and other ones, see the [`make` guide](https://docs.qmk.fm/#/getting_started_make_guide).

# Flashing the firmware onto the keyboard
## Flashing the firmware onto the keyboard

The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doesn't need an OS driver, and the required actions before flashing are a little different than with an ErgoDox.

Expand Down
8 changes: 4 additions & 4 deletions keyboards/ktec/staryu/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

A 5 key macropad, designed by Kai and sold by KPRepublic.

Keyboard Maintainer: QMK Community
Hardware Supported: Staryu (only the non-lite version has been tested)
Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-Macro-Pad-custom-keyboard-by-tkg-kai-Mini-macro-pad-mechanical-keyboard-5-keys/32817560746.html)
* Keyboard Maintainer: QMK Community
* Hardware Supported: Staryu (only the non-lite version has been tested)
* Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-Macro-Pad-custom-keyboard-by-tkg-kai-Mini-macro-pad-mechanical-keyboard-5-keys/32817560746.html)

Make example for this keyboard (after setting up your build environment):

make staryu:default
make ktec/staryu:default

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
17 changes: 17 additions & 0 deletions keyboards/lazydesigners/cassette8/cassette8.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/* Copyright 2021 LAZYDESIGNERS
*
* 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 "cassette8.h"
28 changes: 28 additions & 0 deletions keyboards/lazydesigners/cassette8/cassette8.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* Copyright 2021 LAZYDESIGNERS
*
* 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( \
K00, K01, K02, K03, \
K10, K11, K12, K13 \
) { \
{ K00, K01, K02, K03, }, \
{ K10, K11, K12, K13 }, \
}
58 changes: 58 additions & 0 deletions keyboards/lazydesigners/cassette8/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* Copyright 2021 LAZYDESIGNERS
*
* 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 0x4C44 // "LD"
#define PRODUCT_ID 0x0008
#define DEVICE_VER 0x0001
#define MANUFACTURER LAZYDESIGNERS
#define PRODUCT Cassette8

/* key matrix size */
#define MATRIX_ROWS 2
#define MATRIX_COLS 4

/* key matrix pins */
#define MATRIX_ROW_PINS { B3, B2 }
#define MATRIX_COL_PINS { B5, B4, B1, B0 }

/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW

/* RBG underglow */
#define RGB_DI_PIN C2
#ifdef RGB_DI_PIN
#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
#define RGBLIGHT_EFFECT_TWINKLE
#define RGBLIGHT_SLEEP
#define RGBLED_NUM 15
/* #define RGBLIGHT_HUE_STEP 8 */
/* #define RGBLIGHT_SAT_STEP 8 */
/* #define RGBLIGHT_VAL_STEP 8 */
#endif

21 changes: 21 additions & 0 deletions keyboards/lazydesigners/cassette8/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"keyboard_name": "Cassette8",
"url": "http://lazydesigners.cn",
"maintainer": "Jacky@LAZYDESIGNERS",
"width": 4,
"height": 2,
"layouts": {
"LAYOUT": {
"layout": [
{"label":"1", "x":0, "y":0},
{"label":"2", "x":1, "y":0},
{"label":"3", "x":2, "y":0},
{"label":"4", "x":3, "y":0},
{"label":"5", "x":0, "y":1},
{"label":"6", "x":1, "y":1},
{"label":"7", "x":2, "y":1},
{"label":"8", "x":3, "y":1}
]
}
}
}
Loading

0 comments on commit 2fed089

Please sign in to comment.