sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #75 from KMKfw/topic-leader-docs

Browse Source 
Update docs for leader mode
This commit is contained in:
Josh Klar 2018-10-19 03:35:46 -07:00 committed by GitHub
commit ababc97167
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/leader.md
View File

@ -15,32 +15,56 @@ cancel the sequence.
```python ```python
from kmk.macros.simple import simple_key_sequence from kmk.macros.simple import simple_key_sequence
LEADER_DICTIONARY = { # ...
(KC.T, KC.A, KC.S, KC.K): simple_key_sequence(Modifiers.KC_LCTRL(Modifiers.KC_LSHIFT(Common.KC_ESC)))
keyboard.leader_dictionary = {
(KC.T, KC.A, KC.S, KC.K): simple_key_sequence([Modifiers.KC_LCTRL(Modifiers.KC_LSHIFT(Common.KC_ESC))])
} }
keymap = [...KC.LEAD,...] keymap = [...KC.LEAD,...]
# ...
``` ```
If defining tuples of keycodes is too obtuse for you, we have a convenience
function available for that, too!
```python
from kmk.keycodes import generate_leader_dictionary_seq as glds
# ...
keyboard.leader_dictionary = {
glds('task'): simple_key_sequence([Modifiers.KC_LCTRL(Modifiers.KC_LSHIFT(Common.KC_ESC))])
}
# ...
```
# Modes # Modes
Modes avaliable (WARNING: LeaderMode.ENTER is currently the only one avaliable.) 1. LeaderMode.TIMEOUT (the default)
1. LeaderMode.DEFAULT
2. LeaderMode.ENTER 2. LeaderMode.ENTER
### DEFAULT #WARNING# NOT AVALIBLE YET ### Timeout Mode
Will expire after a timer and trigger the sequence that matches if any. Will expire after a timer and trigger the sequence that matches if any.
This can be enabled with This can be enabled with
```python ```python
from kmk.consts.LederMode from kmk.consts import LeaderMode
leader_mode = LeaderMode.DEFAULT keyboard.leader_mode = LeaderMode.TIMEOUT
``` ```
The timeout can be set like this The timeout can be set like this
```python ```python
leader_timeout = 2000 keyboard.leader_timeout = 2000 # in milliseconds-ish
``` ```
### ENTER
The timeout defaults to `1000`, which is roughly a second.
### Enter Mode
Has no timeout. To end sequence press the enter key, or cancel and do nothing, press escape. Has no timeout. To end sequence press the enter key, or cancel and do nothing, press escape.
This can be enabled with This can be enabled with
from kmk.consts.LederMode ```python
leader_mode = LeaderMode.ENTER from kmk.consts import LeaderMode
keyboard.leader_mode = LeaderMode.ENTER
```

2
kmk/firmware.py
View File

@ -53,7 +53,7 @@ class Firmware:
unicode_mode = UnicodeModes.NOOP unicode_mode = UnicodeModes.NOOP
tap_time = 300 tap_time = 300
leader_mode = LeaderMode.ENTER leader_mode = LeaderMode.TIMEOUT
leader_dictionary = {} leader_dictionary = {}
leader_timeout = 1000 leader_timeout = 1000