Add support for Nucleo WB55CG board & Zephirum shield #938

cdc-mkb · 2021-09-12T13:53:49Z

Hello ZMK maintainers!

Could you please merge these two commits? See committed README.md files or http://zephirum.tuxfamily.org/ for details.

Support for Nucleo WB55CG board is based on the initial work made by Pete Johanson; I updated it for Zephyr OS v2.5.

Thanks in advance,
Cedric.

petejohanson · 2021-09-30T03:49:56Z

Thank you, contributor, for your patience with how long review and merge of boards/shields has taken!

There are three recent refactors/changes to boards and shields that require some attention, and then we can finally get this PR merged!

Hardware Metadata
Pro Micro shield DT naming changes
Split changes for BLE advertising

Hardware Metadata

The Problem

When first developing the process around contributing new shields/boards to ZMK, we failed to recognize that several key files (setup scripts, documentation page of supported hardware, and GH Action build.yml file) required changes, often in the same spot, for every PR. This resulted in immediate merge conflicts for every other PR after one was merged, which is a headache for contributors.

The Fix

By adding discrete metadata files that are located with the boards/shields in question, and using that metadata to generate setup scripts, website hardware list, etc., users can contributing new hardware descriptions without the need to change the same files that other contributors are changing.

Next Steps

First, refer to https://zmk.dev/docs/development/hardware-metadata-files to familiarize yourself with the new metadata file format.

Next, you have two options for fixing up your PR:

If comfortable with git rebase, perform an interactive rebase and revert any changes to build.yml, hardware.md, or the setup scripts setup.sh/setup.ps1, and then add the new metadata YAML file. Then force push your branch. Or,
Create a new branch from an up-to-date main, copy in the files for your new hardware, add the metadata file, then commit and push the new branch. Then, edit your open PR to point to your new branch.

Pro Micro shield DT naming changes

In #876, we have simplified the DT naming for the "nexus node" we expose for pro-micro compatible boards, deprecating the use of pro_micro_a, and renaming pro_micro_d node to simply pro_micro. For pro-micro boards and shields, you'll need to adjust your DT to use the proper names.

Please see https://zmk.dev/docs/development/new-shield#shield-overlays for the updated docs on this.

Split Shield Advertising Changes

In addition, if this is a split PR, please see #658 where we have changed our conventions to remove the the name from the right sides, to prevent users attempting to pair with them and causing split sync issues. This also includes removing the " Left" suffix from the naming on the left side. See the changes in that PR for examples of what to change with your split shield.

Getting Help

If you have any questions about any of these changes, please comment here and tag @zmkfirmware/boards-shields or ask in the #boards-shields Discord channel.

cdc-mkb · 2021-10-05T06:36:00Z

This pull request has been updated.

Board/Shield Check-list

This board/shield is tested working on real hardware
Definitions follow the general style of other shields/boards upstream (Reference)
.zmk.yml metadata file added
Proper Copyright + License headers added to applicable files
General consistent formatting of DeviceTree files
Keymaps do not use deprecated key defines (Check using the upgrader tool)
&pro_micro used in favor of &pro_micro_d/a if applicable (not applicable)
If split, no name added for the right/peripheral half (not applicable)
.conf file has optional extra features commented out

cdc-mkb · 2021-10-23T14:14:03Z

Rebased onto github.com/zmkfirmware/zmk.git:main + Stick to "The ZMK Contributors" for copyrights.

cdc-mkb · 2021-11-21T10:17:37Z

Rebased onto github.com/zmkfirmware/zmk.git:main

lesshonor

Good luck with updating this for a more recent version of ZMK+Zephyr. You'll also want to substitute the tabs with four spaces. Installing and running pre-commit should handle this and any other reformatting.
...A minor note, but your website also appears to be down. Maybe you want to update the URLs listed here.

lesshonor · 2023-10-17T19:33:38Z

app/boards/arm/nucleo_wb55cg_dongle/README.md

I don't think it's appropriate to put shield-specific information in this readme when the board could be used by other shields.

Most "generic" boards don't have READMEs, so you could probably just omit this.

lesshonor · 2023-10-18T01:06:03Z

app/boards/arm/nucleo_wb55cg_dongle/nucleo_wb55cg_dongle_defconfig

Per the Zephyr 3.0.0 changelog:

STM32 clock_control driver configuration was moved from Kconfig to devicetree. See the st,stm32-rcc devicetree binding for more information. As a consequence, [the] following Kconfig symbols were removed:

CONFIG_CLOCK_STM32_SYSCLK_SRC_HSE

CONFIG_CLOCK_STM32_APB1_PRESCALER

CONFIG_CLOCK_STM32_APB2_PRESCALER

CONFIG_CLOCK_STM32_CPU1_PRESCALER

CONFIG_CLOCK_STM32_CPU2_PRESCALER

CONFIG_CLOCK_STM32_AHB4_PRESCALER

lesshonor · 2023-10-18T01:06:59Z

