Merge 45568337d5 into abb64ba316

Small build fix for the navbar label for the version dropdown, when
building in release version branches.

app/CMakeLists.txt

@@ -96,6 +96,7 @@ target_sources_ifdef(CONFIG_ZMK_BATTERY_REPORTING app PRIVATE src/battery.c)
 target_sources_ifdef(CONFIG_ZMK_HID_INDICATORS app PRIVATE src/events/hid_indicators_changed.c)
 
 target_sources_ifdef(CONFIG_ZMK_SPLIT app PRIVATE src/events/split_peripheral_status_changed.c)
+target_sources_ifdef(CONFIG_ZMK_SPLIT app PRIVATE src/events/split_transport_changed.c)
 add_subdirectory_ifdef(CONFIG_ZMK_SPLIT src/split)
 
 target_sources_ifdef(CONFIG_USB_DEVICE_STACK app PRIVATE src/usb.c)

app/include/zmk/events/split_transport_changed.h

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr/kernel.h>
+#include <zmk/event_manager.h>
+#include <zmk/split/transport/types.h>
+
+struct zmk_split_transport_changed {
+    uint32_t addr;
+    struct zmk_split_transport_status status;
+};
+
+ZMK_EVENT_DECLARE(zmk_split_transport_changed)

app/include/zmk/split/central.h

@@ -46,3 +46,7 @@ int zmk_split_central_update_hid_indicator(zmk_hid_indicators_t indicators);
 int zmk_split_central_get_peripheral_battery_level(uint8_t source, uint8_t *level);
 
 #endif // IS_ENABLED(CONFIG_ZMK_SPLIT_BLE_CENTRAL_BATTERY_LEVEL_FETCHING)
+
+bool zmk_split_transport_get_available(uint32_t addr);
+
+uint32_t zmk_split_get_transport_addr_at_index(uint8_t index);

app/include/zmk/split/peripheral.h

@@ -9,3 +9,7 @@
 #include <zmk/split/transport/types.h>
 
 int zmk_split_peripheral_report_event(const struct zmk_split_transport_peripheral_event *event);
+
+bool zmk_split_transport_get_available(uint32_t addr);
+
+uint32_t zmk_split_get_transport_addr_at_index(uint8_t index);

app/src/events/split_transport_changed.c

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2025 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/kernel.h>
+#include <zmk/events/split_transport_changed.h>
+
+ZMK_EVENT_IMPL(zmk_split_transport_changed);

app/src/split/bluetooth/central_bas_proxy.c

