diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..7cda150018 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,116 @@ +# Changelog +Here's all notable changes and commits to both the configuration repo and the base ZMK that the config repo builds against. + +Many thanks to all those who have submitted issues and pull requests to make this firmware better! +## Config repo + +28/7/2023 - Add a section in README explaining how to resolve connectivity issues after updating [#197](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/197) + +### 6/7/2023 - V3.0 - Major refactor to board definition to match the upstream PR and comply with ZMK pre-commit requirements, Final changes to key matrix in hope of avoiding any future git conflicts, switch to zephyr Pinctrl API, Update the settings-reset file, switch to the zephyr 3.2 branch of the base ZMK repo, add instructions to resolve the conflicts upon updating (adv360-z3.2) + +7/4/2023 - README improvements, adding instructions on flashing, links to the GUI editor and formatting cleanup [#128](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/128) + +4/3/2023 - Add extra keys into matrix that point to nowhere, fixes spurious keypress issues when using USB3.1 cables [#114](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/114) [#116](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/116) + + +14/2/2023 - Disable ZMK logging by default to improve power consumption [#101](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/101) + +25/1/2023 - Fix automatic OS detection to build properly when using the local builder on OS-X [#91](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/91) + +16/1/2023 - Change formatting of keymap GUI files [#92](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/92) + +21/11/2022 - Rewrite README to take into account new makefile structure [#57](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/57) + +18/11/2022 - Add SELinux support to the makefile build sequence [#58](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/58) + +14/11/2022 - Makefile cleanup to delete docker images on clean and run more seamlessly [#42](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/42) + +30/10/2022 - Improve make clean so that it doesn't error when run without build firmware [#36](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/36) + +26/10/2022 - Add support for building through podman as opposed to docker [#10](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/10) + +23/10/2022 - Update GitHub actions to avoid deprecated actions [#33](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/33) + +23/10/2022 - Add a makefile to reuse the docker image every time [#29](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/29) + +20/10/2022 - Update settings reset file to fully erase peripheral data from the central + +12/10/2022 - Fix local docker build after V2.0 update [#25](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/25) + +11/10/2022 - Set manufacturer information over BLE [#28](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/28) + +9/10/2022 - Cleanup of keymap [#24](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/) + +7/10/2022 - Add USB VID, PID and Manufacturer information to config files + +26/9/2022 - Revise local building script to avoid errors after V2.0 update + +### 17/9/2022 - V2.0 - Changes to support Zephyr 3 (adv360-z3) + +9/8/2022 - Remove extraneous keys from the GUI [#5](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/5) + +13/6/2022 - Change default keymap, add default macros + +23/5/2022 - Add local building with Docker, Add a README [#4](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/4) + +6/5/2022 - Change LFCLK accuracy for improved reliability [#2](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/2) + +### 3/3/2022 - V1.0 - Initial config repo release [#1](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/pull/1) (adv360-beta) + +1/3/2022 - Initial publication of licence + +## Base ZMK + +There have beeen 3 branches of ZMK used for the 360 Pro so far. + +| Branch | Date From | Date To | Config Branch | +| -------- | ------- |-------|-----| +| [adv360-beta](https://github.com/ReFil/zmk/tree/adv360-beta) | 1/3/2022 | 17/9/2022 | main (since deleted) | +| [adv360-z3](https://github.com/ReFil/zmk/tree/adv360-z3) | 17/9/2022 | 6/7/2023 | [V2.0](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/tree/V2.0) | +| [adv360-z3.2](https://github.com/ReFil/zmk/tree/adv360-z3.2) | 6/7/2023 | To date | [V3.0](https://github.com/KinesisCorporation/Adv360-Pro-ZMK/tree/V3.0) | + +### adv360-z3.2 + +31/7/2023 - Fix broken CI builds [#6](https://github.com/ReFil/zmk/pull/6) + +30/5/2023 - Update RGB indicators code to match latest changes from pull requests + +30/5/2023 - Merge latest HID indicators pull request alongside dependencies [#999](https://github.com/zmkfirmware/zmk/pull/999) [#1803](https://github.com/zmkfirmware/zmk/pull/1803) + +30/5/2023 - Disable BLE battery reporting due to unreliability + +30/5/2023 - Various fixes to allow compilation on zephyr 3.2 + +29/5/2023 - Merge latest upstream ZMK (Commit b276a3b) + +### adv360-z3 + +27/3/2023 - Fix power on behaviour for RGB lighting + +24/2/2023 - Fix indication leds for BLE profile 5 + +12/1/2023 - Merge latest upstream ZMK (Commit a82a0ec) + +12/1/2023 - Fix pre-commit formatting + +12/1/2023 - Fix a compile time warning by defining struct in header [#4](https://github.com/ReFil/zmk/pull/4) + +25/11/2022 - Add extra BLE characteristic to fix HID light reporting on MacOS + +19/10/2022 - Add BLE whitelist scanning to improve performance in environments with many BLE devices + +19/10/2022 - Merge latest upstream ZMK (Commit c9eb631) + +19/10/2022 - Fix initial power on lighting + +2/10/2022 - Add ability to scale RGB and backlight brightness to improve battery life + +13/9/2022 - Add custom lighting functionality on top of base ZMK + +12/9/2022 - Merge HID indicators pull request [#999](https://github.com/zmkfirmware/zmk/pull/999) atop of base ZMK + +11/9/2022 - Diverge from base ZMK (Commit 6124d25) + + +### adv360-beta +This repository has been deprecated for a year and as such will not be documented, it is advisable to upgrade to V3.0 as this has more features and improved reliability diff --git a/README.md b/README.md index 3f7be2885f..c0c3885d01 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ ## Modifying the keymap -There is a GUI for editing the keymap. It is available at https://kinesiscorporation.github.io/Adv360-Pro-GUI +[The ZMK documentation](https://zmk.dev/docs) covers both basic and advanced functionality and has a table of OS compatibility for keycodes. Please note that the RGB Underglow, Backlight and Power Management sections are not relevant to the Advantage 360 Pro's custom ZMK fork. For more information see [this note](#note) + +There is a GUI for editing the keymap. It is available at https://kinesiscorporation.github.io/Adv360-Pro-GUI. This repository is also compatible with certain other web based ZMK keymap editors. + +Certain ZMK features require knowing the exact key positions in the matrix. They can be found in both image and text format [here](assets/key-positions.md) ## Building the Firmware with GitHub Actions @@ -38,13 +42,13 @@ There is a GUI for editing the keymap. It is available at https://kinesiscorpora ### Cleanup -The built docker container and compiled firmware files can be deleted with `make clean`. +The built docker container and compiled firmware files can be deleted with `make clean`. This might be necessary if you updated your fork from V2.0 to V3.0 and are encountering build failures ## Flashing firmware Follow the programming instruction on page 8 of the [Quick Start Guide](https://kinesis-ergo.com/wp-content/uploads/Advantage360-Professional-QSG-v8-25-22.pdf) to flash the firmware. -### briefly +### Overview 1. Extract the firmwares from the downloaded archive. 1. Connect the left side keyboard to USB. @@ -60,6 +64,21 @@ Follow the programming instruction on page 8 of the [Quick Start Guide](https:// > Note: There are also physical reset buttons on both keyboards which can be used to enter and exit the bootloader mode. Their location is described in section 2.7 on page 9 in the [User Manual](https://kinesis-ergo.com/wp-content/uploads/Advantage360-ZMK-KB360-PRO-Users-Manual-v3-10-23.pdf) and use is described in section 5.9 on page 14. +### Upgrading from V2 to V3 + +If you are upgrading from V2 to V3, and if the flashing didn't work as expected (i.e. if you are unable to pair the keyboard via Bluetooth), then consider [resetting](https://kinesis-ergo.com/support/kb360pro/#firmware-updates) both halves of the keyboard to its native state. Make sure to use the `settings-reset.uf2` file from +the V3 branch of this repository. After doing this, proceed with the flashing instructions above. + +## Changelog + +The changelog for both the config repo and the underlying ZMK fork that the config repo builds against can be found [here](CHANGELOG.md) + +## Note + +By default this config repository references [a customised version of ZMK](https://github.com/ReFil/zmk/tree/adv360-z3.2) with Advantage 360 Pro specific functionality and changes over [base ZMK](https://github.com/zmkfirmware/zmk). The Kinesis fork is regularly updated to bring the latest updates and changes from base ZMK however will not always be completely up to date. + +Whilst the Advantage 360 Pro is compatible with base ZMK some of the more advanced features will not work, and Kinesis cannot provide customer service for usage of base ZMK. Likewise the ZMK community cannot provide support for either the Kinesis keymap editor, nor any usage of the Kinesis custom fork. + ## Other support Further support resources can be found on Kinesis.com: diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 0000000000..10d5ddf1a2 --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,62 @@ +# Advantage 360 Pro ZMK upgrade guide + +The last V2.0 update and the new V3.0 branch have introduced changes into the keymap files that causes merge conflicts for people updating with custom keymaps. This guide covers what changed, why it changed and how to fix it. + +## What changed and why + +To resolve issues some users were encountering with out of matrix keypresses, as well as to streamline the keymap for all future updates, several keys that are unused were removed from the keymap and [matrix transform](https://zmk.dev/docs/config/kscan#matrix-transform). Formatting was also standardised to fall in line with ZMK formatting conventions. As a result the board definition for the Advantage 360 Pro as it stands to get merged into ZMK main [here](https://github.com/zmkfirmware/zmk/pull/1454) matches the one in this repository to the greatest extent possible. +These changes result in a merge conflict when two diverging git branches try to get added together in the updating procedure. +This sort of breaking change shouldn't happen again in the future. + +## How to solve the merge conflict + +In order to solve the merge conflict all that has to be done is for the conflicting key behaviours to be manually removed from two files. +- adv360.keymap + +![The highlighted &none behaviours that need removing](/assets/keymap.jpg) +- keymap.json + +![The highlighted &none behaviours that need removing](/assets/json.jpg) + +These highlighted keys must be removed from each layer in both files. Be careful to preserve a comma in between every key behaviour in the keymap.json and at least one space between every behaviour in adv360.keymap or firmware builds will fail. The quotes need correctly preserving on the behaviours in keymap.json. Each behaviour needs to be wrapped in quotes. Whitespace within the quotes is ignored. +If you try to update your fork using the GitHub web interface you will see an error saying "This branch has merge conflicts and cannot be merged automatically" and you will be prompted to open a pull request instead. Solving the merge conflict this way is more challenging than doing it on GitHub desktop. + +### Github Desktop + +This assumes you already have [GitHub desktop](https://desktop.github.com/) downloaded, installed and you have logged in using the GitHub credentials for your account. Whilst it would be helpful to have an alternative text editor such as VSCode installed this task can be completed with notepad +1. Clone your repository + + Navigate in the menu to File->Clone repository. Your fork of the Adv360-Pro-ZMK repository should be visible in the menu of repositories to choose from. Click the blue "Clone" button +2. Open the folder + + Open the folder by using the "Show in your file manager" option and navigate to the "config" folder +3. Edit keymap.json + + Open keymap.json, and for each layer remove the 8 highlighted &none behaviours including the quotes wrapping them, and the commas +4. Edit adv 360.keymap + + Open adv360.keymap and remove the 8 highlighted &none behaviours in each later +5. Commit your changes + + Returning to GitHub desktop you should see the changes you made in the bar on the left. Type an appropriate commit summary and click "Commit to *branch name*" + + ![The commit dialog of GitHub Desktop](/assets/commit.jpg) + +6. Merge + + Navigate to Branch->Merge into current branch and select "upstream/V2.0" or "upstream/V3.0". You will see a warning that there will be two conflicted files. Click "Create a merge commit". + + ![The merge dialog showing a warning of conflicts](/assets/merge.jpg) + +7. Resolve Conflicts + + The conflict resolution window has powerful options to soresolve the merge conflict, you will want to clik on the down arrow next to "Open in *your text editor*" and click use the modified file from *your branch name*. In the case of this example it is called V2.0-beta. Using the file from upstream/V2.0 or upstream/V3.0 will result in none of your keymap changes being preserved. + Do this for both files then you will be able to click the "Continue Merge" option + + ![The merge dialog showing a warning of conflicts](/assets/conflict.jpg) +8. Push + + Once the merge is complete you should be able to click the "push origin" button in the top bar. At this point your changes should be uploaded to GitHub servers and the build should start +9. Test your firmware + + When the build succeeds download the uf2 files and flash them as normal. Test the keymap, if keys are shifted one way or the other it's likely you deleted too many or not enough behaviours. \ No newline at end of file diff --git a/assets/commit.jpg b/assets/commit.jpg new file mode 100644 index 0000000000..49788cf459 Binary files /dev/null and b/assets/commit.jpg differ diff --git a/assets/conflict.jpg b/assets/conflict.jpg new file mode 100644 index 0000000000..b047af73ca Binary files /dev/null and b/assets/conflict.jpg differ diff --git a/assets/json.jpg b/assets/json.jpg new file mode 100644 index 0000000000..4f8bf417b7 Binary files /dev/null and b/assets/json.jpg differ diff --git a/assets/key-positions.md b/assets/key-positions.md new file mode 100644 index 0000000000..1c2a7bac29 --- /dev/null +++ b/assets/key-positions.md @@ -0,0 +1,26 @@ +# Advantage 360 Pro key positions +## Image +![The key positions on the Advantage 360](key-positions.png) + +## Code +``` +#define KEYS_L 0 1 2 3 4 5 6 \ + 14 15 16 17 18 19 20 \ + 28 29 30 31 32 33 34 \ + 46 47 48 49 50 51 \ + 60 61 62 63 64 + +#define THUMBS_LEFT 35 36 \ + 52 \ + 65 66 67 \ + +#define KEYS_R 7 8 9 10 11 12 13 \ + 21 22 23 24 25 26 27 \ + 39 40 41 42 43 44 45 \ + 54 55 56 57 58 59 \ + 71 72 73 74 75 + +#define THUMBS_RIGHT 37 38 \ + 53 \ + 68 69 70 \ + ``` \ No newline at end of file diff --git a/assets/key-positions.png b/assets/key-positions.png new file mode 100644 index 0000000000..7ca1bd7025 Binary files /dev/null and b/assets/key-positions.png differ diff --git a/assets/keymap.jpg b/assets/keymap.jpg new file mode 100644 index 0000000000..190c306a1e Binary files /dev/null and b/assets/keymap.jpg differ diff --git a/assets/merge.jpg b/assets/merge.jpg new file mode 100644 index 0000000000..20d67e2ae0 Binary files /dev/null and b/assets/merge.jpg differ diff --git a/config/boards/arm/adv360/Kconfig b/config/boards/arm/adv360/Kconfig index 350014a0da..db5273eb0c 100644 --- a/config/boards/arm/adv360/Kconfig +++ b/config/boards/arm/adv360/Kconfig @@ -1,7 +1,7 @@ # SPDX-License-Identifier: MIT config BOARD_ENABLE_DCDC - bool "Enable DCDC mode" - select SOC_DCDC_NRF52X - default y - depends on BOARD_ADV360_LEFT || BOARD_ADV360_RIGHT + bool "Enable DCDC mode" + select SOC_DCDC_NRF52X + default y + depends on BOARD_ADV360_LEFT || BOARD_ADV360_RIGHT \ No newline at end of file diff --git a/config/boards/arm/adv360/Kconfig.board b/config/boards/arm/adv360/Kconfig.board index cacf2cf812..cf534c5e05 100644 --- a/config/boards/arm/adv360/Kconfig.board +++ b/config/boards/arm/adv360/Kconfig.board @@ -1,12 +1,12 @@ # -# Copyright (c) 2021 Polarity Works +# Copyright (c) 2022 The ZMK Contributors # SPDX-License-Identifier: MIT # config BOARD_ADV360_LEFT - bool "adv360_left" - depends on SOC_NRF52840_QIAA + bool "adv360_left" + depends on SOC_NRF52840_QIAA config BOARD_ADV360_RIGHT - bool "adv360_right" - depends on SOC_NRF52840_QIAA + bool "adv360_right" + depends on SOC_NRF52840_QIAA diff --git a/config/boards/arm/adv360/Kconfig.defconfig b/config/boards/arm/adv360/Kconfig.defconfig index 9d60f88e74..aa2fb87a16 100644 --- a/config/boards/arm/adv360/Kconfig.defconfig +++ b/config/boards/arm/adv360/Kconfig.defconfig @@ -1,19 +1,21 @@ # -# Copyright (c) 2021 Polarity Works +# Copyright (c) 2022 The ZMK Contributors # SPDX-License-Identifier: MIT # if BOARD_ADV360_LEFT - config ZMK_KEYBOARD_NAME - default "Adv360 Pro" + config ZMK_KEYBOARD_NAME + default "Adv360 Pro" + config ZMK_SPLIT_ROLE_CENTRAL + default y endif # BOARD_ADV360_LEFT if BOARD_ADV360_RIGHT - config ZMK_KEYBOARD_NAME - default "Adv360 Pro rt" + config ZMK_KEYBOARD_NAME + default "Adv360 Pro rt" endif # BOARD_ADV360_RIGHT @@ -21,39 +23,39 @@ endif # BOARD_ADV360_RIGHT if BOARD_ADV360_LEFT || BOARD_ADV360_RIGHT config BOARD - default "adv360" + default "adv360" config ZMK_SPLIT - default y + default y config SPI bool default y config BT_CTLR - default BT + default BT config ZMK_BLE - default y + default y config ZMK_USB - default y + default y if USB config USB_NRFX - default y + default y config USB_DEVICE_STACK - default y + default y endif # USB config ZMK_BATTERY_VOLTAGE_DIVIDER - default y + default y config SPI - default y + default y diff --git a/config/boards/arm/adv360/adv360.dtsi b/config/boards/arm/adv360/adv360.dtsi index 286e834695..2f221fcbfb 100644 --- a/config/boards/arm/adv360/adv360.dtsi +++ b/config/boards/arm/adv360/adv360.dtsi @@ -11,171 +11,150 @@ #include #include +#include "adv360_pinctrl.dtsi" + / { - model = "Adv360"; - compatible = "adv360"; - - chosen { - zephyr,code-partition = &code_partition; - zephyr,sram = &sram0; - zephyr,flash = &flash0; - zmk,kscan = &kscan0; - zmk,underglow = &led_strip; - zmk,backlight = &backlight; - zmk,matrix_transform = &default_transform; - zmk,battery = &vbatt; - zephyr,console = &cdc_acm_uart; - }; - - default_transform: keymap_transform_0 { - compatible = "zmk,matrix-transform"; - columns = <20>; - rows = <5>; - - - map = < - RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5) RC(4,6) RC(4,13) RC(4,14) RC(4,15) RC(4,16) RC(4,17) RC(4,18) RC(4,19) - RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5) RC(3,6) RC(3,13) RC(3,14) RC(3,15) RC(3,16) RC(3,17) RC(3,18) RC(3,19) - RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,6) RC(2,8) RC(2,9) RC(2,10) RC(2,11) RC(2,13) RC(2,14) RC(2,15) RC(2,16) RC(2,17) RC(2,18) RC(2,19) - RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5) RC(1,9) RC(1,10) RC(1,14) RC(1,15) RC(1,16) RC(1,17) RC(1,18) RC(1,19) - RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,7) RC(0,8) RC(0,9) RC(0,10) RC(0,11) RC(0,12) RC(0,15) RC(0,16) RC(0,17) RC(0,18) RC(0,19) - - >; - }; - ext-power { - compatible = "zmk,ext-power-generic"; - label = "EXT_POWER"; - control-gpios = <&gpio0 13 GPIO_ACTIVE_HIGH>; - }; - backlight: pwmleds { - compatible = "pwm-leds"; - label = "Backlight LEDs"; - pwm_led_0 { - pwms = <&pwm0 17>; - label = "Backlight LED 0"; + model = "Adv360"; + compatible = "kinesis,adv360"; + + chosen { + zephyr,code-partition = &code_partition; + zephyr,sram = &sram0; + zephyr,flash = &flash0; + zmk,kscan = &kscan0; + zmk,backlight = &backlight; + zmk,battery = &vbatt; + zmk,matrix_transform = &default_transform; + zmk,underglow = &led_strip; }; -}; - leds { - compatible = "gpio-leds"; - blue_led: led_0 { - gpios = <&gpio0 15 GPIO_ACTIVE_HIGH>; - label = "Blue LED"; - }; - }; - - vbatt: vbatt { - compatible = "zmk,battery-voltage-divider"; - label = "VBATT"; - io-channels = <&adc 2>; - output-ohms = <100000>; - full-ohms = <(100000 + 100000)>; - }; + default_transform: keymap_transform_0 { + compatible = "zmk,matrix-transform"; + columns = <20>; + rows = <5>; + + + map = < + RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4) RC(4,5) RC(4,6) RC(4,13) RC(4,14) RC(4,15) RC(4,16) RC(4,17) RC(4,18) RC(4,19) + RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5) RC(3,6) RC(3,13) RC(3,14) RC(3,15) RC(3,16) RC(3,17) RC(3,18) RC(3,19) + RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,6) RC(2,8) RC(2,9) RC(2,10) RC(2,11) RC(2,13) RC(2,14) RC(2,15) RC(2,16) RC(2,17) RC(2,18) RC(2,19) + RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5) RC(1,9) RC(1,10) RC(1,14) RC(1,15) RC(1,16) RC(1,17) RC(1,18) RC(1,19) + RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,7) RC(0,8) RC(0,9) RC(0,10) RC(0,11) RC(0,12) RC(0,15) RC(0,16) RC(0,17) RC(0,18) RC(0,19) + + >; + }; + ext-power { + compatible = "zmk,ext-power-generic"; + label = "EXT_POWER"; + control-gpios = <&gpio0 13 GPIO_ACTIVE_HIGH>; + }; + + vbatt: vbatt { + compatible = "zmk,battery-voltage-divider"; + io-channels = <&adc 2>; + output-ohms = <100000>; + full-ohms = <(100000 + 100000)>; + }; + + backlight: pwmleds { + compatible = "pwm-leds"; + pwm_led_0 { + pwms = <&pwm0 0 10000 PWM_POLARITY_NORMAL>; + }; + }; + }; &pwm0 { - status = "okay"; - ch0-pin = <17>; + status = "okay"; + pinctrl-0 = <&pwm0_default>; + pinctrl-1 = <&pwm0_sleep>; + pinctrl-names = "default", "sleep"; }; &adc { - status = "okay"; + status = "okay"; }; &gpiote { - status = "okay"; + status = "okay"; }; &gpio0 { - status = "okay"; + status = "okay"; }; &gpio1 { - status = "okay"; + status = "okay"; }; &usbd { - status = "disabled"; - cdc_acm_uart: cdc_acm_uart { - compatible = "zephyr,cdc-acm-uart"; - label = "CDC_ACM_0"; - }; -}; - -&uart0 { - compatible = "nordic,nrf-uarte"; - status = "okay"; - current-speed = <115200>; - tx-pin = <39>; - rx-pin = <44>; - rts-pin = <34>; - cts-pin = <9>; + status = "okay"; }; &flash0 { - /* - * For more information, see: - * http://docs.zephyrproject.org/latest/devices/dts/flash_partitions.html - */ - partitions { - compatible = "fixed-partitions"; - #address-cells = <1>; - #size-cells = <1>; - - sd_partition: partition@0 { - label = "softdevice"; - reg = <0x00000000 0x00026000>; - }; - code_partition: partition@26000 { - label = "code_partition"; - reg = <0x00026000 0x000c6000>; - }; - - /* - * The flash starting at 0x000ec000 and ending at - * 0x000f3fff is reserved for use by the application. - */ - - /* - * Storage partition will be used by FCB/LittleFS/NVS - * if enabled. - */ - storage_partition: partition@ec000 { - label = "storage"; - reg = <0x000ec000 0x00008000>; - }; - - boot_partition: partition@f4000 { - label = "adafruit_boot"; - reg = <0x000f4000 0x0000c000>; - }; - }; + /* + * For more information, see: + * http://docs.zephyrproject.org/latest/devices/dts/flash_partitions.html + */ + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + sd_partition: partition@0 { + label = "softdevice"; + reg = <0x00000000 0x00026000>; + }; + code_partition: partition@26000 { + label = "code_partition"; + reg = <0x00026000 0x000c6000>; + }; + + /* + * The flash starting at 0x000ec000 and ending at + * 0x000f3fff is reserved for use by the application. + */ + + /* + * Storage partition will be used by FCB/LittleFS/NVS + * if enabled. + */ + storage_partition: partition@ec000 { + label = "storage"; + reg = <0x000ec000 0x00008000>; + }; + + boot_partition: partition@f4000 { + label = "adafruit_boot"; + reg = <0x000f4000 0x0000c000>; + }; + }; }; -&spi1 { - compatible = "nordic,nrf-spim"; - status = "okay"; - mosi-pin = <20>; - // Unused pins, needed for SPI definition, but not used by the ws2812 driver itself. - sck-pin = <27>; - miso-pin = <8>; +&spi3 { + compatible = "nordic,nrf-spim"; + status = "okay"; + pinctrl-0 = <&spi3_default>; + pinctrl-1 = <&spi3_sleep>; + pinctrl-names = "default", "sleep"; - led_strip: ws2812@0 { - compatible = "worldsemi,ws2812-spi"; - label = "WS2812"; + led_strip: ws2812@0 { + compatible = "worldsemi,ws2812-spi"; + label = "WS2812"; - /* SPI */ - reg = <0>; - spi-max-frequency = <4000000>; + /* SPI */ + reg = <0>; + spi-max-frequency = <4000000>; - /* WS2812 */ - chain-length = <3>; /* number of LEDs */ - spi-one-frame = <0x70>; - spi-zero-frame = <0x40>; + /* WS2812 */ + chain-length = <3>; /* number of LEDs */ + spi-one-frame = <0x70>; + spi-zero-frame = <0x40>; - color-mapping = ; - }; + }; }; diff --git a/config/boards/arm/adv360/adv360.yaml b/config/boards/arm/adv360/adv360.yaml index 1cefe88776..4fa5d6c6cb 100644 --- a/config/boards/arm/adv360/adv360.yaml +++ b/config/boards/arm/adv360/adv360.yaml @@ -1,5 +1,5 @@ identifier: adv360 -name: Adv360 +name: Advantage 360 Pro type: keyboard arch: arm toolchain: diff --git a/config/boards/arm/adv360/adv360.zmk.yml b/config/boards/arm/adv360/adv360.zmk.yml new file mode 100644 index 0000000000..d1a6021adb --- /dev/null +++ b/config/boards/arm/adv360/adv360.zmk.yml @@ -0,0 +1,16 @@ +file_format: "1" +id: adv360 +name: Advantage 360 Pro +type: board +url: https://kinesis-ergo.com/keyboards/advantage360 +arch: arm +features: + - keys + - underglow + - backlight +outputs: + - usb + - ble +siblings: + - adv360pro_left + - adv360pro_right diff --git a/config/boards/arm/adv360/adv360_left.dts b/config/boards/arm/adv360/adv360_left.dts index 9509093ce8..87813e861e 100644 --- a/config/boards/arm/adv360/adv360_left.dts +++ b/config/boards/arm/adv360/adv360_left.dts @@ -8,39 +8,29 @@ #include "adv360.dtsi" /{ - kscan0: kscan { - compatible = "zmk,kscan-gpio-matrix"; - label = "KSCAN"; + kscan0: kscan { + compatible = "zmk,kscan-gpio-matrix"; - diode-direction = "col2row"; - row-gpios - = <&gpio1 11 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio1 15 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio0 3 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio1 14 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio1 12 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - ; - - col-gpios - = <&gpio0 25 GPIO_ACTIVE_HIGH> - , <&gpio0 11 GPIO_ACTIVE_HIGH> - , <&gpio0 2 GPIO_ACTIVE_HIGH> - , <&gpio0 28 GPIO_ACTIVE_HIGH> - , <&gpio0 29 GPIO_ACTIVE_HIGH> - , <&gpio0 30 GPIO_ACTIVE_HIGH> - , <&gpio0 31 GPIO_ACTIVE_HIGH> - , <&gpio1 9 GPIO_ACTIVE_HIGH> - , <&gpio0 12 GPIO_ACTIVE_HIGH> - , <&gpio0 7 GPIO_ACTIVE_HIGH> - ; - }; - - leds { - compatible = "gpio-leds"; - blue_led: led_0 { - gpios = <&gpio0 15 GPIO_ACTIVE_HIGH>; - label = "Blue LED"; - }; - }; + diode-direction = "col2row"; + row-gpios + = <&gpio1 11 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio1 15 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 3 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio1 14 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio1 12 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + ; + col-gpios + = <&gpio0 25 GPIO_ACTIVE_HIGH> + , <&gpio0 11 GPIO_ACTIVE_HIGH> + , <&gpio0 2 GPIO_ACTIVE_HIGH> + , <&gpio0 28 GPIO_ACTIVE_HIGH> + , <&gpio0 29 GPIO_ACTIVE_HIGH> + , <&gpio0 30 GPIO_ACTIVE_HIGH> + , <&gpio0 31 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio0 7 GPIO_ACTIVE_HIGH> + ; + }; }; diff --git a/config/boards/arm/adv360/adv360_left_defconfig b/config/boards/arm/adv360/adv360_left_defconfig index c8804278e0..33ef88e964 100644 --- a/config/boards/arm/adv360/adv360_left_defconfig +++ b/config/boards/arm/adv360/adv360_left_defconfig @@ -1,15 +1,11 @@ # -# Copyright (c) 2021 Polarity Works +# Copyright (c) 2022 The ZMK Contributors # SPDX-License-Identifier: MIT # CONFIG_SOC_SERIES_NRF52X=y CONFIG_SOC_NRF52840_QIAA=y CONFIG_BOARD_ADV360_LEFT=y -CONFIG_ZMK_BLE=y - -CONFIG_ZMK_SPLIT=y -CONFIG_ZMK_SPLIT_ROLE_CENTRAL=y # Enable MPU CONFIG_ARM_MPU=y @@ -17,10 +13,9 @@ CONFIG_ARM_MPU=y # enable GPIO CONFIG_GPIO=y - -# Enable SPI +# Enable SPI for LEDS +CONFIG_PINCTRL=y CONFIG_SPI=y - CONFIG_SPI_NRFX=y # Enable writing to flash @@ -34,28 +29,37 @@ CONFIG_FLASH_MAP=y # Enable 32kHz crystal CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y -CONFIG_CLOCK_CONTROL_NRF_K32SRC_500PPM=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_150PPM=y +#RGB leds config +CONFIG_WS2812_STRIP=y CONFIG_ZMK_RGB_UNDERGLOW=y CONFIG_ZMK_RGB_UNDERGLOW_EXT_POWER=y CONFIG_ZMK_RGB_UNDERGLOW_ON_START=y CONFIG_ZMK_RGB_UNDERGLOW_EFF_START=4 CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_IDLE=y -# Use the STRIP config specific to the LEDs you're using -CONFIG_WS2812_STRIP=y -CONFIG_BT_CTLR_TX_PWR_PLUS_8=y +#Backlighting configuration CONFIG_PWM=y CONFIG_LED_PWM=y CONFIG_ZMK_BACKLIGHT=y +CONFIG_ZMK_BACKLIGHT_BRT_START=20 CONFIG_ZMK_BACKLIGHT_AUTO_OFF_IDLE=y -CONFIG_ZMK_HID_REPORT_TYPE_NKRO=y -CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_BASIC=y +#BT configuration +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y +CONFIG_BT_DIS_MANUF="Kinesis Corporation" +CONFIG_BT_PRIVACY=y +CONFIG_BT_GAP_PERIPHERAL_PREF_PARAMS=y +CONFIG_BT_PERIPHERAL_PREF_TIMEOUT=600 +CONFIG_BT_PERIPHERAL_PREF_MIN_INT=12 +CONFIG_BT_PERIPHERAL_PREF_MAX_INT=24 +CONFIG_BT_PERIPHERAL_PREF_LATENCY=30 +#Misc configuration CONFIG_USB_DEVICE_VID=0x29EA CONFIG_USB_DEVICE_PID=0x0362 CONFIG_USB_DEVICE_MANUFACTURER="Kinesis Corporation" -CONFIG_BT_DIS_MANUF="Kinesis Corporation" - +CONFIG_ZMK_HID_REPORT_TYPE_NKRO=y +CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_BASIC=y CONFIG_BUILD_OUTPUT_UF2=y diff --git a/config/boards/arm/adv360/adv360_pinctrl.dtsi b/config/boards/arm/adv360/adv360_pinctrl.dtsi new file mode 100644 index 0000000000..7dafcdcecf --- /dev/null +++ b/config/boards/arm/adv360/adv360_pinctrl.dtsi @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2023 The ZMK Contributors + * SPDX-License-Identifier: MIT + */ + +&pinctrl { + spi3_default: spi3_default { + group1 { + psels = ; + }; + }; + + spi3_sleep: spi3_sleep { + group1 { + psels = ; + low-power-enable; + }; + }; + pwm0_default: pwm0_default { + group1 { + psels = ; + }; + }; + pwm0_sleep: pwm0_sleep { + group1 { + psels = ; + low-power-enable; + }; + }; +}; \ No newline at end of file diff --git a/config/boards/arm/adv360/adv360_right.dts b/config/boards/arm/adv360/adv360_right.dts index 36f4966c11..b7d96787e4 100644 --- a/config/boards/arm/adv360/adv360_right.dts +++ b/config/boards/arm/adv360/adv360_right.dts @@ -11,43 +11,33 @@ - kscan0: kscan { - compatible = "zmk,kscan-gpio-matrix"; - label = "KSCAN"; - - diode-direction = "col2row"; - row-gpios - = <&gpio0 19 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio0 5 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio0 31 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio0 30 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - , <&gpio0 29 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> - ; - - col-gpios - = <&gpio0 12 GPIO_ACTIVE_HIGH> - , <&gpio1 9 GPIO_ACTIVE_HIGH> - , <&gpio0 7 GPIO_ACTIVE_HIGH> - , <&gpio1 11 GPIO_ACTIVE_HIGH> - , <&gpio1 10 GPIO_ACTIVE_HIGH> - , <&gpio1 13 GPIO_ACTIVE_HIGH> - , <&gpio1 15 GPIO_ACTIVE_HIGH> - , <&gpio0 3 GPIO_ACTIVE_HIGH> - , <&gpio0 2 GPIO_ACTIVE_HIGH> - , <&gpio0 28 GPIO_ACTIVE_HIGH> - ; - }; - - leds { - compatible = "gpio-leds"; - blue_led: led_0 { - gpios = <&gpio0 15 GPIO_ACTIVE_HIGH>; - label = "Blue LED"; - }; - }; - + kscan0: kscan { + compatible = "zmk,kscan-gpio-matrix"; + + diode-direction = "col2row"; + row-gpios + = <&gpio0 19 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 5 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 31 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 30 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&gpio0 29 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + ; + + col-gpios + = <&gpio0 12 GPIO_ACTIVE_HIGH> + , <&gpio1 9 GPIO_ACTIVE_HIGH> + , <&gpio0 7 GPIO_ACTIVE_HIGH> + , <&gpio1 11 GPIO_ACTIVE_HIGH> + , <&gpio1 10 GPIO_ACTIVE_HIGH> + , <&gpio1 13 GPIO_ACTIVE_HIGH> + , <&gpio1 15 GPIO_ACTIVE_HIGH> + , <&gpio0 3 GPIO_ACTIVE_HIGH> + , <&gpio0 2 GPIO_ACTIVE_HIGH> + , <&gpio0 28 GPIO_ACTIVE_HIGH> + ; + }; }; &default_transform { - col-offset = <10>; - }; + col-offset = <10>; + }; diff --git a/config/boards/arm/adv360/adv360_right_defconfig b/config/boards/arm/adv360/adv360_right_defconfig index dd4a9a1ca0..f1eb05f35a 100644 --- a/config/boards/arm/adv360/adv360_right_defconfig +++ b/config/boards/arm/adv360/adv360_right_defconfig @@ -1,14 +1,11 @@ # -# Copyright (c) 2021 Polarity Works +# Copyright (c) 2022 The ZMK Contributors # SPDX-License-Identifier: MIT # CONFIG_SOC_SERIES_NRF52X=y CONFIG_SOC_NRF52840_QIAA=y CONFIG_BOARD_ADV360_RIGHT=y -CONFIG_ZMK_BLE=y -CONFIG_ZMK_SPLIT=y - # Enable MPU CONFIG_ARM_MPU=y @@ -16,9 +13,8 @@ CONFIG_ARM_MPU=y # enable GPIO CONFIG_GPIO=y - - -# Enable SPI +# Enable SPI for LEDS +CONFIG_PINCTRL=y CONFIG_SPI=y CONFIG_SPI_NRFX=y @@ -33,27 +29,28 @@ CONFIG_FLASH_MAP=y # Enable 32kHz crystal CONFIG_CLOCK_CONTROL_NRF_K32SRC_XTAL=y -CONFIG_CLOCK_CONTROL_NRF_K32SRC_500PPM=y +CONFIG_CLOCK_CONTROL_NRF_K32SRC_150PPM=y +#RGB leds config +CONFIG_WS2812_STRIP=y CONFIG_ZMK_RGB_UNDERGLOW=y CONFIG_ZMK_RGB_UNDERGLOW_EXT_POWER=y CONFIG_ZMK_RGB_UNDERGLOW_ON_START=y CONFIG_ZMK_RGB_UNDERGLOW_EFF_START=4 CONFIG_ZMK_RGB_UNDERGLOW_AUTO_OFF_IDLE=y -# Use the STRIP config specific to the LEDs you're using -CONFIG_WS2812_STRIP=y -CONFIG_BT_CTLR_TX_PWR_PLUS_8=y +#Backlighting configuration CONFIG_PWM=y CONFIG_LED_PWM=y CONFIG_ZMK_BACKLIGHT=y +CONFIG_ZMK_BACKLIGHT_BRT_START=20 CONFIG_ZMK_BACKLIGHT_AUTO_OFF_IDLE=y -CONFIG_ZMK_HID_REPORT_TYPE_NKRO=y -CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_BASIC=y - +#Misc configuration CONFIG_USB_DEVICE_VID=0x29EA CONFIG_USB_DEVICE_PID=0x0362 CONFIG_USB_DEVICE_MANUFACTURER="Kinesis Corporation" - +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y +CONFIG_ZMK_HID_REPORT_TYPE_NKRO=y +CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_BASIC=y CONFIG_BUILD_OUTPUT_UF2=y diff --git a/config/boards/arm/adv360/board.cmake b/config/boards/arm/adv360/board.cmake index 4eb48208af..34652907dc 100644 --- a/config/boards/arm/adv360/board.cmake +++ b/config/boards/arm/adv360/board.cmake @@ -1,5 +1,5 @@ # -# Copyright (c) 2021 Polarity Works +# Copyright (c) 2022 The ZMK Contributors # SPDX-License-Identifier: MIT # diff --git a/config/boards/arm/adv360/macros.dtsi b/config/boards/arm/adv360/macros.dtsi new file mode 100644 index 0000000000..69f6c4f3ab --- /dev/null +++ b/config/boards/arm/adv360/macros.dtsi @@ -0,0 +1,36 @@ + macro_quotes: macro_quotes { + compatible = "zmk,behavior-macro"; + label = "macro_quotes"; + #binding-cells = <0>; + bindings = <&kp SQT>, <&kp SQT>, <&kp LEFT>; + }; + macro_dquotes: macro_dquotes { + compatible = "zmk,behavior-macro"; + label = "macro_dquotes"; + #binding-cells = <0>; + bindings = <&kp DQT>, <&kp DQT>, <&kp LEFT>; + }; + macro_braces: macro_braces { + compatible = "zmk,behavior-macro"; + label = "macro_braces"; + #binding-cells = <0>; + bindings = <&kp LBRC>, <&kp RBRC>, <&kp LEFT>; + }; + macro_parens: macro_parens { + compatible = "zmk,behavior-macro"; + label = "macro_parens"; + #binding-cells = <0>; + bindings = <&kp LPAR>, <&kp RPAR>, <&kp LEFT>; + }; + macro_brackets: macro_brackets { + compatible = "zmk,behavior-macro"; + label = "macro_brackets"; + #binding-cells = <0>; + bindings = <&kp LBKT>, <&kp RBKT>, <&kp LEFT>; + }; + macro_kinesis: macro_kinesis { + compatible = "zmk,behavior-macro"; + label = "macro_kinesis"; + #binding-cells = <0>; + bindings = <&kp K>, <&kp I>, <&kp N>, <&kp E>, <&kp S>, <&kp I>, <&kp S>; + }; diff --git a/config/keymap.json b/config/keymap.json index c740e08884..86b8982a7f 100644 --- a/config/keymap.json +++ b/config/keymap.json @@ -30,9 +30,9 @@ ], [ "&none ", "&bt BT_SEL 0 ", "&bt BT_SEL 1 ", "&bt BT_SEL 2 ", "&bt BT_SEL 3 ", "&bt BT_SEL 4 ", "&none ", "&trans ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&bootloader ", "&bootloader ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", - "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&rgb_ug RGB_MEFS_CMD 5 ", "&none", "&bt BT_CLR ", "&bt BT_CLR ", "&bt BT_CLR ", "&rgb_ug RGB_MEFS_CMD 5 ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", - "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", - "&none ", "&none ", "&none ", "&bl BL_INC ", "&bl BL_DEC ", "&none ", "&bl BL_TOG ", "&none ", "&none ", "&bl BL_TOG ", "&rgb_ug RGB_TOG ", "&bl BL_INC ", "&bl BL_DEC ", "&none ", "&none ", "&none" + "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", "&none ", "&bt BT_CLR ", "&none ", "&rgb_ug RGB_MEFS_CMD 5 ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", + "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none ", "&none", + "&none ", "&none ", "&none ", "&none ", "&none ", "&none", "&none", "&none ", "&none ", "&bl BL_TOG ", "&rgb_ug RGB_TOG ", "&bl BL_INC ", "&bl BL_DEC ", "&none ", "&none ", "&none" ] ] } diff --git a/config/west.yml b/config/west.yml index bf3935ad9d..3d195d83e0 100644 --- a/config/west.yml +++ b/config/west.yml @@ -7,7 +7,7 @@ manifest: projects: - name: zmk remote: refil - revision: adv360-z3 + revision: adv360-z3.2 import: app/west.yml self: path: config diff --git a/settings-reset.uf2 b/settings-reset.uf2 index 6a2b426837..f3109d640e 100644 Binary files a/settings-reset.uf2 and b/settings-reset.uf2 differ