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

add backtick quotes for code snippets

Browse Source 
* Added for keycodes, pin numbers, and code snippets. Mostly in tables.
* Enhance documentation readability
* Make automated spell checking easier - aspell automatically ignores these snippets
* fix invalid markdown table in mouse_keys.md
This commit is contained in:
Ryan Rotter
2022-04-24 13:46:49 -05:00
committed by xs5871
parent 1985712637
commit dfa73a8cca
5 changed files with 69 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/adns9800.md
View File

@@ -5,7 +5,7 @@ from kmk.modules.adns9800 import ADNS9800
keyboard.modules.append(ADNS9800(cs=board.GP0, sclk=board.GP2, miso=board.GP4, mosi=board.GP3, invert_y=True))
```
Firmware for this sensor has to be obtained separately and placed in kmk\modules\adns9800_firmware.py
Firmware for this sensor has to be obtained separately and placed in `kmk\modules\adns9800_firmware.py`
```python
firmware = (
b'\x03'
@@ -15,4 +15,5 @@ firmware = (
```
## Constructor parameters
ADNS9800(cs=*cs_pin*, sclk=*clock_pin*, miso=*miso_pin*, mosi=*mosi_pin*, invert_x=*False*, invert_y=*False*)
ADNS9800(cs=*cs_pin*, sclk=*clock_pin*, miso=*miso_pin*, mosi=*mosi_pin*, invert_x=*False*, invert_y=*False*)

30
docs/modtap.md
View File

@@ -12,21 +12,21 @@ keyboard.modules.append(modtap)
## Keycodes
|New Keycode | Description |
|-------------------------------------------------------|-----------------------------------------------------------------|
|LCTL = KC.MT(KC.SOMETHING, KC.LCTRL) |`LCTRL` if held `kc` if tapped |
|LSFT = KC.MT(KC.SOMETHING, KC.LSFT) |`LSHIFT` if held `kc` if tapped |
|LALT = KC.MT(KC.SOMETHING, KC.LALT) |`LALT` if held `kc` if tapped |
|LGUI = KC.MT(KC.SOMETHING, KC.LGUI) |`LGUI` if held `kc` if tapped |
|RCTL = KC.MT(KC.SOMETHING, KC.RCTRL) |`RCTRL` if held `kc` if tapped |
|RSFT = KC.MT(KC.SOMETHING, KC.RSFT) |`RSHIFT` if held `kc` if tapped |
|RALT = KC.MT(KC.SOMETHING, KC.RALT) |`RALT` if held `kc` if tapped |
|RGUI = KC.MT(KC.SOMETHING, KC.RGUI) |`RGUI` if held `kc` if tapped |
|SGUI = KC.MT(KC.SOMETHING, KC.LSHFT(KC.LGUI)) |`LSHIFT` and `LGUI` if held `kc` if tapped |
|LCA = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT)) |`LCTRL` and `LALT` if held `kc` if tapped |
|LCAG = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT(KC.LGUI))) |`LCTRL` and `LALT` and `LGUI` if held `kc` if tapped |
|MEH = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LSFT(KC.LALT))) |`CTRL` and `LSHIFT` and `LALT` if held `kc` if tapped |
|HYPR = KC.MT(KC.SOMETHING, KC.HYPR) |`LCTRL` and `LSHIFT` and `LALT` and `LGUI` if held `kc` if tapped|
|New Keycode | Description |
|---------------------------------------------------------|-----------------------------------------------------------------|
|`LCTL = KC.MT(KC.SOMETHING, KC.LCTRL)` |`LCTRL` if held `kc` if tapped |
|`LSFT = KC.MT(KC.SOMETHING, KC.LSFT)` |`LSHIFT` if held `kc` if tapped |
|`LALT = KC.MT(KC.SOMETHING, KC.LALT)` |`LALT` if held `kc` if tapped |
|`LGUI = KC.MT(KC.SOMETHING, KC.LGUI)` |`LGUI` if held `kc` if tapped |
|`RCTL = KC.MT(KC.SOMETHING, KC.RCTRL)` |`RCTRL` if held `kc` if tapped |
|`RSFT = KC.MT(KC.SOMETHING, KC.RSFT)` |`RSHIFT` if held `kc` if tapped |
|`RALT = KC.MT(KC.SOMETHING, KC.RALT)` |`RALT` if held `kc` if tapped |
|`RGUI = KC.MT(KC.SOMETHING, KC.RGUI)` |`RGUI` if held `kc` if tapped |
|`SGUI = KC.MT(KC.SOMETHING, KC.LSHFT(KC.LGUI))` |`LSHIFT` and `LGUI` if held `kc` if tapped |
|`LCA = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT))` |`LCTRL` and `LALT` if held `kc` if tapped |
|`LCAG = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT(KC.LGUI)))` |`LCTRL` and `LALT` and `LGUI` if held `kc` if tapped |
|`MEH = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LSFT(KC.LALT)))` |`CTRL` and `LSHIFT` and `LALT` if held `kc` if tapped |
|`HYPR = KC.MT(KC.SOMETHING, KC.HYPR)` |`LCTRL` and `LSHIFT` and `LALT` and `LGUI` if held `kc` if tapped|
## Custom HoldTap Behavior
The full ModTap signature is as follows:

27
docs/mouse_keys.md
View File

@@ -1,5 +1,8 @@
# Mouse keys
To enable mouse cursor and/or mouse buttons control from the keyboard add this module to list:
To enable mouse cursor and/or mouse buttons control from the keyboard add this
module to list:
```python
from kmk.modules.mouse_keys import MouseKeys
keyboard.modules.append(MouseKeys())
@@ -7,14 +10,14 @@ keyboard.modules.append(MouseKeys())
# Keycodes
|Keycode | Description |
|---------------|---------------------------|
|MB_LMB |Left mouse button |
|MB_RMB |Right mouse button |
|MB_MMB |Middle mouse button |
|MW_UP |Mouse wheel up |
|MW_DOWN, MW_DN |Mouse wheel down |
|MS_UP |Move mouse cursor up |
|MS_DOWN, MS_DN |Move mouse cursor down |
|MS_LEFT, MS_LT |Move mouse cursor left |
|MS_RIGHT, MS_RT|Move mouse cursor right |
| Keycode | Description |
|---------------------|--------------------------------------|
| `MB_LMB` | Left mouse button |
| `MB_RMB` | Right mouse button |
| `MB_MMB` | Middle mouse button |
| `MW_UP` | Mouse wheel up |
| `MW_DOWN`, `MW_DN` | Mouse wheel down |
| `MS_UP` | Move mouse cursor up |
| `MS_DOWN`, `MS_DN` | Move mouse cursor down |
| `MS_LEFT`, `MS_LT` | Move mouse cursor left |
| `MS_RIGHT`, `MS_RT` | Move mouse cursor right |

