Merge remote-tracking branch 'upstream/main' into split_battery_service

.github/workflows/build-user-config.yml

@@ -1,21 +1,21 @@
 name: Reusable user config build
 
-on: 
+on:
   workflow_call:
     inputs:
       build_matrix_path:
-        description: 'Path to the build matrix file'
-        default: 'build.yaml'
+        description: "Path to the build matrix file"
+        default: "build.yaml"
         required: false
         type: string
       config_path:
-        description: 'Path to the config directory'
-        default: 'config'
+        description: "Path to the config directory"
+        default: "config"
         required: false
         type: string
       fallback_binary:
-        description: 'Fallback binary format, if no *.uf2 file was built'
-        default: 'bin'
+        description: "Fallback binary format, if no *.uf2 file was built"
+        default: "bin"
         required: false
         type: string
 
@@ -71,6 +71,7 @@ jobs:
 
       - name: Cache west modules
         uses: actions/cache@v3.0.1
+        continue-on-error: true
         env:
           cache-name: cache-zephyr-${{ steps.variables.outputs.zephyr-version }}-modules
         with:
@@ -101,7 +102,7 @@ jobs:
 
       - name: ${{ steps.variables.outputs.display-name }} Kconfig file
         run: cat build/zephyr/.config | grep -v "^#" | grep -v "^$" | sort
-      
+
       - name: Rename artifacts
         run: |
           mkdir build/artifacts
@@ -112,7 +113,7 @@ jobs:
           then
             cp build/zephyr/zmk.${{ inputs.fallback_binary }} "build/artifacts/${{ steps.variables.outputs.artifact-name }}.${{ inputs.fallback_binary }}"
           fi
-      
+
       - name: Archive (${{ steps.variables.outputs.display-name }})
         uses: actions/upload-artifact@v2
         with:

app/Kconfig

@@ -88,6 +88,9 @@ if ZMK_USB
 config USB_NUMOF_EP_WRITE_RETRIES
 	default 10
 
+config USB_HID_POLL_INTERVAL_MS
+	default 1
+
 #ZMK_USB
 endif
 

docs/docs/customization.md

@@ -1,5 +1,5 @@
 ---
-title: Customizing ZMK/`zmk-config` folders
+title: Customizing ZMK/zmk-config folders
 sidebar_label: Customizing ZMK
 ---
 

docs/docs/faq.md

@@ -7,10 +7,10 @@ sidebar_label: FAQs
 
 As a best-in-class RTOS, Zephyr™ brings many [benefits](https://www.zephyrproject.org/benefits) to ZMK, such as:
 
-- A _single_ platform [supporting](https://docs.zephyrproject.org/latest/boards) many architectures, processors and boards.
+- A _single_ platform [supporting](https://docs.zephyrproject.org/latest/boards/index.html) many architectures, processors and boards.
 - Optimization for low-powered, small memory footprint devices.
-- Powerful hardware abstraction and configuration using [DeviceTree](https://docs.zephyrproject.org/latest/guides/dts/index.html) and [Kconfig](https://docs.zephyrproject.org/latest/guides/kconfig/index.html).
-- A BLE stack that periodically obtains [qualification](https://docs.zephyrproject.org/latest/guides/bluetooth/bluetooth-qual.html) listings, making it easier for final products to obtain qualification from the Bluetooth® SIG.
+- Powerful hardware abstraction and configuration using [DeviceTree](https://docs.zephyrproject.org/latest/guides/dts/index.html) and [Kconfig](https://docs.zephyrproject.org/latest/build/kconfig/index.html).
+- A BLE stack that periodically obtains [qualification](https://docs.zephyrproject.org/latest/connectivity/bluetooth/bluetooth-qual.html) listings, making it easier for final products to obtain qualification from the Bluetooth® SIG.
 - Multi-processor support, which is critical for power efficiency in upcoming MCUs.
 - Permissive licensing with its Apache 2.0 open source [license](https://www.apache.org/licenses/LICENSE-2.0).
 - A buzzing developer [community](https://github.com/zephyrproject-rtos/zephyr) including many leading [embedded technology](https://www.zephyrproject.org/project-members) companies.

docs/docs/features/combos.md

@@ -25,7 +25,7 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod
 
 - The name of the combo doesn't really matter, but convention is to start the node name with `combo_`.
 - The `compatible` property should always be `"zmk,combos"` for combos.
-- `timeout-ms` is the number of milliseconds that all keys of the combo must be pressed.
+- `timeout-ms` is the length of the window (in milliseconds) in which all keys of the combo must be pressed in order to successfully trigger the combo.
 - `key-positions` is an array of key positions. See the info section below about how to figure out the positions on your board.
 - `layers = <0 1...>` will allow limiting a combo to specific layers. This is an _optional_ parameter, when omitted it defaults to global scope.
 - `bindings` is the behavior that is activated when the behavior is pressed.

docs/src/setup-script-generation-plugin/index.js

@@ -30,6 +30,7 @@ function generateSetupScripts() {
             if (item.features?.includes("keys")) {
               agg.keyboards.push(item);
             } else {
+              item.usb_only = !item.outputs?.includes("ble");
               agg.boards.push(item);
             }
             break;

docs/src/templates/setup.ps1.mustache

@@ -125,12 +125,23 @@ if ($keyboard_type -eq "shield") {
         {{id}} = "{{{name}}}";
         {{/boards}}
     }
+    $boards_usb_only = [ordered]@{
+        {{#boards}}
+        {{id}} = "{{usb_only}}";
+        {{/boards}}
+    }
 
     Write-Host "$title"
     Write-Host ""
     Write-Host "MCU Board Selection:"
 
     $choice = Get-Choice-From-Options -Options $boards.values -Prompt $prompt
+
+    if ($keyboard_split -eq "true" -and $($($boards_usb_only.values)[$choice]) -eq "true") {
+        Write-Host "Wired split is not yet supported by ZMK."
+        exit 1
+    }
+    
     $shields = $keyboard_siblings
     $board = $($($boards.keys)[$choice])
     $boards = ( $board )

docs/src/templates/setup.sh.mustache

@@ -120,6 +120,7 @@ if [ "$keyboard_shield" == "y" ]; then
     prompt="Pick an MCU board:"
     options=({{#boards}}"{{{name}}}" {{/boards}})
     board_ids=({{#boards}}"{{id}}" {{/boards}})
+    boards_usb_only=({{#boards}}"{{#usb_only}}y{{/usb_only}}{{^usb_only}}n{{/usb_only}}" {{/boards}})
 
     echo ""
     echo "MCU Board Selection:"
@@ -134,6 +135,12 @@ if [ "$keyboard_shield" == "y" ]; then
                     echo "Invalid option. Try another one."
                     continue
                 fi
+
+                if [ -n "${!keyboard_sibling_first}" ] && [ "${boards_usb_only[$board_index]}" = "y" ] ; then
+                    echo "Wired split is not yet supported by ZMK."
+                    exit 1
+                fi
+
                 board_index=$(( $REPLY-1 ))
                 board=${board_ids[$board_index]}
                 board_title=${options[$board_index]}