Add Support for Keyhive Variant of Sofle RGB #1233

JWhitleyWork · 2022-04-08T19:09:19Z

Board/Shield Check-list

Tested and working (currently typing on it) on my Keyhive variant of the Sofle RGB. Much borrowed from the QMK implementation for this keyboard.

petejohanson · 2022-04-08T19:14:37Z

Tested and working (currently typing on it) on my Keyhive variant of the Sofle RGB. Much borrowed from the QMK implementation for this keyboard.

If you referenced the QMK code extensively to implement this, we can't really accept this PR, since the license is GPL there, and this is arguably a "derivative work" at that point.

petejohanson · 2022-04-08T19:15:06Z

See https://zmk.dev/docs/development/clean-room for more details.

JWhitleyWork · 2022-04-08T19:24:43Z

@petejohanson This may require some clarification. I specifically referenced only the file keyhive/qmk_firmware@a388b3e#diff-9134896d5f7bbd3575e3197e4752653dff4a420459009bca10ad94f09e909d57 which is part of a fork of QMK which was not contributed upstream, nor does it have the flowerbox at the top containing a reference to the GPL license. All other code in this PR was developed via examinig the board itself with a multimeter. If this is still an issue, I can contact the original developer and get written permission to re-license those few lines under MIT.

petejohanson · 2022-04-08T19:26:15Z

@petejohanson This may require some clarification. I specifically referenced only the file keyhive/qmk_firmware@a388b3e#diff-9134896d5f7bbd3575e3197e4752653dff4a420459009bca10ad94f09e909d57 which is part of a fork of QMK which was not contributed upstream, nor does it have the flowerbox at the top containing a reference to the GPL license. All other code in this PR was developed via examinig the board itself with a multimeter. If this is still an issue, I can contact the original developer and get written permission to re-license those few lines under MIT.

Thanks for the clarification! It would be good to contact the keyhive developer to double check, since there may still be an assumption about GPL there.

maximus5684 · 2022-04-14T02:55:07Z

@petejohanson I have received written confirmation from the original author to re-license the bit of code that I referenced under MIT. Please review and merge if satisfied.

JWhitleyWork · 2022-04-14T02:56:20Z

Sorry, wrong account. Same person, though. Please continue.

Nicell

Just want to confirm, this version of the sofle rgb is special to Keyhive? Could you mention how it's different from the normal sofle rgb?

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.conf

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.keymap

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive_left.conf

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive_right.conf

Nicell

Few more items, otherwise it looks good!

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.zmk.yml

researcherx00

works well apart from LEDs

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

JWhitleyWork · 2023-03-21T17:31:34Z

This has been hanging out for over 9 months. Can someone review and/or merge it?

caksoylar

Looks good to me. The comments I left are regarding copyright years that need updating and the deprecated Kconfig name replacement for central role.

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig

app/boards/shields/sofle_rgb_keyhive/Kconfig.shield

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.keymap

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive_left.overlay

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive_right.overlay

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.conf

Co-authored-by: Nick Winans <nick@winans.codes>

maximus5684 · 2023-10-20T04:37:56Z

All issues were addressed but it's been so long that the build process has changed. I would like to eventually get this merged but I'll work on fixing the build when I can.

lesshonor

The suggestions I'm proposing here should get the shield compiling again as of d7d9eed, assuming I haven't made any unfortunate typos.

lesshonor · 2023-11-16T19:42:26Z

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