@@ -30,7 +30,7 @@ static void blvl_ccc_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value
 
 static ssize_t read_blvl(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf,
                          uint16_t len, uint16_t offset) {
-    const uint8_t source = (uint8_t)(uint32_t)attr->user_data;
+    const uint8_t source = *(uint8_t *)attr->user_data;
     uint8_t level = 0;
     int rc = zmk_split_central_get_peripheral_battery_level(source, &level);
 
@@ -60,7 +60,7 @@ static const struct bt_gatt_cpf aux_level_cpf = {
 
 #define PERIPH_BATT_LEVEL_ATTRS(i, _)                                                              \
     BT_GATT_CHARACTERISTIC(BT_UUID_BAS_BATTERY_LEVEL, BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY,     \
-                           BT_GATT_PERM_READ, read_blvl, NULL, i),                                 \
+                           BT_GATT_PERM_READ, read_blvl, NULL, ((uint8_t[]){i})),                  \
         BT_GATT_CCC(blvl_ccc_cfg_changed, BT_GATT_PERM_READ | BT_GATT_PERM_WRITE),                 \
         BT_GATT_CPF(&aux_level_cpf), BT_GATT_CUD(PERIPH_CUD(i), BT_GATT_PERM_READ),
 

app/src/split/central.c

@@ -19,6 +19,8 @@
 #include <zmk/events/position_state_changed.h>
 #include <zmk/events/sensor_event.h>
 
+#include <zmk/events/split_transport_changed.h>
+
 LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
 
 const struct zmk_split_transport_central *active_transport;
@@ -198,6 +200,8 @@ static int select_first_available_transport(void) {
 
 static int transport_status_changed_cb(const struct zmk_split_transport_central *central,
                                        struct zmk_split_transport_status status) {
+    raise_zmk_split_transport_changed(
+        (struct zmk_split_transport_changed){.addr = (uint32_t)central, .status = status});
     if (central == active_transport) {
         LOG_DBG("Central at %p changed status: enabled %d, available %d, connections %d", central,
                 status.enabled, status.available, status.connections);
@@ -212,6 +216,26 @@ static int transport_status_changed_cb(const struct zmk_split_transport_central
     return 0;
 }
 
+bool zmk_split_transport_get_available(uint32_t addr) {
+    STRUCT_SECTION_FOREACH(zmk_split_transport_central, t) {
+        if ((uint32_t)t == addr) {
+            return t->api->get_status().available;
+        }
+    }
+
+    return 0;
+}
+
+uint32_t zmk_split_get_transport_addr_at_index(uint8_t index) {
+    struct zmk_split_transport_central *t;
+    ptrdiff_t count;
+    STRUCT_SECTION_COUNT(zmk_split_transport_central, &count);
+    if ((ptrdiff_t)index > count)
+        return 0;
+    STRUCT_SECTION_GET(zmk_split_transport_central, index, &t);
+    return (uint32_t)t;
+}
+
 static int central_init(void) {
     STRUCT_SECTION_FOREACH(zmk_split_transport_central, t) {
         if (!t->api->set_status_callback) {

app/src/split/peripheral.c

@@ -18,6 +18,8 @@
 #include <zmk/events/sensor_event.h>
 #include <zmk/events/battery_state_changed.h>
 
+#include <zmk/events/split_transport_changed.h>
+
 #if IS_ENABLED(CONFIG_ZMK_SPLIT_PERIPHERAL_HID_INDICATORS)
 #include <zmk/events/hid_indicators_changed.h>
 #endif
@@ -116,6 +118,8 @@ static int select_first_available_transport(void) {
 
 static int transport_status_changed_cb(const struct zmk_split_transport_peripheral *p,
                                        struct zmk_split_transport_status status) {
+    raise_zmk_split_transport_changed(
+        (struct zmk_split_transport_changed){.addr = (uint32_t)p, .status = status});
     if (p == active_transport) {
         LOG_DBG("Peripheral at %p changed status: enabled %d, available %d, connections %d", p,
                 status.enabled, status.available, status.connections);
@@ -131,6 +135,26 @@ static int transport_status_changed_cb(const struct zmk_split_transport_peripher
     return 0;
 }
 
+bool zmk_split_transport_get_available(uint32_t addr) {
+    STRUCT_SECTION_FOREACH(zmk_split_transport_peripheral, t) {
+        if ((uint32_t)t == addr) {
+            return t->api->get_status().available;
+        }
+    }
+
+    return 0;
+}
+
+uint32_t zmk_split_get_transport_addr_at_index(uint8_t index) {
+    struct zmk_split_transport_peripheral *t;
+    ptrdiff_t count;
+    STRUCT_SECTION_COUNT(zmk_split_transport_peripheral, &count);
+    if ((ptrdiff_t)index > count)
+        return 0;
+    STRUCT_SECTION_GET(zmk_split_transport_peripheral, index, &t);
+    return (uint32_t)t;
+}
+
 static int peripheral_init(void) {
     STRUCT_SECTION_FOREACH(zmk_split_transport_peripheral, t) {
         if (!t->api->set_status_callback) {

docs/docusaurus.config.js

@@ -1,6 +1,34 @@
+const { execSync } = require("child_process");
 const path = require("path");
 const theme = require("./src/theme/prism/themes/github");
 const darkTheme = require("./src/theme/prism/themes/github-dark-dimmed");
+const { releaseVersions } = require("./zmk-release-versions.json");
+
+const gitBranch =
+  process.env.BRANCH ||
+  execSync("git branch --show-current", { encoding: "utf-8" }).trim();
+const isDevelopmentVersion =
+  gitBranch === "main" || !/^v\d+\.\d+-branch$/.test(gitBranch);
+const versionNavbarItems = [
+  {
+    label: "Pre-Release",
+    description: "Current active development branch (main)",
+    href: "https://zmk.dev/docs/",
+  },
+  ...releaseVersions.map((r) => ({
+    label: "v" + r,
+    description: "Stable release v" + r,
+    href: `https://v${r.replaceAll(".", "-")}-branch.zmk.dev/docs/`,
+  })),
+];
+
+const versionDropDownLabel = (
+  isDevelopmentVersion
+    ? versionNavbarItems[0]
+    : versionNavbarItems.find((item) => {
+        return item.label === gitBranch.replace("-branch", "");
+      })
+).label;
 
 module.exports = {
   title: "ZMK Firmware",
@@ -11,6 +39,10 @@ module.exports = {
   trailingSlash: "false",
   organizationName: "zmkfirmware", // Usually your GitHub org/user name.
   projectName: "zmk", // Usually your repo name.
+  customFields: {
+    isDevelopmentVersion,
+    releaseVersions,
+  },
   plugins: [
     "@docusaurus/theme-mermaid",
     path.resolve(__dirname, "src/docusaurus-tree-sitter-plugin"),
@@ -51,16 +83,29 @@ module.exports = {
           label: "Docs",
           position: "left",
         },
-        { to: "blog", label: "Blog", position: "left" },
+        isDevelopmentVersion
+          ? { to: "blog", label: "Blog", position: "left" }
+          : { href: "https://zmk.dev/blog", label: "Blog", position: "left" },
         {
-          to: "power-profiler",
-          label: "Power Profiler",
+          type: "dropdown",
+          label: "Tools",
           position: "left",
+          items: [
+            {
+              to: "power-profiler",
+              label: "Power Profiler",
+            },
+            {
+              to: "keymap-upgrader",
+              label: "Keymap Upgrader",
+            },
+          ],
         },
         {
-          to: "keymap-upgrader",
-          label: "Keymap Upgrader",
-          position: "left",
+          type: "dropdown",
+          label: versionDropDownLabel,
+          position: "right",
+          items: versionNavbarItems,
         },
         {
           href: "https://zmk.studio/",
@@ -69,7 +114,8 @@ module.exports = {
         },
         {
           href: "https://github.com/zmkfirmware/zmk",
-          label: "GitHub",
+          "aria-label": "ZMK GitHub Repository",
+          className: "header-github-link",
           position: "right",
         },
       ],

docs/src/css/custom.css

@@ -23,6 +23,21 @@
   --docusaurus-highlighted-code-line-bg: rgb(255 255 255 / 8%);
 }
 
+.header-github-link::before {
+  content: "";
+  width: 24px;
+  height: 24px;
+  display: flex;
+  background-color: var(--ifm-navbar-link-color);
+  mask-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E");
+  transition: background-color var(--ifm-transition-fast)
+    var(--ifm-transition-timing-default);
+}
+
+.header-github-link:hover::before {
+  background-color: var(--ifm-navbar-link-hover-color);
+}
+
 .docusaurus-highlight-code-line {
   display: block;
   margin: 0 calc(-1 * var(--ifm-pre-padding));

docs/src/theme/DocVersionBanner/index.tsx

@@ -0,0 +1,60 @@
+import { type ReactNode } from "react";
+import clsx from "clsx";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Link from "@docusaurus/Link";
+import { ThemeClassNames } from "@docusaurus/theme-common";
+import type { Props } from "@theme/DocVersionBanner";
+
+function ZMKReleaseLink({ version }: { version: string }): ReactNode {
+  return (
+    <Link
+      href={`https://v${version.replaceAll(".", "-")}-branch.zmk.dev/docs/`}
+    >
+      v{version}
+    </Link>
+  );
+}
+
+function DevWarningBanner({
+  className,
+  latestVersion,
+}: Props & { latestVersion: string }): ReactNode {
+  return (
+    <div
+      className={clsx(
+        className,
+        ThemeClassNames.docs.docVersionBanner,
+        "alert alert--warning margin-bottom--md"
+      )}
+      role="alert"
+    >
+      You're viewing the documentation for the development version of ZMK. You
+      may want the latest release <ZMKReleaseLink version={latestVersion} />.
+    </div>
+  );
+}
+
+export default function DocVersionBanner({ className }: Props): ReactNode {
+  const {
+    siteConfig: { customFields },
+  } = useDocusaurusContext();
+
+  if (
+    !customFields?.releaseVersions ||
+    !Array.isArray(customFields.releaseVersions)
+  ) {
+    return null;
+  }
+
+  const releaseVersions: [string] = customFields.releaseVersions as [string];
+
+  if (customFields.isDevelopmentVersion) {
+    return (
+      <DevWarningBanner
+        className={className}
+        latestVersion={releaseVersions[0]}
+      />
+    );
+  }
+  return null;
+}

docs/zmk-release-versions.json

@@ -0,0 +1,3 @@
+{
+  "releaseVersions": ["0.3"]
+}