Initial commit of BoardSource 5x12 ZMK profile.

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM zmkfirmware/zmk-dev-arm:2.4
+FROM docker.io/zmkfirmware/zmk-dev-arm:2.5
 
 COPY .bashrc tmp
 RUN mv /tmp/.bashrc ~/.bashrc

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+<!-- If you're adding a board/shield please fill out this check-list, otherwise you can delete it -->
+## Board/Shield Check-list
+ - [ ] This board/shield is tested working on real hardware
+ - [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
+ - [ ] `.zmk.yml` metadata file added
+ - [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
+ - [ ] General consistent formatting of DeviceTree files
+ - [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
+ - [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
+ - [ ] If split, no name added for the right/peripheral half
+ - [ ] `.conf` file has optional extra features commented out

.github/workflows/build.yml

@@ -14,17 +14,19 @@ jobs:
   build:
     runs-on: ubuntu-latest
     container:
-      image: zmkfirmware/zmk-build-arm:2.4
+      image: docker.io/zmkfirmware/zmk-build-arm:2.5
     strategy:
       matrix:
         board:
           - bluemicro840_v1
           - nice_nano
+          - nice_nano_v2
           - nrfmicro_13
           - proton_c
         shield:
           - bfo9000_left
           - bfo9000_right
+          - boardsource5x12
           - boardsource3x4
           - corne_left
           - corne_right
@@ -69,11 +71,11 @@ jobs:
           - board: planck_rev6
           - board: proton_c
             shield: clueboard_california
-          - board: nice_nano
+          - board: nice_nano_v2
             shield: kyria_left
             cmake-args: -DCONFIG_ZMK_DISPLAY=y
             skip-archive: true
-          - board: nice_nano
+          - board: nice_nano_v2
             shield: kyria_right
             cmake-args: -DCONFIG_ZMK_DISPLAY=y
             skip-archive: true

.github/workflows/clang-format-lint.yml

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: DoozyX/clang-format-lint-action@v0.12
+      - uses: DoozyX/clang-format-lint-action@v0.13
         with:
           source: "./app"
           extensions: "h,c"

.github/workflows/doc-checks.yml

@@ -31,3 +31,16 @@ jobs:
       - name: Prettier check
         run: npm run prettier:check
         working-directory: docs
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+        with:
+          working-directory: docs
+      - name: Build
+        run: npm run build
+        working-directory: docs
+      - name: TypeScript check
+        run: npm run typecheck
+        working-directory: docs

.github/workflows/hardware-metadata-validation.yml

@@ -0,0 +1,45 @@
+name: Hardware Metadata Validation
+
+on:
+  push:
+    paths:
+      - ".github/workflows/hardware-metadata-validation.yml"
+      - "schema/hardware-metadata.schema.json"
+      - "app/boards/**/*.zmk.yml"
+      - "app/scripts/west_commands/metadata.py"
+  pull_request:
+    paths:
+      - ".github/workflows/hardware-metadata-validation.yml"
+      - "schema/hardware-metadata.schema.json"
+      - "app/boards/**/*.zmk.yml"
+      - "app/scripts/west_commands/metadata.py"
+
+jobs:
+  check-metadata-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
+      - uses: bahmutov/npm-install@v1
+        with:
+          working-directory: app
+      - name: Prettier Check
+        run: npm run prettier:check
+        working-directory: app
+  validate-metadata:
+    runs-on: ubuntu-latest
+    container:
+      image: docker.io/zmkfirmware/zmk-dev-arm:2.5
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: pip install -r app/scripts/requirements.txt
+      - name: West init
+        run: west init -l app
+      - name: Update modules (west update)
+        run: west update
+      - name: Export Zephyr CMake package (west zephyr-export)
+        run: west zephyr-export
+      - name: Validate Hardware Metadata
+        working-directory: app
+        run: west metadata check

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
   integration_test:
     runs-on: ubuntu-latest
     container:
-      image: zmkfirmware/zmk-build-arm:2.4
+      image: docker.io/zmkfirmware/zmk-build-arm:2.5
     steps:
       - name: Checkout
         uses: actions/checkout@v2

CONTRIBUTING.md

@@ -91,7 +91,7 @@ You can setup git to run prettier automatically when you commit by installing th
 ### Development Setup
 
 To get your development environment setup going, start at the
-[basic setup](https://zmk.dev/docs/dev-setup) docs, and make sure you can build and flash
+[basic setup](https://zmk.dev/docs/development/setup/) docs, and make sure you can build and flash
 your own locally built firmware.
 
 ### Formatting

app/.gitignore

@@ -1 +1,2 @@
 build/
+node_modules/

app/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    endOfLine: "auto",
+};

app/CMakeLists.txt

@@ -36,6 +36,7 @@ target_sources(app PRIVATE src/events/position_state_changed.c)
 target_sources(app PRIVATE src/events/layer_state_changed.c)
 target_sources(app PRIVATE src/events/keycode_state_changed.c)
 target_sources(app PRIVATE src/events/modifiers_state_changed.c)
+target_sources(app PRIVATE src/events/endpoint_selection_changed.c)
 target_sources(app PRIVATE src/events/sensor_event.c)
 target_sources_ifdef(CONFIG_ZMK_WPM app PRIVATE src/events/wpm_state_changed.c)
 target_sources_ifdef(CONFIG_ZMK_BLE app PRIVATE src/events/ble_active_profile_changed.c)
@@ -56,6 +57,7 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_BLE_ROLE_CENTRAL)
   target_sources(app PRIVATE src/behaviors/behavior_sensor_rotate_key_press.c)
   target_sources_ifdef(CONFIG_ZMK_EXT_POWER app PRIVATE src/behaviors/behavior_ext_power.c)
   target_sources(app PRIVATE src/combo.c)
+  target_sources(app PRIVATE src/conditional_layer.c)
   target_sources(app PRIVATE src/keymap.c)
 endif()
 target_sources_ifdef(CONFIG_ZMK_RGB_UNDERGLOW app PRIVATE src/behaviors/behavior_rgb_underglow.c)

app/Kconfig

@@ -25,7 +25,57 @@ config USB_DEVICE_PID
 config USB_DEVICE_MANUFACTURER
 	default "ZMK Project"
 
-menu "HID Output Types"
+menu "HID"
+
+choice ZMK_HID_REPORT_TYPE
+	prompt "HID Report Type"
+
+config ZMK_HID_REPORT_TYPE_HKRO
+	bool "#-Key Roll Over (HKRO) HID Report"
+	help
+	  Enable # key roll over for HID report. This selection is "boot keyboard" compatible
+	  but limits the total number of possible keys to report as held to #.
+
+config ZMK_HID_REPORT_TYPE_NKRO
+	bool "Full N-Key Roll Over (NKRO) HID Report"
+	help
+	  Enable full N-Key Roll Over for HID output. This selection will prevent the keyboard
+	  from working with some BIOS/UEFI versions that only support "boot keyboard" support.
+	  This option also prevents using some infrequently used higher range HID usages.
+
+endchoice
+
+if ZMK_HID_REPORT_TYPE_HKRO
+
+config ZMK_HID_KEYBOARD_REPORT_SIZE
+	int "# Keyboard Keys Reportable"
+	default 6
+
+endif
+
+config ZMK_HID_CONSUMER_REPORT_SIZE
+	int "# Consumer Keys Reportable"
+	default 6
+
+
+choice ZMK_HID_CONSUMER_REPORT_USAGES
+	prompt "HID Report Type"
+
+config ZMK_HID_CONSUMER_REPORT_USAGES_FULL
+	bool "Full Consumer HID Usage Support"
+	help
+	  Enable full Consumer usage ID values to be sent to hosts. Allows for less
+	  frequently used usages, but has compatibability issues with some host OSes.
+
+config ZMK_HID_CONSUMER_REPORT_USAGES_BASIC
+	bool "Basic Consumer HID Usage Support"
+	help
+	  Enable Consumer usage ID values up to "Playback Speed - Slow" to be sent to
+	  hosts. Allows for broader compatibability with more host OSes.
+
+endchoice
+
+menu "Output Types"
 
 config ZMK_USB
 	bool "USB"
@@ -92,7 +142,10 @@ config ZMK_BLE_PASSKEY_ENTRY
 #ZMK_BLE
 endif
 
-#HID Output Types
+#Output Types
+endmenu
+
+# HID
 endmenu
 
 menu "Split Support"
@@ -114,6 +167,7 @@ menuconfig ZMK_SPLIT_BLE_ROLE_CENTRAL
 	bool "Central"
 	select BT_CENTRAL
 	select BT_GATT_CLIENT
+	select BT_GATT_AUTO_DISCOVER_CCC
 
 if ZMK_SPLIT_BLE_ROLE_CENTRAL
 
@@ -156,7 +210,7 @@ endif
 endif
 
 #ZMK_SPLIT
-endif 
+endif
 
 if ZMK_BLE
 
@@ -209,36 +263,54 @@ config ZMK_RGB_UNDERGLOW_EXT_POWER
 	bool "RGB underglow toggling also controls external power"
 	default y
 
+config ZMK_RGB_UNDERGLOW_BRT_MIN
+	int "RGB underglow minimum brightness in percent"
+	range 0 100
+	default 0
+
+config ZMK_RGB_UNDERGLOW_BRT_MAX
+	int "RGB underglow maximum brightness in percent"
+	range ZMK_RGB_UNDERGLOW_BRT_MIN 100
+	default 100
+
 config ZMK_RGB_UNDERGLOW_HUE_STEP
-	int "RGB underglow hue step in degrees of 360"
+	int "RGB underglow hue step in degrees"
+	range 0 359
 	default 10
 
 config ZMK_RGB_UNDERGLOW_SAT_STEP
-	int "RGB underglow sturation step in percent"
+	int "RGB underglow saturation step in percent"
+	range 0 100
 	default 10
 
 config ZMK_RGB_UNDERGLOW_BRT_STEP
 	int "RGB underglow brightness step in percent"
+	range 0 100
 	default 10
 
 config ZMK_RGB_UNDERGLOW_HUE_START
-	int "RGB underglow start hue value from 0-359"
+	int "RGB underglow start hue value in degrees"
+	range 0 359
 	default 0
 
 config ZMK_RGB_UNDERGLOW_SAT_START
-	int "RGB underglow start saturations value from 0-100"
+	int "RGB underglow start saturations value in percent"
+	range 0 100
 	default 100
 
 config ZMK_RGB_UNDERGLOW_BRT_START
-	int "RGB underglow start brightness value from 0-100"
-	default 100
+	int "RGB underglow start brightness value in percent"
+	range ZMK_RGB_UNDERGLOW_BRT_MIN ZMK_RGB_UNDERGLOW_BRT_MAX
+	default ZMK_RGB_UNDERGLOW_BRT_MAX
 
 config ZMK_RGB_UNDERGLOW_SPD_START
-	int "RGB underglow start animation speed value from 1-5"
+	int "RGB underglow start animation speed value"
+	range 1 5
 	default 3
 
 config ZMK_RGB_UNDERGLOW_EFF_START
 	int "RGB underglow start effect int value related to the effect enum list"
+	range 0 3
 	default 0
 
 config ZMK_RGB_UNDERGLOW_ON_START
@@ -263,14 +335,11 @@ config ZMK_SLEEP
 
 if ZMK_SLEEP
 
-config SYS_POWER_DEEP_SLEEP_STATES
-	default y
-
 choice SYS_PM_POLICY
-	default SYS_PM_POLICY_APP
+	default PM_POLICY_APP
 endchoice
 
-config DEVICE_POWER_MANAGEMENT
+config PM_DEVICE
 	default y
 
 config ZMK_IDLE_SLEEP_TIMEOUT
@@ -422,6 +491,11 @@ config ZMK_WPM
 config SENSOR
 	default y
 
+choice CBPRINTF_IMPLEMENTATION
+	default CBPRINTF_NANO
+
+endchoice
+
 module = ZMK
 module-str = zmk
 source "subsys/logging/Kconfig.template.log_config"

app/boards/arm/bdn9/bdn9_rev2.yml

@@ -0,0 +1,11 @@
+file_format: "1"
+id: bdn9_rev2
+name: BDN9 Rev2
+type: board
+arch: arm
+features:
+  - keys
+  - encoder
+outputs:
+  - usb
+url: https://keeb.io/products/bdn9-rev-2-3x3-9-key-macropad-rotary-encoder-and-rgb

app/boards/arm/bdn9/bdn9_rev2.zmk.yml

@@ -0,0 +1,11 @@
+file_format: "1"
+id: bdn9_rev2
+name: BDN9 Rev2
+type: board
+arch: arm
+outputs:
+  - usb
+features:
+  - keys
+  - encoder
+url: https://keeb.io/collections/bdn9-collection/products/bdn9-rev-2-3x3-9-key-macropad-rotary-encoder-and-rgb

app/boards/arm/bdn9/bdn9_rev2_defconfig

@@ -11,6 +11,9 @@ CONFIG_FPU=y
 # enable GPIO
 CONFIG_GPIO=y
 
+# Enable pinmux
+CONFIG_PINMUX=y
+
 # Needed to reduce this to size that will fit on F072
 CONFIG_HEAP_MEM_POOL_SIZE=1024