feat(shields): Add MechWild BB65 #1714

kylemccreery · 2023-03-17T20:05:36Z

Board/Shield Check-list

app/boards/shields/bb65/bb65.yml

caksoylar · 2023-03-17T20:42:16Z

app/boards/shields/bb65/boards/pillbug.conf

Is there a reason for these settings to be in the board-specific file (and always enabled unless disabled explicitly) rather than in bb65.conf? Also applies to #1713.

Yes. The logic here is that if you use an alternate board for this shield (such as the blackpill, which is supported) the pin defs wont be the same, so it will not have the pillbug.overlay file to reference and will throw errors without the feature being broken out.

I see, that makes sense. My only concern would be that it is undiscoverable for users if they want to disable it, since it doesn't appear in the files that get copied to the user config repo. If that is something you'd want, you could add a commented out CONFIG_ZMK_RGB_UNDERGLOW=n so at least it is more discoverable. (If you do that, you might also want to test the build to make sure it will actually override the setting if uncommented.)

(I'd also tend towards not enabling optional features by default but I guess that's a vendor/maintainer decision.)

I see the point you are making. I based this off a fairly old way of approaching this. I will make the changes to put the conf into the main file and not keep it restricted here. This will proc issues in the case where someone wants to build with a blackpill and tries to enable it, but I suppose I can just do the thing I wanted to avoid and define those boards as well.

Wanted to avoid because lazy and I don't have one built right now to use it so I can't test the light defs. I can do it later though and add to the PR.

I think it'd be good for more blackpill support in ZMK, but I don't necessarily want to force you one way or the other! If you just added a disabling config in bb65.conf that wouldn't necessitate adding support for other blackpills, unless the users changed the line to enable it =y, rather than just uncommenting.

Worth noting that we have the longstanding issue #885 related to board vs. shield-specific settings for underglow and it affects more common board/shield combinations (e.g. nice_nano_v2 and corne).

Oh the change to mapped pins would be perfect here too. I wanted to add the blackpill support for these boards when I did this PR, but got lazy since I can't find my screwdriver. Hell, they are the reason I added the blackpill defs to the repo in the first place.

… config

lesshonor · 2023-05-11T11:14:19Z

.github/workflows/build.yml

Accidental, but you'll want to revert this change.

lesshonor · 2023-05-11T11:15:19Z

app/boards/shields/bb65/Kconfig.defconfig

+if LVGL
+
+config LV_Z_VDB_SIZE
+    default 64
+
+config LV_DPI_DEF
+    default 148
+
+config LV_Z_BITS_PER_PIXEL
+    default 1
+
+choice LV_COLOR_DEPTH
+    default LV_COLOR_DEPTH_1
+endchoice
+
+endif # LVGL
+


Suggested change

if LVGL

config LV_Z_VDB_SIZE

default 64

config LV_DPI_DEF

default 148

config LV_Z_BITS_PER_PIXEL

default 1

choice LV_COLOR_DEPTH

default LV_COLOR_DEPTH_1

endchoice

endif # LVGL

Are these necessary on a board with no display?

lesshonor · 2023-05-11T14:04:34Z

app/boards/shields/bb65/boards/pillbug.overlay

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


This will need to be updated to use &pinctrl and &spi3 nodes like the other shields in the repo for RGB to work on pillbug. (As there is no worldsemi,ws2812-pwm implementation in Zephyr for blackpill_f4X1Xe, RGB seems to be a no-go on those boards at this point in time.)

Please verify that it works on your hardware.

Suggested change

&spi1 {

compatible = "nordic,nrf-spim";

status = "okay";

mosi-pin = <5>;

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

sck-pin = <27>;

miso-pin = <28>;

&pinctrl {

spi3_default: spi3_default {

group1 {

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

};

};

spi3_sleep: spi3_sleep {

group1 {

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

low-power-enable;

};

};

};

&spi3 {

compatible = "nordic,nrf-spim";

status = "okay";

pinctrl-0 = <&spi3_default>;

pinctrl-1 = <&spi3_sleep>;

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

lesshonor · 2023-10-17T18:14:50Z

app/boards/shields/bb65/bb65.keymap

+            bindings = <&bt BT_NXT>;
+        };
+    };
+


Suggested change

Spacing. Installing and running pre-commit can help catch this stuff.

lesshonor · 2023-10-17T18:15:15Z

app/boards/shields/bb65/bb65.keymap

+                &kp LCTRL &kp LGUI &kp LALT                         &kp SPACE                      &kp RALT &mo FN    &kp RCTRL &kp LEFT  &kp DOWN  &kp RIGHT
+            >;
+            sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
+        }; 


Suggested change

};

};

lesshonor · 2023-10-17T18:17:27Z

app/boards/shields/bb65/bb65.keymap

+                &trans        &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans       &trans &trans   &trans
+                &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans       &trans          &kp PG_UP &ext_power EP_TOG
+                &trans &trans &trans          &trans                           &trans &trans &trans              &kp HOME &kp PG_DN &kp END
+            >;  


