The ZMK documentation 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
- If you would like to continue using GitHub we recommend using Nick Coutsos’s keymap editor: https://nickcoutsos.github.io/keymap-editor/.
- If you would prefer to leave GitHub and firmware flashing behind you can perform a one-time firmware update to gain access to Clique. Get started here: https://kinesis-ergo.com/360p-clique-upgrade/.
The Kinesis GUI doesn't seem to be supported anymore. I have found this UI very useful.
Certain ZMK features (e.g. combos) require knowing the exact key positions in the matrix. They can be found in both image and text format here
- Fork this repo.
- Enable GitHub Actions on your fork.
- Push a commit to trigger the build.
- Download the artifact.
- Either Podman or Docker is required, Podman is chosen if both are installed.
- Make is also required
- If compiling on Windows use WSL2 and Docker Docker Setup Guide.
- Install make using
sudo apt-get install makeinside the WSL2 instance. - The repository can be cloned directly into the WSL2 instance or accessed through the C: mount point WSL provides by default (
/mnt/c/path-to-repo).
On macOS brew can be used to install the required components.
- docker
- colima can be used as the docker engine
brew install docker colima
colima startNote: On Apple Silicon (ARM based) systems you need to make sure to start colima with the correct architecture for the container being used.
colima start --arch x86_64
sudo apt-get install docker make- Execute
maketo build firmware for both halves ormake leftto only build firmware for the left hand side. - Check the
firmwaredirectory for the latest firmware build. The first part of the filename is the timestamp when the firmware was built.
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.
Creating the docker container takes some time. Therefore make clean_firmware can be used to only clean firmware without removing the docker container. Similarly make clean_image can be used to remove the docker container without removing compiled firmware files.
Follow the programming instruction on page 8 of the Quick Start Guide to flash the firmware.
- Extract the firmwares from the archive downloaded from the GitHub build job (If using the cloud builder) or the firmware folder (If building locally).
- Connect the left side keyboard to USB.
- Press Mod+macro1 to put the left side into bootloader mode; it should attach to your computer as a USB drive.
- Copy
left.uf2to the USB drive and it will disconnect. - Power off both keyboards (by unplugging them and making sure the switches are off).
- Turn on the left side keyboard with the switch.
- Connect the right side keyboard to USB to power it on.
- Press Mod+macro3 to put the right side into bootloader mode to attach it as a USB drive.
- Copy
right.uf2to the mounted drive. - Unplug the right side keyboard and turn it back on.
- Enjoy!
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 and use is described in section 5.9 on page 14.
Note: Some operating systems wont always treat the drive as ejected after the settings-reset file is flashed or may throw a spurious error, this doesn't mean that the flashing process has failed.
- Obtain the desired Advantage360 Pro firmware files (“.uf2” format) from GitHub or Kinesis
- Connect the left module to your PC using the included USB cable. Then disconnect and power down the right module.
- Use a paperclip to quickly DOUBLE-CLICK the Bootloader Button shown on the left module to open the virtual drive. The Indicator LEDs with flash white and then change to solid green. The “ADV360PRO” removable drive will appear on your PC in the “file explorer” application (or equivalent).
- Copy and paste the left firmware file to the “ADV360PRO” drive. The keyboard will flash blue while installing the file and then disconnect the drive automatically.
- Turn the left module battery on and disconnect it from the PC. Work quickly and do not allow the left module to fall asleep while you are updating the right side (you can tap the Fn key on the left module to reset the 30 second sleep timer).
- Now connect the right module to your PC with the USB cable and repeat steps 3 and 4 with right module and the right firmware file.
- Once the right side stops flashing blue, hold the Mod key down and confirm both Layer LEDs light up green to confirm the keyboard is working properly.
- If the keyboard is not working after an update, power-cycle both modules several times.
- If it still doesn’t work, try again flashing the appropriate Settings Reset for the destination branch to both modules and then start back at Step 2.
- ALWAYS connect/power-on the LEFT module FIRST, and disconnect/power-down the LEFT module LAST. You NEVER want the RIGHT side to lose track of the LEFT and flash red.
- The timing of the double-click on the Bootloader button can be tricky, so it may take a couple tries.
- If you don’t have a paperclip, you can use the shortcuts Mod + Hotkey 1 (left module) and Mod + Hotkey 3 (right module) to open the virtual drives.
- Do not open both virtual drives at once as it will be difficult to distinguish between them and you might install the wrong file on the wrong drive.
- Keystrokes and bootloader commands are disabled while the virtual drives are open or after a Settings Reset has been performed.
- Drives can only be updated over USB so you’ll need one of the included USB-C cables. Attempting to open the drive without a USB connection with result in an error. Click the bootloader button once or simply connect the keyboard to your computer with the USB cable.
- Firmware files always come in a matched set of left and right files. Both should be installed on their respective module consecutively. Do not install them on the wrong key module.
- Do not unplug your keyboard during a firmware update (while the LEDs are flashing blue)
- You can safely ignore “drive eject” warnings on macOS.
- As of 11-16-23, firmware files generated on GitHub will have unique file names containing the build date and commit number. The command Mod + V can be used to print-to-screen a “hash” with your firmware build date, branch number, and commit number.
If you encounter a git conflict when updating your repository to V3.0 please follow the instructions on how to resolve it here.
Updating from V2.0 based firmwares to V3.0 based firmwares can be a rather complex process. There are reset files for every major firmware revision as well as documentation on the update process available here.
Starting on 11/15/2023 the Advantage 360 Pro will now automatically record the compilation date, branch and Git commit hash in a macro that can be accessed with Mod+V. This will type out the following string: YYYYMMDD-XXXX-YYYYYY, where XXXX is the first 4 characters of the Git branch and YYYYYY is the Git commit hash. In addition to this the builds compiled by GitHub actions are now timestamped and also record the commit hash in the filename.
By default this keyboard has NKRO enabled, however for compatibility reasons the higher ranges are not enabled. If you want to use F13-F24 or the INTL1-9 keys with NKRO enabled you can change CONFIG_ZMK_HID_KEYBOARD_EXTENDED_REPORT=n to CONFIG_ZMK_HID_KEYBOARD_EXTENDED_REPORT=y in adv360_left_defconfig
By default reporting the battery level over BLE is disabled as this can cause some computers to spontaneously wake up repeatedly. If you'd like to enable this functionality change CONFIG_BT_BAS=n to CONFIG_BT_BAS=y in adv360_left_defconfig.
The color of the CAPS/NUM/SCROLL LOCK indicator LEDs may be configured by specifying a hexadecimal RGB color code. For example, CONFIG_ZMK_RGB_UNDERGLOW_MOD_COLOR=0xFF0000 would give red indicator colors. In order to set the indicator color on both modules, ensure that both adv360_left_defconfig and adv360_right_defconfig have been updated.
A total of 32 layers are supported by ZMK, with the highest currently active layer displayed using the layer LEDs on each of the left and right modules. All possible colors are listed below; for the first 8 layers the same color is displayed on both modules. After that, only the right module color will cycle through until "rolling over", which will cause the left module color to change as well (and this then repeats). To avoid confusion, the black/off LED color is only used for layer 0.
| Layer # | L/R | Layer # | L/R | Layer # | L/R | Layer # | L/R |
|---|---|---|---|---|---|---|---|
| 0 |  |
8 |   |
16 |  |
24 |   |
| 1 | |
9 | |
17 |  |
25 |  |
| 2 | |
10 | |
18 | |
26 | |
| 3 | |
11 | |
19 | |
27 | |
| 4 | |
12 | |
20 | |
28 | |
| 5 | |
13 | |
21 | |
29 | |
| 6 | |
14 | |
22 | |
30 | |
| 7 | |
15 | |
23 | |
31 | |
The changelog for both the config repo and the underlying ZMK fork that the config repo builds against can be found here.
The Advantage 360 Pro is always getting updates and refinements. If you are willing to beta test you can follow this guide from ZMK on how to change where your config repo points to. The west.yml file that is mentioned is located in config/. This link can take you to the file. Typically you will only need to change the revision: to match the beta branch. There is currently no beta branch available for testing.
Feedback on beta branches should be submitted as a GitHub issue on the base ZMK repository as opposed to this config repository.
In the event of a major update the beta branch may not be compatible with the current mainline version of the config repository. If this is the case it will be detailed here along with instructions on how to update.
By default this config repository references a customised version of ZMK with Advantage 360 Pro specific functionality and changes over base 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, some features such as new keycodes will not be immediately available on the 360 Pro after they are implemented in base ZMK.
Whilst the Advantage 360 Pro is compatible with base ZMK (The pull request to merge it can be seen here if you want to see how to implement it) some of the more advanced features (the indicator RGB leds) 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.
Further support resources can be found on Kinesis.com:
- https://kinesis-ergo.com/support/kb360pro/#firmware-updates
- https://kinesis-ergo.com/support/kb360pro/#manuals
In the event of a hardware issue it may be necessary to open a support ticket directly with Kinesis as opposed to a GitHub issue in this repository.