You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-25Lines changed: 28 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,8 @@
4
4
5
5
[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)
6
6
7
-
There is a web based GUI available 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 however they may have keycodes or behaviours that are not implemented on the 360 Pro and could cause unusual behaviour or build failures. Furthermore changes made on other keymap editors may not be compatible if one goes back to using the Kinesis GUI.
7
+
- If you would like to continue using GitHub we recommend using Nick Coutsos’s keymap editor: <https://nickcoutsos.github.io/keymap-editor/>.
8
+
- 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/>.
8
9
9
10
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](assets/key-positions.md)
10
11
@@ -26,27 +27,29 @@ Certain ZMK features (e.g. combos) require knowing the exact key positions in th
26
27
27
28
#### Software
28
29
29
-
* Either Podman or Docker is required, Podman is chosen if both are installed.
30
-
* Make is also required
30
+
- Either Podman or Docker is required, Podman is chosen if both are installed.
31
+
- Make is also required
31
32
32
33
#### Windows specific
33
34
34
-
* If compiling on Windows use WSL2 and Docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).
35
-
* Install make using `sudo apt-get install make` inside the WSL2 instance.
36
-
* 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`).
35
+
- If compiling on Windows use WSL2 and Docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).
36
+
- Install make using `sudo apt-get install make` inside the WSL2 instance.
37
+
- 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`).
37
38
38
39
#### macOS specific
39
40
40
41
On macOS [brew](https://brew.sh) can be used to install the required components.
41
42
42
-
* docker
43
-
*[colima](https://github.com/abiosoft/colima) can be used as the docker engine
43
+
- docker
44
+
-[colima](https://github.com/abiosoft/colima) can be used as the docker engine
44
45
45
46
```shell
46
47
brew install docker colima
47
48
colima start
48
49
```
50
+
49
51
> Note: On Apple Silicon (ARM based) systems you need to make sure to start colima with the correct architecture for the container being used.
52
+
>
50
53
> ```
51
54
> colima start --arch x86_64
52
55
> ```
@@ -86,7 +89,7 @@ Follow the programming instruction on page 8 of the [Quick Start Guide](https://
86
89
1. Unplug the right side keyboard and turn it back on.
87
90
1. Enjoy!
88
91
89
-
> 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.
92
+
> 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.
90
93
91
94
> 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.
92
95
@@ -98,15 +101,15 @@ Updating from V2.0 based firmwares to V3.0 based firmwares can be a rather compl
98
101
99
102
## Versioning
100
103
101
-
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.
104
+
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.
102
105
103
106
## N-Key Rollover
104
107
105
108
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](/config/boards/arm/adv360/adv360_left_defconfig#L65)
106
109
107
110
## Battery reporting
108
111
109
-
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](/config/boards/arm/adv360/adv360_left_defconfig#L58).
112
+
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](/config/boards/arm/adv360/adv360_left_defconfig#L58).
110
113
111
114
## Modifier indicator color
112
115
@@ -116,24 +119,24 @@ The color of the CAPS/NUM/SCROLL LOCK indicator LEDs may be configured by specif
116
119
117
120
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.
The changelog for both the config repo and the underlying ZMK fork that the config repo builds against can be found [here](CHANGELOG.md).
133
136
134
137
## Beta testing
135
138
136
-
The Advantage 360 Pro is always getting updates and refinements. If you are willing to beta test you can follow [this guide from ZMK](https://zmk.dev/docs/features/beta-testing#testing-features) on how to change where your config repo points to. The `west.yml` file that is mentioned is located in config/. [This link](config/west.yml) 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.
139
+
The Advantage 360 Pro is always getting updates and refinements. If you are willing to beta test you can follow [this guide from ZMK](https://zmk.dev/docs/features/beta-testing#testing-features) on how to change where your config repo points to. The `west.yml` file that is mentioned is located in config/. [This link](config/west.yml) 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.
137
140
138
141
Feedback on beta branches should be submitted as a GitHub issue on the base ZMK repository as opposed to this config repository.
139
142
@@ -149,9 +152,9 @@ Whilst the Advantage 360 Pro is compatible with base ZMK (The pull request to me
149
152
150
153
Further support resources can be found on Kinesis.com:
0 commit comments