add keycodes and assembling guide

Author: xiongyihui

docs/assembling.md

@@ -0,0 +1,19 @@
+# Assembling
+
+1. Make sure the M60 keyboard is powered off
+
+2. Attach the provided 2.4GHz and NFC cabled PCB antennas to the nRF52840 M.2 module as shown in the figure below:
+
+	![Attaching Antennas](https://wiki.makerdiary.com/nrf52840-m2-devkit/assets/images/attaching-antennas-to-m2.webp)
+
+3. Insert the module into the connector as shown in the figure below:
+
+	!!! Warning "Angle of Insertion"
+		Angled insertion is allowable and preferred to minimize the insertion force. The angle of insertion is **5° ~ 25°**, **typically 20°**.
+	
+	![Module Insertion](https://wiki.makerdiary.com/nrf52840-m2-devkit/assets/images/m2-module-insertion.png)
+
+4. Secure the module using the provided mounting screw as shown in the figure below:
+
+	![Secure the module](https://wiki.makerdiary.com/nrf52840-m2-devkit/assets/images/secure-m2-module-screw.png)
+

docs/keycodes.md

@@ -0,0 +1,301 @@
+
+
+ Name         | Description
+--------------|--------------------
+`NO`          | Do nothing
+`TRANSPARENT` | Use the key of next active layer
+
+## Bluetooth
+
+ Name         | Description
+--------------|-------------------
+`BT0` ~ `BT9` | Switch to Bluetooth ID n (0 - 9)
+`BT_TOGGLE`   | Toggle Bluetooth
+
+## USB
+
+ Name         | Description
+--------------|-------------------
+`USB_TOGGLE`  | Toggle USB
+
+!!! note
+    When connecting the keyboard to a computer via USB, USB will be enabled automatically.
+    When both USB and Bluetooth are enabled, USB will be used.
+
+## System
+
+ Name         | Description
+--------------|-----------------------------------------
+`BOOTLOADER`  | Enter the bootloader of the keyboard
+`HEATMAP`     | Generate heatmap (todo)
+`SUSPEND`     | Suspend. To wake up keyboard, just press any key
+`SHUTDOWN`    | Shutdown. Use ON/OFF button to power on the keyboard
+
+## Layer & Modifier
+
++ `MODS_KEY(mods, key)` sends one or more modifier(s) + a normal key. `MODS()` is used to wrap modifiers.
+
+  `MODS_KEY(MODS(LCTRL), C)`, `MODS_KEY(MODS(LCTRL, LSHIFT), C)`, `MODS_KEY(MODS(LCTRL, LSHIFT, LALT), C)`
+
++ `LAYER_TOGGLE(n)` toggles layer `n`
+
++ `MACRO(n)` creates macro `n`
+
+### TAP-Key
+
+`TAP-Key` has 2 modes - tap (press and release quickly) and hold (long press)
+
++ `LAYER_TAP(n, key)` tap - outputs `key`, hold - turns on layer n momentary
+
++ `LAYER_TAP_TOGGLE(n)` tap - toggles layer n, hold - turns on layer n momentary
+
++ `LAYER_MODS(n, mods)` tap - outputs specified modifier(s), hold - turns on layer n momentary
+
+  `LAYER_MODS(1, MODS(LCTRL))`, `LAYER_MODS(1, MODS(LCTRL, LSHIFT))`
+
++ `MODS_TAP(mods, key)` tap - outputs `key`, hold - outputs specified modifier(s)
+
+  `MODS_TAP(MODS(LCTRL), ';')`, `MODS_TAP(MODS(LCTRL, LALT), LEFT)`
+
+
+## APP & Media
+
+```
+AUDIO_MUTE
+AUDIO_VOL_UP
+AUDIO_VOL_DOWN
+TRANSPORT_NEXT_TRACK
+TRANSPORT_PREV_TRACK
+TRANSPORT_STOP
+TRANSPORT_STOP_EJECT
+TRANSPORT_PLAY_PAUSE
+# application launch
+APPLAUNCH_CC_CONFIG
+APPLAUNCH_EMAIL
+APPLAUNCH_CALCULATOR
+APPLAUNCH_LOCAL_BROWSER
+# application control
+APPCONTROL_SEARCH
+APPCONTROL_HOME
+APPCONTROL_BACK
+APPCONTROL_FORWARD
+APPCONTROL_STOP
+APPCONTROL_REFRESH
+APPCONTROL_BOOKMARKS
+# supplement for Bluegiga iWRAP HID(not supported by Windows?)
+APPLAUNCH_LOCK
+TRANSPORT_RECORD
+TRANSPORT_FAST_FORWARD
+TRANSPORT_REWIND
+TRANSPORT_EJECT
+APPCONTROL_MINIMIZE
+# https://docs.microsoft.com/en-us/windows-hardware/drivers/hid/display-brightness-control
+DISPLAY_BRIGHTNESS_UP
+DISPLAY_BRIGHTNESS_DOWN
+```
+
+## Nomal keys
+
+```
+A
+B
+C
+D
+E
+F
+G
+H
+I
+J
+K
+L
+M
+N
+O
+P
+Q
+R
+S
+T
+U
+V
+W
+X
+Y
+Z
+
+1
+2
+3
+4
+5
+6
+7
+8
+9
+0
+
+ENTER
+ESCAPE
+ESC
+BACKSPACE
+TAB
+SPACE
+MINUS
+EQUAL
+LEFTBRACE
+RIGHTBRACE
+BACKSLASH
+HASHTILDE
+SEMICOLON
+APOSTROPHE
+QUOTE
+GRAVE
+COMMA
+DOT
+SLASH
+CAPSLOCK
+CAPS
+
+F1
+F2
+F3
+F4
+F5
+F6
+F7
+F8
+F9
+F10
+F11
+F12
+
+PRINTSCREEN
+PRTSCN
+SCROLLLOCK
+PAUSE
+INSERT
+HOME
+PAGEUP
+PGUP
+DELETE
+DEL
+END
+PAGEDOWN
+PGDN
+RIGHT
+LEFT
+DOWN
+UP
+
+NUMLOCK
+KPSLASH
+KPASTERISK
+KPMINUS
+KPPLUS
+KPENTER
+KP1
+KP2
+KP3
+KP4
+KP5
+KP6
+KP7
+KP8
+KP9
+KP0
+KPDOT
+
+# 102ND
+APPLICATION
+MENU
+POWER
+KPEQUAL
+
+F13
+F14
+F15
+F16
+F17
+F18
+F19
+F20
+F21
+F22
+F23
+F24
+
+OPEN
+HELP
+# PROPS
+SELECT
+STOP
+AGAIN
+UNDO
+CUT
+COPY
+PASTE
+FIND
+MUTE
+KPCOMMA
+
+INT1
+INT2
+INT3
+INT4
+INT5
+INT6
+INT7
+INT8
+INT9
+
+RO
+KATAKANAHIRAGANA
+YEN
+HENKAN
+MUHENKAN
+KPJPCOMMA
+
+LANG1
+LANG2
+LANG3
+LANG4
+LANG5
+LANG6
+LANG7
+LANG8
+LANG9
+
+HANGEUL
+HANJA
+KATAKANA
+HIRAGANA
+ZENKAKUHANKAKU
+
+KPLEFTPAREN
+KPRIGHTPAREN
+
+LEFT_CTRL
+LEFT_SHIFT
+LEFT_ALT
+LEFT_GUI
+RIGHT_CTRL
+RIGHT_SHIFT
+RIGHT_ALT
+RIGHT_GUI
+
+LCTRL
+LSHIFT
+LALT
+LGUI
+RCTRL
+RSHIFT
+RALT
+RGUI
+
+CTRL
+SHIFT
+ALT
+GUI
+```
+

docs/upgrade_firmware.md

@@ -1,21 +1,37 @@
 # Upgrade Firmware
 
 The keyboard has a built-in bootloader to upgrade its firmware.
-When the bootloader is running, a USB drive named `M60Keyboard` will appear in your computer.
-Download the latest `.uf2` firmware, drag-n-drop the firmware into the USB drive, then wait until a new USB drive named `CIRCUITPY` appears.
+
+## Check Current Firmware Version
+
+To check the information of the firmware, just open the `boot_out.txt` file in the USB storage of the keyboard. The file contains the version and the compiled date of the firmware:
+
+```
+Adafruit CircuitPython 6.0.0-alpha.1-110-g121d78ec9 on 2020-08-27; Makerdiary M60 Keyboard with nRF52840
+```
+
+If you find a newer firmware (file with `.uf2` extension) in [python-keyboard / firmware](https://github.com/makerdiary/python-keyboard/tree/zh-cn/firmware), you could do an upgrade.
+
 
 ## Enter Bootloader
 
-There are several ways to run into the bootloader:
+There are 4 ways to run into the bootloader:
 
-1. When USB is connected, press <kbd>Fn</kbd> + <kbd>b</kbd> to enter the bootloader
-2. When USB is connected, hold the ON/OFF button for 3 seconds to enter the bootloader
-3. When in Python REPL mode, run:
+1.  When USB is connected, press <kbd>Fn</kbd> + <kbd>b</kbd> to enter the bootloader
 
-   ```python
-   import microcontroller as mcu
-   mcu.on_next_reset(mcu.RunMode.BOOTLOADER)
-   mcu.reset()
-   ```
+2.  When USB is connected, hold the ON/OFF button for 3 seconds to enter the bootloader
 
-4. When battery is not attached, hold the ON/OFF button and power on the keyboard with USB.
+3.  When in Python REPL mode, run:
+
+    ```python
+    import microcontroller as mcu
+    mcu.on_next_reset(mcu.RunMode.BOOTLOADER)
+    mcu.reset()
+    ```
+
+4.  When battery is not attached, hold the ON/OFF button and power on the keyboard with USB.
+
+## Upgrade
+
+When the bootloader is running, a USB drive named `M60Keyboard` will appear in your computer.
+Download the latest `.uf2` firmware, drag-n-drop the firmware into the USB drive, then wait until a new USB drive named `CIRCUITPY` appears.

mkdocs.yml

@@ -130,8 +130,10 @@ markdown_extensions:
 # Page tree
 nav:
   - Introduction: index.md
+  - Assembling: assembling.md
   - Getting started: getting-started.md
   - Configuration: configuration.md
+  - Keycodes: keycodes.md
   - Macro: macro.md
   - Pair-Keys: pair-keys.md
   - Upgrade: upgrade_firmware.md