25
docs/ptBR/mouse_keys.md
View File

@@ -10,17 +10,14 @@ keyboard.modules.append(MouseKeys())
# Keycodes
|-----------------|------------------------------------------|
| Keycode | Descrição |
|-----------------|------------------------------------------|
| MB_LMB | Botão esquerdo do mouse |
| MB_RMB | Botão direito do mouse |
| MB_MMB | Botão do meio do mouse |
| MW_UP | Rolar o scroll para cima |
| MW_DOWN, MW_DN | Rolar o scroll para baixo |
| MS_UP | Mover o cursor do mouse para cima |
| MS_DOWN, MS_DN | Mover o cursor do mouse para baixo |
| MS_LEFT, MS_LT | Mover o cursor do mouse para a esquerdax |
| MS_RIGHT, MS_RT | Mover o cursor do mouse para a direita |
|-----------------|------------------------------------------|
| Keycode | Descrição |
|---------------------|------------------------------------------|
| `MB_LMB` | Botão esquerdo do mouse |
| `MB_RMB` | Botão direito do mouse |
| `MB_MMB` | Botão do meio do mouse |
| `MW_UP` | Rolar o scroll para cima |
| `MW_DOWN`, `MW_DN` | Rolar o scroll para baixo |
| `MS_UP` | Mover o cursor do mouse para cima |
| `MS_DOWN`, `MS_DN` | Mover o cursor do mouse para baixo |
| `MS_LEFT`, `MS_LT` | Mover o cursor do mouse para a esquerdax |
| `MS_RIGHT`, `MS_RT` | Mover o cursor do mouse para a direita |