app/boards/arm/nucleo_wb55cg_dongle/Kconfig.defconfig

+config BOARD
+	default "nucleo_wb55cg_dongle"
+
+config CLOCK_STM32_LSE


This one was nixed in Zephyr 3.0.0 too.

lesshonor · 2023-10-18T01:08:20Z

app/boards/arm/nucleo_wb55cg_dongle/nucleo_wb55cg_dongle.dts

+&i2c1 {
+	status = "okay";
+	clock-frequency = <I2C_BITRATE_FAST>;
+	pinctrl-0 = <&i2c1_scl_pb8 &i2c1_sda_pb9>;


Suggested change

pinctrl-0 = <&i2c1_scl_pb8 &i2c1_sda_pb9>;

pinctrl-0 = <&i2c1_scl_pb8 &i2c1_sda_pb9>;

pinctrl-names = "default";

pinctrl-names is now a required property. As above, this suggestion is applicable to a number of nodes.

...In truth, a chunk of this configuration should probably be pulled out into app/boards/arm/nucleo_wb55cg_dongle/nucleo_wb55cg_dongle.dtsi and #included in this file—in order to leverage the pinctrl system introduced with Zephyr 3.2.

lesshonor · 2023-10-18T01:16:23Z

app/boards/arm/nucleo_wb55cg_dongle/nucleo_wb55cg_dongle.dts

+};
+
+&i2c1 {
+	status = "okay";


Suggested change

status = "okay";

Per a suggestion made on another board:

For ZMK boards, dodn't enable the UART, SPI, etc by default. This is a bit different from the upstream Zephyr board approach.

I'm only going to make the suggestion in one place, but this applies to a number of nodes.

lesshonor · 2023-10-18T01:36:44Z

app/boards/shields/zephirum/Kconfig.defconfig

+config LVGL_HOR_RES_MAX
+	default 128
+
+config LVGL_VER_RES_MAX
+	default 32
+
+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


Suggested change

config LVGL_HOR_RES_MAX

default 128

config LVGL_VER_RES_MAX

default 32

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

Most of these changes were made as part of the upgrade to Zephyr 3.2, and I suspect setting the maximum horizontal and vertical resolution is not strictly necessary here.

dxmh added board PRs and issues related to boards. enhancement New feature or request shields PRs and issues related to shields labels Sep 23, 2021

cdc-mkb force-pushed the upstream branch from 6c9c2bd to 29038a2 Compare October 5, 2021 06:26

cdc-mkb force-pushed the upstream branch from 29038a2 to 9d764c1 Compare October 23, 2021 14:10

cdc-mkb force-pushed the upstream branch 2 times, most recently from 8a3fde8 to 66c71ec Compare November 21, 2021 10:15

cdc-mkb force-pushed the upstream branch 2 times, most recently from 3ab860d to 57d479d Compare November 22, 2021 07:47

Cedric Vincent added 2 commits November 29, 2021 22:35

feat(boards): Add Nucleo WB55CG dongle.

1441738

feat(shields): Add Zephirum.

4166827

cdc-mkb force-pushed the upstream branch from 57d479d to 4166827 Compare November 29, 2021 21:37

Nicell requested a review from petejohanson June 26, 2022 18:52

lesshonor suggested changes Oct 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Nucleo WB55CG board & Zephirum shield #938

Add support for Nucleo WB55CG board & Zephirum shield #938

cdc-mkb commented Sep 12, 2021

petejohanson commented Sep 30, 2021

cdc-mkb commented Oct 5, 2021

cdc-mkb commented Oct 23, 2021

cdc-mkb commented Nov 21, 2021

lesshonor left a comment •

edited

Loading

lesshonor Oct 17, 2023

lesshonor Oct 18, 2023

lesshonor Oct 18, 2023

lesshonor Oct 18, 2023

lesshonor Oct 18, 2023

lesshonor Oct 18, 2023

lesshonor Oct 18, 2023

	pinctrl-0 = <&i2c1_scl_pb8 &i2c1_sda_pb9>;
	pinctrl-0 = <&i2c1_scl_pb8 &i2c1_sda_pb9>;
	pinctrl-names = "default";

Add support for Nucleo WB55CG board & Zephirum shield #938

Are you sure you want to change the base?

Add support for Nucleo WB55CG board & Zephirum shield #938

Conversation

cdc-mkb commented Sep 12, 2021

petejohanson commented Sep 30, 2021

Hardware Metadata

The Problem

The Fix

Next Steps

Pro Micro shield DT naming changes

Split Shield Advertising Changes

Getting Help

cdc-mkb commented Oct 5, 2021

Board/Shield Check-list

cdc-mkb commented Oct 23, 2021

cdc-mkb commented Nov 21, 2021

lesshonor left a comment • edited Loading

Choose a reason for hiding this comment

lesshonor Oct 17, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor Oct 18, 2023

Choose a reason for hiding this comment

lesshonor left a comment •

edited

Loading