RGB Matrix Lighting implementation for Novelkeys NK87 #19422

makirill · 2022-12-24T16:20:13Z

Description

This PR adds RGB Matrix Lighting effects for Novelkeys NK87 keyboard.

Summary:

RGB_MATRIX_ENABLE is enabled by default and used by the default and via keymap
RGB Matrix Lighting can be completely disabled at keymap level by setting RGB_MATRIX_ENABLE = no at the rules.mk file
The default keymap has new key codes at FN layer to change RGB Matrix Lightning settings
Tests was done to make sure all RGB Matrix Lightning effects are working as expected, including heatmap and reactive effects where configuration of the LEDs physical positions is important.
Tests was done for via keymap to make sure that everything is working VIA configurator including lightning effects

Tagging @yiancar as the original creator of the NK87 keyboard.

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

The RGB Matrix Lighting can't be configured with VIA, so VIA keymap has RGB Matrix Lighting disabled and uses RGB Backlight. Default keymap has RGB Matrix Lighting enabled.

The g_led_config should have correct map of led's physical position in so effects like heat map will work properly. The backspace led position in matrix on the right from enter key (like in iso) but physically on the top from enter (like ansi).

keyboards/novelkeys/nk87/config_led.c

keyboards/novelkeys/nk87/config_led.h

keyboards/novelkeys/nk87/config.h

keyboards/novelkeys/nk87/keymaps/default/readme.md

keyboards/novelkeys/nk87/keymaps/via/keymap.c

keyboards/novelkeys/nk87/rules.mk

Code from the config_led.* files should be moved to nk87.c or config.h files.

Minor update to make layer_state_set_user function more readable

keyboards/novelkeys/nk87/nk87.c

Switching to the rgb_matrix_indicators_kb() since no parameters of the rgb_matrix_indicators_advanced_kb() are not used.

keyboards/novelkeys/nk87/keymaps/default/config.h

keyboards/novelkeys/nk87/keymaps/via/config.h

Making preprocessor directives indentation style compliant with the qmk coding conventions.

keyboards/novelkeys/nk87/nk87.h

keyboards/novelkeys/nk87/info.json

keyboards/novelkeys/nk87/rules.mk

keyboards/novelkeys/nk87/keymaps/via/rules.mk

keyboards/novelkeys/nk87/keymaps/via/keymap.c

keyboards/novelkeys/nk87/keymaps/default/keymap.c

keyboards/novelkeys/nk87/keymaps/via/rules.mk

The SRC build option from the via keymap to keyboard level post_rules.mk file to avoid potential duplication.

keyboards/novelkeys/nk87/keymaps/via/rules.mk

keyboards/novelkeys/nk87/post_rules.mk

github-actions · 2023-02-18T02:03:11Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

keyboards/novelkeys/nk87/keymaps/via/rules.mk

Co-authored-by: Ryan <[email protected]>

github-actions · 2023-04-06T01:54:26Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

drashna · 2023-04-12T15:39:19Z

keyboards/novelkeys/nk87/post_rules.mk

+ifeq ($(strip $(RGB_BACKLIGHT)),yes)
+
+# Disable RGB Matrix
+RGB_MATRIX_ENABLE = no


Honestly, I'd opt for this:

Suggested change

RGB_MATRIX_ENABLE = no

RGB_MATRIX_SUPPORTED = no

This actually disables the feature, even when enabling the feature from command line. It prevents it from being used at all. Which is more appropriate for what this is trying to do.

@drashna, I don't follow it. Is it about to introduce introduce different detective (RGB_MATRIX_SUPPORTED) that will control what RGB should be used (RGB_MATRIX or RGB_BACKLIGHT)?

I am thinking to implement something like:

ifeq ($(filter $(strip $(RGBLED_OPTION_TYPE))x, nonex backlightx matrixx x),) $(error unknown RGBLED_OPTION_TYPE value "$(RGBLED_OPTION_TYPE)") endif ifeq ($(strip $(RGBLED_OPTION_TYPE)),backlight) RGB_MATRIX_ENABLE = no RGB_BACKLIGHT = yes ....... endif ifeq ($(strip $(RGBLED_OPTION_TYPE)),matrix) RGB_BACKLIGHT = no RGB_MATRIX_ENABLE = yes RGB_MATRIX_DRIVER = IS31FL3733 .......... endif

So, both RGB options can be supported and configured at keymap level by setting the RGBLED_OPTION_TYPE.

RGB_MATRIX_SUPPORTED = no

This actually won't work, because disable_features.mk is included before any of the post_rules.mk files.

sigprof · 2023-04-22T17:36:43Z

keyboards/novelkeys/nk87/keymaps/default/readme.md


 Default layer is normal ANSI TKL
