Merge branch 'main' of https://github.com/zmkfirmware/zmk into main
This commit is contained in:
commit
6b23c7f554
8 changed files with 24 additions and 11 deletions
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
|
@ -25,6 +25,8 @@ jobs:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- name: Cache west modules
|
- name: Cache west modules
|
||||||
|
timeout-minutes: 2
|
||||||
|
continue-on-error: true
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v2
|
||||||
env:
|
env:
|
||||||
cache-name: cache-zephyr-modules
|
cache-name: cache-zephyr-modules
|
||||||
|
|
|
@ -193,6 +193,10 @@ source "subsys/logging/Kconfig.template.log_config"
|
||||||
|
|
||||||
rsource "boards/Kconfig"
|
rsource "boards/Kconfig"
|
||||||
rsource "boards/shields/*/Kconfig.defconfig"
|
rsource "boards/shields/*/Kconfig.defconfig"
|
||||||
|
rsource "boards/shields/*/Kconfig.shield"
|
||||||
|
|
||||||
|
osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.defconfig"
|
||||||
|
osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.shield"
|
||||||
|
|
||||||
source "Kconfig.zephyr"
|
source "Kconfig.zephyr"
|
||||||
|
|
||||||
|
|
|
@ -44,6 +44,7 @@ endif()
|
||||||
set(CACHED_ZMK_CONFIG ${ZMK_CONFIG} CACHE STRING "Selected user ZMK config")
|
set(CACHED_ZMK_CONFIG ${ZMK_CONFIG} CACHE STRING "Selected user ZMK config")
|
||||||
|
|
||||||
if (ZMK_CONFIG)
|
if (ZMK_CONFIG)
|
||||||
|
set(ENV{ZMK_CONFIG} "${ZMK_CONFIG}")
|
||||||
if(EXISTS ${ZMK_CONFIG}/boards)
|
if(EXISTS ${ZMK_CONFIG}/boards)
|
||||||
message(STATUS "Adding ZMK config directory as board root: ${ZMK_CONFIG}")
|
message(STATUS "Adding ZMK config directory as board root: ${ZMK_CONFIG}")
|
||||||
list(APPEND BOARD_ROOT ${ZMK_CONFIG})
|
list(APPEND BOARD_ROOT ${ZMK_CONFIG})
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Key Presses
|
title: Key Press Behaviors
|
||||||
|
sidebar_label: Key Press
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Layers
|
title: Layer Behaviors
|
||||||
|
sidebar_label: Layers
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
@ -56,12 +57,13 @@ Example:
|
||||||
```
|
```
|
||||||
|
|
||||||
"Toggle layer" for a :
|
"Toggle layer" for a :
|
||||||
|
|
||||||
```
|
```
|
||||||
#define DEFAULT 0
|
#define DEFAULT 0
|
||||||
#define NAVI 1
|
#define NAVI 1
|
||||||
|
|
||||||
#define NONE 0
|
#define NONE 0
|
||||||
|
|
||||||
/ {
|
/ {
|
||||||
keymap {
|
keymap {
|
||||||
compatible = "zmk,keymap";
|
compatible = "zmk,keymap";
|
||||||
|
@ -89,4 +91,4 @@ Example:
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
It is possible to use "toggle layer" to have keys that raise and lower the layers as well.
|
It is possible to use "toggle layer" to have keys that raise and lower the layers as well.
|
||||||
|
|
|
@ -1,15 +1,16 @@
|
||||||
---
|
---
|
||||||
title: Lighting
|
title: Lighting Behavior
|
||||||
|
sidebar_label: Lighting
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark.
|
Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark.
|
||||||
Currently ZMK supports RGB underglow, which can be changed and configured using its behavior.
|
Currently ZMK supports RGB underglow, which can be changed and configured using its behavior.
|
||||||
|
|
||||||
## RGB Action Defines
|
## RGB Action Defines
|
||||||
|
|
||||||
RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header,
|
RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header,
|
||||||
which is added at the top of the keymap file:
|
which is added at the top of the keymap file:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -21,7 +22,7 @@ This will allow you to reference the actions defined in this header such as `RGB
|
||||||
Here is a table describing the action for each define:
|
Here is a table describing the action for each define:
|
||||||
|
|
||||||
| Define | Action |
|
| Define | Action |
|
||||||
|-----------|-----------------------------------------------------------|
|
| --------- | --------------------------------------------------------- |
|
||||||
| `RGB_TOG` | Toggles the RGB feature on and off |
|
| `RGB_TOG` | Toggles the RGB feature on and off |
|
||||||
| `RGB_HUI` | Increases the hue of the RGB feature |
|
| `RGB_HUI` | Increases the hue of the RGB feature |
|
||||||
| `RGB_HUD` | Decreases the hue of the RGB feature |
|
| `RGB_HUD` | Decreases the hue of the RGB feature |
|
||||||
|
@ -47,4 +48,4 @@ Example:
|
||||||
|
|
||||||
```
|
```
|
||||||
&rgb_ug RGB_TOG
|
&rgb_ug RGB_TOG
|
||||||
```
|
```
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Miscellaneous
|
title: Miscellaneous Behaviors
|
||||||
|
sidebar_label: Miscellaneous
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Mod-Tap
|
title: Mod-Tap Behavior
|
||||||
|
sidebar_label: Mod-Tap
|
||||||
---
|
---
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
Loading…
Reference in a new issue