forked from kofal.net/zmk
refactor(docs): Change behavior to behaviors
Makes a better URL.
This commit is contained in:
innovaker
Pete Johanson
@@ -25,7 +25,7 @@ Rotation is handled separately as a type of sensor. The behavior for this is set
|
||||
sensor-bindings = <BINDING CW_KEY CCW_KEY>;
|
||||
```
|
||||
|
||||
- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behavior/key-press) for details on available keycodes).
|
||||
- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behaviors/key-press) for details on available keycodes).
|
||||
- `CW_KEY` is the keycode activated by a clockwise turn.
|
||||
- `CCW_KEY` is the keycode activated by a counter-clockwise turn.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ For example, the simplest behavior in ZMK is the "key press" behavior, which res
|
||||
(a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and
|
||||
when the key position is released, updates the host to notify of the keycode being released.
|
||||
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior.
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
|
||||
|
||||
## Layers
|
||||
|
||||
@@ -148,7 +148,7 @@ Each layer should have:
|
||||
1. A `bindings` property this will be a list of behaviour bindings, one for each key position for the keyboard.
|
||||
1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way)
|
||||
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behavior/key-press) behavior.
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
|
||||
|
||||
### Complete Example
|
||||
|
||||
|
||||
@@ -11,32 +11,32 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time
|
||||
|
||||
ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:
|
||||
|
||||
| **Feature** | ZMK | BlueMicro | QMK |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
|
||||
| Low Latency BLE Support | ✅ | ✅ | |
|
||||
| Multi-Device BLE Support | ✅ | | |
|
||||
| [USB Connectivity](behavior/outputs) | ✅ | | ✅ |
|
||||
| User Configuration Repositories | ✅ | | |
|
||||
| Split Keyboard Support | ✅ | ✅ | ✅ |
|
||||
| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ |
|
||||
| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ |
|
||||
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
|
||||
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
||||
| [Encoders](features/encoders)[^1] | ✅ | | ✅ |
|
||||
| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
|
||||
| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
|
||||
| One Shot Keys | 🚧 | ✅ | ✅ |
|
||||
| Combo Keys | 🚧 | | ✅ |
|
||||
| Macros | 🚧 | ✅ | ✅ |
|
||||
| Mouse Keys | | ✅ | ✅ |
|
||||
| Low Active Power Usage | ✅ | | |
|
||||
| [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | |
|
||||
| [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | |
|
||||
| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | |
|
||||
| Shell over BLE | | | |
|
||||
| Realtime Keymap Updating | 💡 | | ✅ |
|
||||
| AVR/8 Bit | | | ✅ |
|
||||
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
|
||||
| **Feature** | ZMK | BlueMicro | QMK |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
|
||||
| Low Latency BLE Support | ✅ | ✅ | |
|
||||
| Multi-Device BLE Support | ✅ | | |
|
||||
| [USB Connectivity](behaviors/outputs) | ✅ | | ✅ |
|
||||
| User Configuration Repositories | ✅ | | |
|
||||
| Split Keyboard Support | ✅ | ✅ | ✅ |
|
||||
| [Keymaps and Layers](behaviors/layers) | ✅ | ✅ | ✅ |
|
||||
| [Hold-Tap](behaviors/hold-tap) (which includes [Mod-Tap](behaviors/mod-tap) and [Layer-Tap](behaviors/layers/#layer-tap)) | ✅ | ✅ | ✅ |
|
||||
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
|
||||
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
||||
| [Encoders](features/encoders)[^1] | ✅ | | ✅ |
|
||||
| [OLED Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
|
||||
| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
|
||||
| One Shot Keys | 🚧 | ✅ | ✅ |
|
||||
| Combo Keys | 🚧 | | ✅ |
|
||||
| Macros | 🚧 | ✅ | ✅ |
|
||||
| Mouse Keys | | ✅ | ✅ |
|
||||
| Low Active Power Usage | ✅ | | |
|
||||
| [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | |
|
||||
| [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | |
|
||||
| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | |
|
||||
| Shell over BLE | | | |
|
||||
| Realtime Keymap Updating | 💡 | | ✅ |
|
||||
| AVR/8 Bit | | | ✅ |
|
||||
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
|
||||
|
||||
[^2]: Encoders are not currently supported on peripheral side splits.
|
||||
[^1]: OLEDs are currently proof of concept in ZMK.
|
||||
|
||||
Reference in New Issue
Block a user