+
+This keymap uses  [RGB Matrix Lighting](https://docs.qmk.fm/#/feature_rgb_matrix)
+by default. VIA is not supporting configuration of RGB Matrix Lighting effects but there are still options to do the effects configurations:


This statement is obsolete — VIA V3 (#18222) has support for RGB Matrix configuration (the builtin support is limited to setting mode/HSV/speed though, and you may need to customize the list of effects in the VIA JSON if you are not enabling all existing effects in the firmware for some reason).

makirill · 2023-04-23T21:59:43Z

Looks like it's too complicated to have two different variants for RGB lighting (RGB Matrix for the default keymap and RGB Backlight for via), code become too messy and complex.

So, I think it will be better to unify everything and use RGB Matrix everywhere, which was implemented with commit f4c561c. I've tested VIA using Design Tab and novelkeys_nk87.json file.

PR description was updated as well.

github-actions · 2023-06-14T02:02:08Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

github-actions · 2023-07-14T02:10:50Z

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.
// [stale-action-closed]

makirill added 6 commits December 22, 2022 08:34

Adding RGB Matrix Lighting effects to the nk87

ef424cb

The RGB Matrix Lighting can't be configured with VIA, so VIA keymap has RGB Matrix Lighting disabled and uses RGB Backlight. Default keymap has RGB Matrix Lighting enabled.

Minor updates

38835f6

Documentation updates

7e41e4d

Minor updates

722c2fa

Fixing "backspace" key physical position

12b4c4e

The g_led_config should have correct map of led's physical position in so effects like heat map will work properly. The backspace led position in matrix on the right from enter key (like in iso) but physically on the top from enter (like ansi).

Updating leds physical position map

5bcb7aa

github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Dec 24, 2022

waffle87 requested changes Dec 24, 2022

View reviewed changes

makirill added 3 commits December 24, 2022 14:34

Removing config_led.* and indicator.h files

db9256d

Code from the config_led.* files should be moved to nk87.c or config.h files.

Updating URL at the keymaps/default/readme.md file

ae6c18a

Minor update for layer_state_set_user functions

eab35ec

Minor update to make layer_state_set_user function more readable

filterpaper reviewed Dec 26, 2022

View reviewed changes

keyboards/novelkeys/nk87/nk87.c Outdated Show resolved Hide resolved

Switching to use the rgb_matrix_indicators_kb() function

54ba42e

Switching to the rgb_matrix_indicators_kb() since no parameters of the rgb_matrix_indicators_advanced_kb() are not used.

drashna reviewed Jan 1, 2023

View reviewed changes

keyboards/novelkeys/nk87/keymaps/default/config.h Outdated Show resolved Hide resolved

drashna reviewed Jan 1, 2023

View reviewed changes

keyboards/novelkeys/nk87/keymaps/via/config.h Outdated Show resolved Hide resolved

Fixing coding style

01c9742

Making preprocessor directives indentation style compliant with the qmk coding conventions.

drashna approved these changes Jan 1, 2023

View reviewed changes

drashna requested a review from a team January 1, 2023 21:48

zvecr requested changes Jan 2, 2023

View reviewed changes

makirill added 2 commits January 2, 2023 14:59

Minor updates based on code review

d26bbaf

Updating VIA keymap rules.mk

a33f344

The SRC build option from the via keymap to keyboard level post_rules.mk file to avoid potential duplication.

zvecr reviewed Jan 2, 2023

View reviewed changes

keyboards/novelkeys/nk87/keymaps/via/rules.mk Outdated Show resolved Hide resolved

keyboards/novelkeys/nk87/post_rules.mk Outdated Show resolved Hide resolved

Moving the CIE1931_CUURVE variable to post_rules.mk

10a581a

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Feb 18, 2023

fauxpark requested changes Feb 18, 2023

View reviewed changes

keyboards/novelkeys/nk87/keymaps/via/rules.mk Outdated Show resolved Hide resolved

github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Feb 19, 2023

Update keyboards/novelkeys/nk87/keymaps/via/rules.mk

a9848c1

Co-authored-by: Ryan <[email protected]>

makirill requested review from zvecr, fauxpark and waffle87 and removed request for zvecr, fauxpark and waffle87 February 19, 2023 20:54

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Apr 6, 2023

drashna reviewed Apr 12, 2023

View reviewed changes

drashna self-assigned this Apr 12, 2023

github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Apr 13, 2023

sigprof reviewed Apr 22, 2023

View reviewed changes

makirill added 2 commits April 23, 2023 17:19

Merge branch 'master' into feature/nk87-rgb-matrix

ed3a32f

Adding RGB Matrix Lighting to VIA keymap

f4c561c

makirill requested a review from drashna April 29, 2023 18:40

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Jun 14, 2023

github-actions bot closed this Jul 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RGB Matrix Lighting implementation for Novelkeys NK87 #19422

RGB Matrix Lighting implementation for Novelkeys NK87 #19422

makirill commented Dec 24, 2022 •

edited

Loading

github-actions bot commented Feb 18, 2023

github-actions bot commented Apr 6, 2023

drashna Apr 12, 2023

makirill Apr 22, 2023

sigprof Apr 22, 2023

sigprof Apr 22, 2023

makirill commented Apr 23, 2023

github-actions bot commented Jun 14, 2023

github-actions bot commented Jul 14, 2023

RGB Matrix Lighting implementation for Novelkeys NK87 #19422

RGB Matrix Lighting implementation for Novelkeys NK87 #19422

Conversation

makirill commented Dec 24, 2022 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

github-actions bot commented Feb 18, 2023

github-actions bot commented Apr 6, 2023

drashna Apr 12, 2023

Choose a reason for hiding this comment

makirill Apr 22, 2023

Choose a reason for hiding this comment

sigprof Apr 22, 2023

Choose a reason for hiding this comment

sigprof Apr 22, 2023

Choose a reason for hiding this comment

makirill commented Apr 23, 2023

github-actions bot commented Jun 14, 2023

github-actions bot commented Jul 14, 2023

makirill commented Dec 24, 2022 •

edited

Loading