add backtick quotes for code snippets
* 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
xs5871
parent
1985712637
commit
dfa73a8cca
@ -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*)
|
||||
@ -13,20 +13,20 @@ 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|
|
||||
|---------------------------------------------------------|-----------------------------------------------------------------|
|
||||
|`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:
|
||||
|
||||
@ -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())
|
||||
@ -8,13 +11,13 @@ 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 |
|
||||
|---------------------|--------------------------------------|
|
||||
| `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 |
|
||||
|
||||
@ -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 |
|
||||
|-----------------|------------------------------------------|
|
||||
|
||||
|---------------------|------------------------------------------|
|
||||
| `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 |
|
||||
|
||||
@ -5,31 +5,31 @@
|
||||
This board adapts the pinout of a Circuit Python compatible [Adafruit ItsyBitsy M4 Express](https://www.adafruit.com/product/3800) to that of the [SparkFun Pro Micro](https://www.sparkfun.com/products/12640) to allow the ItsyBitsy to be used with the many keyboards that support the footprint of the Pro Micro.
|
||||
|
||||
## Pin mapping
|
||||
Pro Micro Pin | ItsyBitsy Pin
|
||||
------------ | -------------
|
||||
TX0/PD3 | TX
|
||||
RX1/PD2 | RX
|
||||
GND | GND
|
||||
GND | GND
|
||||
2/PD1 | SDA
|
||||
3/PD0 | SCL
|
||||
4/PD4 | D13
|
||||
5/PC6 | D12
|
||||
6/PD7 | D11
|
||||
7/PE6 | D10
|
||||
8/PB4 | D9
|
||||
9/PB5 | D7
|
||||
Raw |
|
||||
GND | GND
|
||||
RST | RST
|
||||
VCC | USB
|
||||
A3/PF4 | A0
|
||||
A2/PF5 | A1
|
||||
A1/PF6 | A2
|
||||
A0/PF7 | A3
|
||||
15/PB1 | A4
|
||||
14/PB3 | A5
|
||||
16/PB2 | SCK
|
||||
| Pro Micro Pin | ItsyBitsy Pin |
|
||||
|-----------------|-----------------|
|
||||
| `TX0/PD3` | `TX` |
|
||||
| `RX1/PD2` | `RX` |
|
||||
| `GND` | `GND` |
|
||||
| `GND` | `GND` |
|
||||
| `2/PD1` | `SDA` |
|
||||
| `3/PD0` | `SCL` |
|
||||
| `4/PD4` | `D13` |
|
||||
| `5/PC6` | `D12` |
|
||||
| `6/PD7` | `D11` |
|
||||
| `7/PE6` | `D10` |
|
||||
| `8/PB4` | `D9` |
|
||||
| `9/PB5` | `D7` |
|
||||
| `Raw` | |
|
||||
| `GND` | `GND` |
|
||||
| `RST` | `RST` |
|
||||
| `VCC` | `USB` |
|
||||
| `A3/PF4` | `A0` |
|
||||
| `A2/PF5` | `A1` |
|
||||
| `A1/PF6` | `A2` |
|
||||
| `A0/PF7` | `A3` |
|
||||
| `15/PB1` | `A4` |
|
||||
| `14/PB3` | `A5` |
|
||||
| `16/PB2` | `SCK` |
|
||||
|
||||
|
||||
## So how do I use it?
|
||||
|
||||
Loading…
Reference in New Issue
Block a user