+&spi1 {
+  compatible = "nordic,nrf-spim";
+  status = "okay";
+  mosi-pin = <6>;
+  // Unused pins, needed for SPI definition, but not used by the ws2812 driver itself.
+  sck-pin = <5>;
+  miso-pin = <7>;


Migration to the pinctrl subsystem as part of the Zephyr 3.2 upgrade, and the &spi3 bus per #1746.

Suggested change

&spi1 {

compatible = "nordic,nrf-spim";

status = "okay";

mosi-pin = <6>;

// Unused pins, needed for SPI definition, but not used by the ws2812 driver itself.

sck-pin = <5>;

miso-pin = <7>;

&pinctrl {

spi3_default: spi3_default {

group1 {

psels = <NRF_PSEL(SPIM_MOSI, 0, 6)>;

};

};

spi3_sleep: spi3_sleep {

group1 {

psels = <NRF_PSEL(SPIM_MOSI, 0, 6)>;

low-power-enable;

};

};

};

&spi3 {

compatible = "nordic,nrf-spim";

status = "okay";

pinctrl-0 = <&spi3_default>;

pinctrl-1 = <&spi3_sleep>;

pinctrl-names = "default", "sleep";

lesshonor · 2023-11-16T19:44:42Z

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

For consistency, indents on this file should probably be four spaces.

Please add a duplicate file named nice_nano.overlay, so just in case someone builds one of these with a nice!nano v1, the RGB will work just the same.

lesshonor · 2023-11-16T19:49:01Z

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

+        label = "LEFT_ENCODER";
+        a-gpios = <&pro_micro 21 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        b-gpios = <&pro_micro 20 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        resolution = <4>;


Suggested change

resolution = <4>;

steps = <80>;

The change from resolution to steps is part of the major encoder refactor that occurred in June 2023.

80 may not be the correct value for your encoder(s)—you will need to test and verify—but you will need to update your shield accordingly for a chance at acceptance.

lesshonor · 2023-11-16T19:49:09Z

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

+        label = "RIGHT_ENCODER";
+        a-gpios = <&pro_micro 20 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        b-gpios = <&pro_micro 21 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        resolution = <4>;


Suggested change

resolution = <4>;

steps = <80>;

lesshonor · 2023-11-16T19:51:43Z

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

+
+    sensors {
+        compatible = "zmk,keymap-sensors";
+        sensors = <&left_encoder &right_encoder>;


Suggested change

sensors = <&left_encoder &right_encoder>;

sensors = <&left_encoder &right_encoder>;

triggers-per-rotation = <20>;

See previous comment about the June 2023 encoder refactor.

lesshonor · 2023-11-16T20:00:41Z

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig

+config LVGL_VDB_SIZE
+    default 64
+
+config LVGL_DPI
+    default 148
+
+config LVGL_BITS_PER_PIXEL
+    default 1
+
+choice LVGL_COLOR_DEPTH
+    default LVGL_COLOR_DEPTH_1


Kconfig changes necessitated by the Zephyr 3.2 upgrade.

Suggested change

config LVGL_VDB_SIZE

default 64

config LVGL_DPI

default 148

config LVGL_BITS_PER_PIXEL

default 1

choice LVGL_COLOR_DEPTH

default LVGL_COLOR_DEPTH_1

config LV_Z_VDB_SIZE

default 64

config LV_Z_DPI

default 148

config LV_Z_BITS_PER_PIXEL

default 1

choice LV_COLOR_DEPTH

default LV_COLOR_DEPTH_1

lesshonor · 2023-11-16T20:02:04Z

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

+        label = "KSCAN";
+


Suggested change

label = "KSCAN";

This label has been deprecated.

lesshonor · 2023-11-16T20:02:25Z

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.dtsi

+    oled: ssd1306@3c {
+        compatible = "solomon,ssd1306fb";
+        reg = <0x3c>;
+        label = "DISPLAY";


Suggested change

label = "DISPLAY";

This label has been deprecated.

lesshonor · 2023-11-16T20:02:39Z

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

+
+  led_strip: ws2812@0 {
+    compatible = "worldsemi,ws2812-spi";
+    label = "WS2812";


Suggested change

label = "WS2812";

This label has been deprecated.

petejohanson requested a review from Nicell April 14, 2022 05:00

Nicell requested changes Apr 15, 2022

View reviewed changes

maximus5684 force-pushed the feature/sofle_rgb_keyhive branch from bd66d82 to b3fae85 Compare April 25, 2022 20:11

Nicell reviewed May 6, 2022

View reviewed changes

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig Outdated Show resolved Hide resolved

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay Outdated Show resolved Hide resolved

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.zmk.yml Outdated Show resolved Hide resolved

Nicell added enhancement New feature or request shields PRs and issues related to shields labels May 6, 2022

researcherx00 reviewed May 6, 2022

View reviewed changes

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay Outdated Show resolved Hide resolved

Nicell requested changes Jun 26, 2022

View reviewed changes

app/boards/shields/sofle_rgb_keyhive/Kconfig.defconfig Outdated Show resolved Hide resolved

app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay Outdated Show resolved Hide resolved

maximus5684 force-pushed the feature/sofle_rgb_keyhive branch from dd8b60c to 560e066 Compare June 29, 2022 18:30

Nicell self-requested a review June 29, 2022 20:14

maximus5684 force-pushed the feature/sofle_rgb_keyhive branch from 560e066 to 7425fa5 Compare March 21, 2023 17:32

caksoylar approved these changes Mar 28, 2023

View reviewed changes

caksoylar reviewed Mar 29, 2023

View reviewed changes

app/boards/shields/sofle_rgb_keyhive/sofle_rgb_keyhive.conf Outdated Show resolved Hide resolved

JWhitleyWork added 10 commits October 19, 2023 21:24

Adding new shield for Sofle RGB Keyhive.

aaed46b

Shorten BLE device name.

d035f09

Updating keymap based on research.

e96f256

Add RGB underglow.

1c5588d

Updating hardware metadata file.

cef6332

Fix keymap (again).

30bb6af

Fix RGB toggle binding.

0ae0fbb

Fix typo in defconfig.

13cc901

Enable RGB underglow at board level.

0f5ed55

Turn on RGB by default.

36b81eb

JWhitleyWork and others added 12 commits October 19, 2023 21:24

Fixed SPI issue.

4f0bc70

Fix left/right switch order.

a941564

Updates for new LED parameters.

ca8d931

Revert change to encoder resolution.

2e10592

Revert keymap changes.

083abe8

Remove empty files.

64ef35f

Remove unnecessary TODO line.

1c4319f

Update app/boards/shields/sofle_rgb_keyhive/boards/nice_nano_v2.overlay

793dbdf

Co-authored-by: Nick Winans <nick@winans.codes>

Update copyrights to be generic.

fa088ab

Removed backlight from feature listing.

f9f93d3

Changes from review.

0d6e271

Addressing feedback.

524aa6e

maximus5684 force-pushed the feature/sofle_rgb_keyhive branch from 88d0c74 to 524aa6e Compare October 20, 2023 04:24

Fix formatting.

9ea1687

maximus5684 force-pushed the feature/sofle_rgb_keyhive branch from dc6a427 to 9ea1687 Compare October 20, 2023 04:32

lesshonor suggested changes Nov 16, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for Keyhive Variant of Sofle RGB #1233

Add Support for Keyhive Variant of Sofle RGB #1233

JWhitleyWork commented Apr 8, 2022

petejohanson commented Apr 8, 2022

petejohanson commented Apr 8, 2022

JWhitleyWork commented Apr 8, 2022

petejohanson commented Apr 8, 2022

maximus5684 commented Apr 14, 2022

JWhitleyWork commented Apr 14, 2022

Nicell left a comment

Nicell left a comment

researcherx00 left a comment

JWhitleyWork commented Mar 21, 2023

caksoylar left a comment

maximus5684 commented Oct 20, 2023

lesshonor left a comment

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023 •

edited

Loading

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

lesshonor Nov 16, 2023

-&spi1 {
-  compatible = "nordic,nrf-spim";
-  status = "okay";
-  mosi-pin = <6>;
-  // Unused pins, needed for SPI definition, but not used by the ws2812 driver itself.
-  sck-pin = <5>;
-  miso-pin = <7>;
+&pinctrl {
+    spi3_default: spi3_default {
+        group1 {
+            psels = <NRF_PSEL(SPIM_MOSI, 0, 6)>;
+        };
+    };
+    spi3_sleep: spi3_sleep {
+        group1 {
+            psels = <NRF_PSEL(SPIM_MOSI, 0, 6)>;
+            low-power-enable;
+        };
+    };
+};
+&spi3 {
+    compatible = "nordic,nrf-spim";
+    status = "okay";
+    pinctrl-0 = <&spi3_default>;
+    pinctrl-1 = <&spi3_sleep>;
+    pinctrl-names = "default", "sleep";

	sensors = <&left_encoder &right_encoder>;
	sensors = <&left_encoder &right_encoder>;
	triggers-per-rotation = <20>;

Add Support for Keyhive Variant of Sofle RGB #1233

Are you sure you want to change the base?

Add Support for Keyhive Variant of Sofle RGB #1233

Conversation

JWhitleyWork commented Apr 8, 2022

Board/Shield Check-list

petejohanson commented Apr 8, 2022

petejohanson commented Apr 8, 2022

JWhitleyWork commented Apr 8, 2022

petejohanson commented Apr 8, 2022

maximus5684 commented Apr 14, 2022

JWhitleyWork commented Apr 14, 2022

Nicell left a comment

Choose a reason for hiding this comment

Nicell left a comment

Choose a reason for hiding this comment

researcherx00 left a comment

Choose a reason for hiding this comment

JWhitleyWork commented Mar 21, 2023

caksoylar left a comment

Choose a reason for hiding this comment

maximus5684 commented Oct 20, 2023

lesshonor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lesshonor Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lesshonor Nov 16, 2023 •

edited

Loading