urob / adv360-demo-config

ZMK configuration for Advantage 360 pro
19 stars 49 forks source link
advantage-360 zmk zmk-config

[!IMPORTANT] Many of the issues motivating this repo have recently been addressed by version 3.0 of the official repo. I am therefore retiring this repo. Going forward, I recommend using the official configuration from Kinesis as this repo won't be updated anymore to incorporate new ZMK features.

Demo config for Kinesis Advantage 360 pro

This is a variation of the official ZMK configuration for the Advantage 360 pro. It contains a few tweaks that I find useful and may provide a good starting point for further customization.

To build upon this configuration, simply fork this repo to your Github Account. The firmware will then be automatically (re-)build by Github whenever you make changes to the configuration, and can be downloaded from the Github Actions tab.

The main differences of this repo compared to the official Kinesis configuration are as follows:

Latest ZMK firmware with various experimental features

The firmware in this repo is configured to be compiled using my adv360 branch of the ZMK firmware. Compared to the branch used by the official Kinesis repo, it features the following enhancements:

Alternate matrix-transform

The board definition in the official repo includes a few keys reserved for the optional Kinesis foot pedal. For users without the pedal, this requires adding several placeholder keys in the layout.

To streamline the layout configuration, this repo provides an optional alternate matrix transform that eliminates all unused keys. The alternate transform also moves the thumb cluster to the bottom of the layout, which I have found easier to read.

Specifically, the alternate layout looks as follows:

 ╭────────────────────────────┬────────────────────────────╮
 │  0   1   2   3   4   5   6 │  7   8   9  10  11  12  13 │
 │ 14  15  16  17  18  19  20 │ 21  22  23  24  25  26  27 │
 │ 28  29  30  31  32  33  34 │ 35  36  37  38  39  40  41 │
 │ 42  43  44  45  46  47 ╭───┴───╮ 48  49  50  51  52  53 │
 │ 54  55  56  57  58╭────╯       ╰────╮59  60  61  62  63 │
 ╰───────────────────┼────────┬────────┼───────────────────╯
                 ╭───╯ 64  65 │ 66  67 ╰───╮
                 │ 68  69  70 │ 71  72  73 │
                 ╰───────╮ 74 │ 75 ╭───────╯
                         ╰────┴────╯

To use the alternate layout, add the following lines to the keymap file. See the keymap file for a complete configuration example.

\ {
    chosen {
        zmk,matrix_transform = &urobs_transform;
    };
};

Standard ZMK build routine

I have replaced the custom make script used by Kinesis with a more standard ZMK build routine. In other words, this configuration now behaves exactly like any other ZMK configuration. While not necessarily better, this makes it a bit easier to use the excellent ZMK documentation and get help from the wonderful ZMK community.

LED status indicators

LED status indicators are currently not officially supported by ZMK. To increase compatibility with standard ZMK, I therefore dropped support for the LED status indicators from the main branch of this repo.

The led branch of this repo includes experimental LED support by building against a version of ZMK that has been patched with experimental code developed by Kinesis. Note that this code is highly customized and is not compatible with most other ZMK keyboards. It is therefore unlikely that the ZMK community will be able to help troubleshooting.

It is also possible to switch LED support on and off by switching between adv360 and adv360-led on line 10 of config/west.yml.

User config

Finally, I have moved the board definition files from the user repo to the ZMK branch, and added a few tweaks to the keymap. I also added "colemak" and "mouse" layers to the keymap to give some example for how to customize the layout and how to set up the mouse movement and keys.