feat: Update templates for hardware model v2

Updated the board templates for "zmk keyboard new" to support Zephyr's
hardware model v2. Also updated links to Zephyr's documentation to point
to Zephyr 4.1 to match the ZMK update that brings in hardware model v2.

Author: joelspadin

README.md

@@ -157,11 +157,11 @@ Run `zmk keyboard list` to print a list of supported keyboard hardware.
 
 If ZMK doesn't support your keyboard yet, you can run `zmk keyboard new` to create a new keyboard from a template.
 
-This won't walk you through all of the details of adding support for a new keyboard, but it will generate most of the boilerplate for you. See the [New Keyboard Shield](https://zmk.dev/docs/development/hardware-integration/new-shield) guide for how to finish writing the keyboard files.
+Note that this will generate most of the boilerplate for you, but you will still need to manually edit the files to match your keyboard. See the [New Keyboard Shield](https://zmk.dev/docs/development/hardware-integration/new-shield) guide for how to finish writing the keyboard files.
 
 ## Module Management
 
-[Zephyr modules](https://docs.zephyrproject.org/3.5.0/develop/modules.html) can add support for new keyboards, behaviors, and other features to ZMK. Use the `zmk module` command to install modules into your repo:
+[Zephyr modules](https://docs.zephyrproject.org/4.1.0/develop/modules.html) can add support for new keyboards, behaviors, and other features to ZMK. Use the `zmk module` command to install modules into your repo:
 
 ```sh
 zmk module add     # Add a module

pyproject.toml

@@ -58,6 +58,7 @@ disable = [
   "too-many-instance-attributes",
   "too-many-locals",
   "too-many-positional-arguments",
+  "too-many-statements",
 ]
 
 [tool.setuptools]

zmk/commands/keyboard/new.py

@@ -117,6 +117,9 @@ def keyboard_new(
             callback=_short_name_callback,
         ),
     ] = None,
+    vendor: Annotated[
+        str | None, typer.Option("--vendor", "-v", help="Keyboard vendor ID")
+    ] = None,
     keyboard_type: Annotated[
         KeyboardType | None,
         typer.Option(
@@ -129,6 +132,7 @@ def keyboard_new(
         KeyboardPlatform | None,
         typer.Option(
             "--platform",
+            "--soc",
             "-p",
             help="If creating a board, the platform/SoC on which it is based.",
         ),
@@ -171,6 +175,11 @@ def keyboard_new(
     if not keyboard_type:
         keyboard_type = _prompt_keyboard_type()
 
+    if not vendor and keyboard_type == KeyboardType.BOARD:
+        print("Boards are typically organized into folders by vendor name.")
+        print("(You may leave this blank to not create a vendor folder.)")
+        vendor = VendorPrompt.ask()
+
     if not interconnect_id and keyboard_type == KeyboardType.SHIELD:
         interconnect = _prompt_interconnect(repo)
     else:
@@ -193,6 +202,7 @@ def keyboard_new(
         short_name=short_name,
         keyboard_id=keyboard_id,
         interconnect=interconnect,
+        vendor=vendor,
     )
 
     dest = board_root / template.dest
@@ -357,6 +367,22 @@ def ask(  # pyright: ignore[reportIncompatibleMethodOverride]
         return result
 
 
+class VendorPrompt(NamePromptBase):
+    """Prompt for a vendor identifier."""
+
+    @classmethod
+    def validate(cls, value: str) -> None:
+        if not value:
+            # Vendor is allowed to be blank
+            return
+
+        _validate_id(value)
+
+    @classmethod
+    def ask(cls) -> str:  # pyright: ignore[reportIncompatibleMethodOverride]
+        return super().ask("Enter an ID for the vendor")
+
+
 _DEFAULT_ARCH = "arm"
 _PLATFORM_ARCH: dict[KeyboardPlatform, str] = {
     KeyboardPlatform.NRF52840: "arm",
@@ -376,15 +402,20 @@ def _get_template(
     short_name: str,
     keyboard_id: str,
     interconnect: Interconnect | None = None,
+    vendor: str | None = None,
 ):
     template = TemplateData()
     template.data["id"] = keyboard_id
     template.data["name"] = keyboard_name
     template.data["shortname"] = short_name
+    template.data["vendor"] = vendor or ""
     template.data["keyboard_type"] = str(keyboard_type)
     template.data["interconnect"] = ""
     template.data["arch"] = ""
     template.data["gpio"] = _DEFAULT_GPIO
+    template.data["soc"] = (
+        "" if keyboard_platform == KeyboardPlatform.OTHER else str(keyboard_platform)
+    )
 
     match keyboard_type:
         case KeyboardType.SHIELD:
@@ -404,7 +435,7 @@ def _get_template(
             template.data["gpio"] = _PLATFORM_GPIO.get(keyboard_platform, _DEFAULT_GPIO)
 
             template.folder = f"board/{keyboard_platform}/"
-            template.dest = f"{arch}/{keyboard_id}"
+            template.dest = f"{vendor}/{keyboard_id}" if vendor else keyboard_id
 
     match keyboard_layout:
         case KeyboardLayout.UNIBODY:

zmk/templates/__init__.py

@@ -39,15 +39,17 @@ def get_template_files(
     template_path = _ROOT_PATH / folder
 
     for file in template_path.rglob("*"):
-        template_name = str(file.relative_to(_ROOT_PATH))
-        template = lookup.get_template(template_name)
+        name_template = Template(text=file.name, strict_undefined=True)
+        name = cast(str, name_template.render_unicode(**data))
 
-        file_name = Template(text=file.name, strict_undefined=True)
+        # Board identifiers can contain forward slashes. File names cannot.
+        name = name.replace("/", "_")
 
-        yield (
-            cast(str, file_name.render_unicode(**data)),
-            _ensure_trailing_newline(cast(str, template.render_unicode(**data))),
-        )
+        file_template_name = str(file.relative_to(_ROOT_PATH))
+        file_template = lookup.get_template(file_template_name)
+        text = _ensure_trailing_newline(cast(str, file_template.render_unicode(**data)))
+
+        yield name, text
 
 
 # Matches <%tag ...>, </%tag ...>, and <%tag ... />. Group 1 is the tag name.

zmk/templates/board/nrf52840/Kconfig

@@ -1,22 +1,10 @@
 # This file was generated from a template. Edit it to match your keyboard.
-# See https://docs.zephyrproject.org/3.5.0/hardware/porting/board_porting.html#write-kconfig-files
+# See https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html#write-kconfig-files
 # for more information.
 
 if ${self.guard() | trim}
 
-config BOARD_ENABLE_DCDC
-    bool "DCDC mode"
-    select SOC_DCDC_NRF52X
-    default y
-
-# Uncomment this block if you are powering the SoC from the VDDH pin and have
-# an inductor between VDD and DCCH. Otherwise, delete this block.
-# WARNING: uncommenting this without the correct inductor will brick the device
-# and require reprogramming it with a J-Link or similar debug probe!
-
-# config BOARD_ENABLE_DCDC_HV
-#     bool "High Voltage DCDC converter"
-#     select SOC_DCDC_NRF52X_HV
-#     default y
+# Define any board-specific Kconfig options here.
+# If there are none, you may delete this file.
 
 endif # ${self.guard() | trim}

zmk/templates/board/nrf52840/Kconfig.defconfig

@@ -1,5 +1,5 @@
 # This file was generated from a template. Edit it to match your keyboard.
-# See https://docs.zephyrproject.org/3.5.0/hardware/porting/board_porting.html#write-kconfig-files
+# See https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html#write-kconfig-files
 # for more information.
 
 <%block name="before" />

zmk/templates/board/nrf52840/board.yaml

@@ -1,5 +1,5 @@
 # This file was generated from a template. Edit it to match your keyboard.
-# See https://docs.zephyrproject.org/3.5.0/develop/test/twister.html#board-configuration
+# See https://docs.zephyrproject.org/4.1.0/develop/test/twister.html#board-configuration
 # for more information.
 
 identifier: ${id}

zmk/templates/board/nrf52840/board_defconfig

@@ -1,11 +1,7 @@
 # This file was generated from a template. Edit it to match your keyboard.
-# See https://docs.zephyrproject.org/3.5.0/hardware/porting/board_porting.html#write-kconfig-files
+# See https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html#write-kconfig-files
 # for more information.
 
-CONFIG_SOC_SERIES_NRF52X=y
-CONFIG_SOC_NRF52840_QIAA=y
-CONFIG_BOARD_${id.upper()}=y
-
 # Enable MPU
 CONFIG_ARM_MPU=y
 

zmk/templates/board/nrf52840/common_outer.dtsi

@@ -1,3 +1,17 @@
+// Uncomment this to switch from the LDO to the DC/DC regulator on REG0.
+// Do not enable the DC/DC regulator without an LC filter connected to the DCCH
+// pin, or the keyboard will not boot until an LC filter is connected.
+// &reg0 {
+//     status = "okay";
+// };
+
+// Uncomment this to switch from the LDO to the DC/DC regulator on REG1.
+// Do not enable the DC/DC regulator without an LC filter connected to the DCC
+// pin, or the keyboard will not boot until an LC filter is connected.
+// &reg1 {
+//     regulator-initial-mode = <NRF5X_REG_MODE_DCDC>;
+// };
+
 &adc {
     status = "okay";
 };
@@ -22,13 +36,18 @@
     pinctrl-names = "default", "sleep";
 };
 
+// If you use the NFC pins as GPIOs, uncomment this. Otherwise, remove it.
+// &uicr {
+//     nfct-pins-as-gpios;
+// };
+
 zephyr_udc0: &usbd {
     status = "okay";
 };
 
 &flash0 {
     // Adjust this flash map as is necessary for your board. For more information, see
-    // https://docs.zephyrproject.org/3.5.0/services/storage/flash_map/flash_map.html#relationship-with-devicetree
+    // https://docs.zephyrproject.org/4.1.0/services/storage/flash_map/flash_map.html#relationship-with-devicetree
     partitions {
         compatible = "fixed-partitions";
         #address-cells = <1>;

zmk/templates/board/nrf52840/pinctrl.dtsi

@@ -1,6 +1,6 @@
 // This file was generated from a template. Edit it to match your keyboard.
-// See https://docs.zephyrproject.org/3.5.0/hardware/porting/board_porting.html
-// and https://docs.zephyrproject.org/3.5.0/hardware/pinctrl/index.html for
+// See https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html
+// and https://docs.zephyrproject.org/4.1.0/hardware/pinctrl/index.html for
 // more instructions.
 
 #include <dt-bindings/pinctrl/nrf-pinctrl.h>