Suggested change

>;

>;

lesshonor · 2023-10-17T18:17:38Z

app/boards/shields/bb65/bb65.keymap

+                &trans            &trans       &trans       &trans       &trans       &trans       &trans &trans &trans &trans &trans &trans &trans &trans
+                &trans     &trans &trans       &trans       &trans       &trans       &bootloader  &trans &trans &trans &trans &trans &trans        &trans &rgb_ug RGB_EFF
+                &trans     &out OUT_BLE        &out OUT_USB                           &trans                            &trans &trans &trans &trans &trans &trans
+            >;  


Suggested change

>;

>;

lesshonor · 2023-10-17T18:17:46Z

app/boards/shields/bb65/bb65.keymap

+                &none       &none &none &none &none &none &none &none &none &none &none &none &none &none
+                &none &none &none &none &none &none &none &none &none &none &none &none &none       &none &none
+                &none &none &none                   &none                   &none &none &none &none &none &none
+            >;  


Suggested change

>;

>;

lesshonor · 2023-10-17T18:18:16Z

app/boards/shields/bb65/bb65.overlay

+        label = "Encoder 1";
+        a-gpios = <&blackpill 12 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>;
+        b-gpios = <&blackpill 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>;
+        resolution = <4>;


Suggested change

resolution = <4>;

steps = <80>;

This change is part of the big encoder refactor circa June 2023.

lesshonor · 2023-11-14T02:38:19Z

app/boards/shields/bb65/bb65.keymap

+    sensors {
+        compatible = "zmk,keymap-sensors";
+        sensors = <&encoder_1>;
+    };


Suggested change

sensors {

compatible = "zmk,keymap-sensors";

sensors = <&encoder_1>;

};

See comment.

lesshonor · 2023-11-14T02:39:37Z

app/boards/shields/bb65/bb65.overlay

+        a-gpios = <&blackpill 12 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>;
+        b-gpios = <&blackpill 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>;
+        resolution = <4>;
+        status = "disabled";


Suggested change

status = "disabled";

status = "disabled";

};

sensors {

compatible = "zmk,keymap-sensors";

sensors = <&encoder_1>;

triggers-per-rotation = <20>;

};

The new attribute is also part of the encoder refactor.

Prepping for PR

da9bc67

caksoylar reviewed Mar 17, 2023

View reviewed changes

app/boards/shields/bb65/bb65.yml Outdated Show resolved Hide resolved

caksoylar reviewed Mar 17, 2023

View reviewed changes

kylemccreery added 4 commits March 17, 2023 17:43

Style formatting change on zmk.yml file extension

b2cd5b5

Defaulting to RGB off and keeping as much as I can in the main shield…

f75828b

… config

Added conf for blackpill to help with the matrix scanning

2e851fe

Added conf for blackpill to help with the matrix scanning

9943566

caksoylar approved these changes Mar 18, 2023

View reviewed changes

kylemccreery added 3 commits May 1, 2023 16:10

Merge branch 'main' of github.com:zmkfirmware/zmk into bb65

bf5e944

Updating to 3.2

bb7de7f

Fixed whitespace

bee5152

lesshonor suggested changes May 11, 2023

View reviewed changes

caksoylar added the shields PRs and issues related to shields label Jun 10, 2023

caksoylar mentioned this pull request Jun 10, 2023

feat(shields): Add MechWild OBE #1713

Open

11 tasks

lesshonor suggested changes Oct 17, 2023

View reviewed changes

lesshonor suggested changes Nov 14, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(shields): Add MechWild BB65 #1714

feat(shields): Add MechWild BB65 #1714

kylemccreery commented Mar 17, 2023

caksoylar Mar 17, 2023

kylemccreery Mar 17, 2023

caksoylar Mar 17, 2023

kylemccreery Mar 17, 2023

kylemccreery Mar 17, 2023

caksoylar Mar 17, 2023 •

edited

Loading

kylemccreery Mar 17, 2023

lesshonor May 11, 2023

lesshonor May 11, 2023

lesshonor May 11, 2023 •

edited

Loading

lesshonor Oct 17, 2023 •

edited

Loading

lesshonor Oct 17, 2023

lesshonor Oct 17, 2023

lesshonor Oct 17, 2023

lesshonor Oct 17, 2023

lesshonor Oct 17, 2023 •

edited

Loading

lesshonor Nov 14, 2023

lesshonor Nov 14, 2023

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

feat(shields): Add MechWild BB65 #1714

Are you sure you want to change the base?

feat(shields): Add MechWild BB65 #1714

Conversation

kylemccreery commented Mar 17, 2023

Board/Shield Check-list

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

caksoylar Mar 17, 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

lesshonor May 11, 2023 • edited Loading

Choose a reason for hiding this comment

lesshonor Oct 17, 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 Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caksoylar Mar 17, 2023 •

edited

Loading

lesshonor May 11, 2023 •

edited

Loading

lesshonor Oct 17, 2023 •

edited

Loading

lesshonor Oct 17, 2023 •

edited

Loading