Update info related to the issue with n!n 2 and underglow #1461
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
admilsonmarques
approved these changes
Dec 10, 2022
lesshonor
suggested changes
Nov 14, 2023
| @@ -105,6 +105,17 @@ If your board/shield uses LEDs that require the data sent in a different order, | |||
|
|
|||
| ::: | |||
|
|
|||
| :::note | |||
|
|
|||
| Currently, If you are using a nice nano 2, underglow won't work out of the box. | |||
There was a problem hiding this comment.
- This is a bit too much of a blanket statement. Even when this PR was opened, some shields did have
.overlayfiles fornice_nano_v2... - While the discussion of moving to Zephyr's board versioning system is moot
(related: Strip board revision so keymap file use only board name #1015, Underglow overlays for nice_nano don't work on nice_nano_v2 #885 (comment))
..."duplicate"nice_nano*.overlayfiles were added to in-tree shields in Zephyr 3.2 Upgrade #1499. Fortunately or unfortunately, that retroactively invalidates all the cases in which this statement was true.
| To make this work you need to add an overlay in your `.keymap` file like this: | ||
|
|
||
| ``` | ||
| #include <../boards/shields/<board>/boards/nice_nano.overlay> |
There was a problem hiding this comment.
This proposed workaround is fragile (what if nice_nano.overlay doesn't exist?) and, well...doesn't quite seem congruent with ZMK's overall style.
Bodging things into a personal keymap is one thing, but I am doubtful that ZMK as a project wants to sanction approaches of this nature by adding them to the official documentation.
|
Thanks @lesshonor, I believe Zephyr 3.2 update added all the v2 overlays for shields that already had the v1 ones, so we can close this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#885
I think it is important to add this info related to the issue with nice nano 2 and the underglow to avoid confusion.