diff --git a/README.md b/README.md index 2500787c64..1ecd6eee79 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,26 @@ By default this keyboard has NKRO enabled, however for compatibility reasons the ## Battery reporting -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). Please note that a known bug in windows prevents the battery level from updating by default, it is only updated when the board is paired. A workaround is to set `CONFIG_BT_GATT_ENFORCE_SUBSCRIPTION=n` in [adv360_left_defconfig](/config/boards/arm/adv360/adv360_left_defconfig). This may cause unexpected results on other OSes +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). Please note that a known bug in windows prevents the battery level from updating by default, it is only updated when the board is paired. A workaround is to set `CONFIG_BT_GATT_ENFORCE_SUBSCRIPTION=n` in [adv360_left_defconfig](/config/boards/arm/adv360/adv360_left_defconfig). This may cause unexpected results on other OSes. + +## Modifier indicator color + +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. + +## Layer colors + +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 | | ## Changelog @@ -117,7 +136,7 @@ The changelog for both the config repo and the underlying ZMK fork that the conf 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. The current beta branch is [adv360-z3.2-beta](https://github.com/ReFil/zmk/tree/adv360-z3.2-beta) which is compatible with V3.0 config repositories however users must [disable BT privacy](#bluetooth-le-privacy). -Feedback on beta branches should be submitted as a GitHub issue on the base ZMK repository as opposed to this config repository +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. @@ -136,3 +155,4 @@ Further support resources can be found on Kinesis.com: 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. * https://kinesis-ergo.com/support/kb360pro/#ticket + diff --git a/assets/swatches/000000.svg b/assets/swatches/000000.svg new file mode 100644 index 0000000000..9d14efad13 --- /dev/null +++ b/assets/swatches/000000.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/0000FF.svg b/assets/swatches/0000FF.svg new file mode 100644 index 0000000000..d445b5429f --- /dev/null +++ b/assets/swatches/0000FF.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/00FF00.svg b/assets/swatches/00FF00.svg new file mode 100644 index 0000000000..f8b4ce0caf --- /dev/null +++ b/assets/swatches/00FF00.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/00FFFF.svg b/assets/swatches/00FFFF.svg new file mode 100644 index 0000000000..4813df5e09 --- /dev/null +++ b/assets/swatches/00FFFF.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/FF0000.svg b/assets/swatches/FF0000.svg new file mode 100644 index 0000000000..3026c7eea3 --- /dev/null +++ b/assets/swatches/FF0000.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/FF00FF.svg b/assets/swatches/FF00FF.svg new file mode 100644 index 0000000000..81f6c6a5da --- /dev/null +++ b/assets/swatches/FF00FF.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/FFFF00.svg b/assets/swatches/FFFF00.svg new file mode 100644 index 0000000000..1fa8992213 --- /dev/null +++ b/assets/swatches/FFFF00.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/swatches/FFFFFF.svg b/assets/swatches/FFFFFF.svg new file mode 100644 index 0000000000..d54a1321ee --- /dev/null +++ b/assets/swatches/FFFFFF.svg @@ -0,0 +1 @@ + \ No newline at end of file