README.md

   1 Quantum MK Firmware
   2 ================================
   3 This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controller, and more specifically, the OLKB product line.
   4
   5 Updates
   6 -------
   7 #### 2015/10/28
   8 Merged TMK updates from the past few months, and separately additions into /quantum. You can make a new quantum-based project by using `./new_project.sh <project_name>`, which will create /keyboard/<project_name>.
   9
  10 There are lots of new features, and they'll be documented soon.
  11
  12 #### 2015/04/22
  13 Core library was separated to other branch `core`. <https://github.com/tmk/tmk_keyboard/tree/core>
  14
  15 In `Makefile` you need to set `TMK_DIR` to indicate core library location now.
  16
  17     TMK_DIR = ../../tmk_core
  18
  19
  20
  21 Features
  22 --------
  23 These features can be used in your keyboard.
  24
  25 * Multi-layer Keymap  - Multiple keyboard layouts with layer switching
  26 * Mouse key           - Mouse control with keyboard
  27 * System Control Key  - Power Down, Sleep, Wake Up and USB Remote Wake up
  28 * Media Control Key   - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
  29 * USB NKRO            - 120 keys(+ 8 modifiers) simultaneously
  30 * PS/2 mouse support  - PS/2 mouse(TrackPoint) as composite device
  31 * Keyboard protocols  - PS/2, ADB, M0110, Sun and other old keyboard protocols
  32 * User Function       - Customizable function of key with writing code
  33 * Macro               - Very primitive at this time
  34 * Keyboard Tricks     - Oneshot modifier and modifier with tapping feature
  35 * Debug Console       - Messages for debug and interaction with firmware
  36 * Virtual DIP Switch  - Configurations stored EEPROM(Boot Magic)
  37 * Locking CapsLock    - Mechanical switch support for CapsLock
  38 * Breathing Sleep LED - Sleep indicator with charm during USB suspend
  39 * Backlight           - Control backlight levels
  40
  41
  42
  43 Projects
  44 --------
  45 You can find some keyboard specific projects under `converter` and `keyboard` directory.
  46
  47 ## Main projects
  48
  49 ### OLKB products
  50 * [planck](keyboard/planck/)                - [Planck] Ortholinear 40% keyboard
  51 * [preonic](keyboard/preonic/)              - [Preonic] Ortholinear 50% keyboard
  52 * [atomic](keyboard/atomic/)                - [Atomic] Ortholinear 60% keyboard
  53
  54 ### Ergodox EZ
  55 * [ergodox_ez](keyboard/ergodox_ez)         - [Ergodox_EZ] Assembled split keyboard
  56
  57 ## Other projects
  58
  59 ### converter
  60 * [ps2_usb](converter/ps2_usb/)             - [PS/2 keyboard to USB][GH_ps2]
  61 * [adb_usb](converter/adb_usb/)             - [ADB keyboard to USB][GH_adb]
  62 * [m0110_usb](converter/m0110_usb)          - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
  63 * [terminal_usb](converter/terminal_usb/)   - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
  64 * [news_usb](converter/news_usb/)           - [Sony NEWS keyboard to USB][GH_news]
  65 * [x68k_usb](converter/x68k_usb/)           - [Sharp X68000 keyboard to USB][GH_x68k]
  66 * [sun_usb](converter/sun_usb/)             - [Sun] to USB(type4, 5 and 3?)
  67 * [pc98_usb](converter/pc98_usb/)           - [PC98] to USB
  68 * [usb_usb](converter/usb_usb/)             - USB to USB(experimental)
  69 * [ascii_usb](converter/ascii_usb/)         - ASCII(Serial console terminal) to USB
  70 * [ibm4704_usb](converter/ibm4704_usb)      - [IBM 4704 keyboard Converter][GH_ibm4704]
  71
  72 ### keyboard
  73 * [hhkb](keyboard/hhkb/)                    - [Happy Hacking Keyboard pro][GH_hhkb] hasu's main board
  74 * [gh60](keyboard/gh60/)                    - [GH60] DIY 60% keyboard [prototype][GH60_proto] hasu's second board
  75 * [hbkb](keyboard/hbkb/)                    - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
  76 * [hid_liber](keyboard/hid_liber/)          - [HID liberation][HID_liber] controller (by alaricljs)
  77 * [phantom](keyboard/phantom/)              - [Phantom] keyboard (by Tranquilite)
  78 * [IIgs_Standard](keyboard/IIgs/)           - Apple [IIGS] keyboard mod(by JeffreySung)
  79 * [macway](keyboard/macway/)                - [Compact keyboard mod][GH_macway] [retired]
  80 * [KMAC](keyboard/kmac/)                    - Korean custom keyboard
  81 * [Lightsaber](keyboard/lightsaber/)        - Korean custom keyboard
  82 * [Infinity](keyboard/infinity/)            - Massdrop [Infinity keyboard][Infinity]
  83 * [NerD](keyboard/nerd/)                    - Korean custom keyboard
  84 * [KittenPaw](keyboard/kitten_paw)          - Custom Majestouch controller
  85 * [Lightpad](keyboard/lightpad)             - Korean custom keypad
  86 * [ghost_squid](keyboard/ghost_squid/)      - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
  87
  88 ### Extenal projects using tmk_keyboard
  89 * [ErgoDox_cub-uanic][cub-uanic]            - Split Ergonomic Keyboard [ErgoDox][ergodox_org]
  90 * [mcdox][mcdox_tmk]                        - [mcdox][mcdox]
  91
  92
  93 [GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
  94 [GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
  95 [GH_ps2]:       http://geekhack.org/showwiki.php?title=Island:14618
  96 [GH_adb]:       http://geekhack.org/showwiki.php?title=Island:14290
  97 [GH_hhkb_bt]:   http://geekhack.org/showwiki.php?title=Island:20851
  98 [GH_m0110]:     http://geekhack.org/showwiki.php?title=Island:24965
  99 [GH_news]:      http://geekhack.org/showwiki.php?title=Island:25759
 100 [GH_terminal]:  http://geekhack.org/showwiki.php?title=Island:27272
 101 [GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
 102 [GH_hbkb]:      http://geekhack.org/showwiki.php?title=Island:29483
 103 [GH_ibm4704]:   http://geekhack.org/index.php?topic=54706.0
 104 [HID_liber]:    http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
 105 [Phantom]:      http://geekhack.org/index.php?topic=26742
 106 [GH60]:         http://geekhack.org/index.php?topic=34959
 107 [GH60_proto]:   http://geekhack.org/index.php?topic=37570.0
 108 [PC98]:         http://en.wikipedia.org/wiki/NEC_PC-9801
 109 [Sun]:          http://en.wikipedia.org/wiki/Sun-3
 110 [IIGS]:         http://en.wikipedia.org/wiki/Apple_IIGS
 111 [Infinity]:     https://www.massdrop.com/buy/infinity-keyboard-kit
 112 [ghost_squid]:  http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
 113 [cmxt]:         http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
 114 [ergodox_org]:  http://ergodox.org/
 115 [cub-uanic]:    https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox
 116 [mcdox]:        https://github.com/DavidMcEwan/mcdox
 117 [mcdox_tmk]:    https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox
 118 [Planck]:       http://olkb.co/planck
 119 [Preonic]:      http://olkb.co/preonic
 120 [Atomic]:       http://olkb.co/atomic
 121 [Ergodox_EZ]:   https://www.indiegogo.com/projects/ergodox-ez-an-incredible-mechanical-keyboard
 122
 123
 124 License
 125 -------
 126 **GPLv2** or later. Some protocol files are under **Modified BSD License**.
 127
 128 Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
 129
 130
 131
 132 Build Firmware and Program Controller
 133 -------------------------------------
 134 See [doc/build.md](doc/build.md), or the README in the particular keyboard/* folder.
 135
 136
 137
 138 Change your keymap
 139 ------------------
 140 See [doc/keymap.md](doc/keymap.md).
 141
 142
 143
 144 Magic Commands
 145 --------------
 146 To see help press `Magic` + `H`.
 147
 148 `Magic` key combination is `LShift` + `RShift` in many project, but `Power` key on ADB converter.
 149 `Magic` keybind can be vary on each project, check `config.h` in project directory.
 150
 151 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
 152
 153     ----- Command Help -----
 154     c:      enter console mode
 155     d:      toggle debug enable
 156     x:      toggle matrix debug
 157     k:      toggle keyboard debug
 158     m:      toggle mouse debug
 159     v:      print device version & info
 160     t:      print timer count
 161     s:      print status
 162     e:      print eeprom config
 163     n:      toggle NKRO
 164     0/F10:  switch to Layer0
 165     1/F1:   switch to Layer1
 166     2/F2:   switch to Layer2
 167     3/F3:   switch to Layer3
 168     4/F4:   switch to Layer4
 169     PScr:   power down/remote wake-up
 170     Caps:   Lock Keyboard(Child Proof)
 171     Paus:   jump to bootloader
 172
 173
 174
 175 Boot Magic Configuration - Virtual DIP Switch
 176 ---------------------------------------------
 177 Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
 178 Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
 179
 180 To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [tmk_core/common/bootmagic.h](tmk_core/common/bootmagic.h).
 181
 182 #### General
 183 - Skip reading EEPROM to start with default configuration(`ESC`)
 184 - Clear configuration stored in EEPROM to reset configuration(`Backspace`)
 185
 186 #### Bootloader
 187 - Kick up Bootloader(`B`)
 188
 189 #### Debug
 190 - Debug enable(`D`)
 191 - Debug matrix enable(`D`+`X`)
 192 - Debug keyboard enable(`D`+`K`)
 193 - Debug mouse enable(`D`+`M`)
 194
 195 #### Keymap
 196 - Swap Control and CapsLock(`Left Control`)
 197 - Change CapsLock to Control(`Caps Lock`)
 198 - Swap LeftAlt and Gui(`Left Alt`)
 199 - Swap RightAlt and Gui(`Right Alt`)
 200 - Disable Gui(`Left Gui`)
 201 - Swap Grave and Escape(`Grave`)
 202 - Swap BackSlash and BackSpace(`Back Slash`)
 203 - Enable NKRO on boot(`N`)
 204
 205 #### Default Layer
 206 - Set Default Layer to 0(`0`)
 207 - Set Default Layer to 1(`1`)
 208 - Set Default Layer to 2(`2`)
 209 - Set Default Layer to 3(`3`)
 210 - Set Default Layer to 4(`4`)
 211 - Set Default Layer to 5(`5`)
 212 - Set Default Layer to 6(`6`)
 213 - Set Default Layer to 7(`7`)
 214
 215
 216
 217 Mechanical Locking support
 218 --------------------------
 219 This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
 220 or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
 221 UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
 222 ync option tries to keep switch state consistent with keyboard LED state.
 223
 224     #define LOCKING_SUPPORT_ENABLE
 225     #define LOCKING_RESYNC_ENABLE
 226
 227
 228
 229 Start Your Own Project
 230 -----------------------
 231 **TBD**
 232
 233
 234
 235 Debugging
 236 --------
 237 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
 238
 239 You can use xprintf() to display debug info on `hid_listen`, see `tmk_core/common/xprintf.h`.
 240
 241
 242
 243 Files and Directories
 244 -------------------
 245 ### Top
 246 * tmk_core/     - core library
 247 * keyboard/     - keyboard projects
 248 * converter/    - protocol converter projects
 249 * doc/          - documents
 250
 251
 252
 253 Coding Style
 254 -------------
 255 - Doesn't use Tab to indent, use 4-spaces instead.
 256
 257
 258
 259 Other Keyboard Firmware Projects
 260 ------------------
 261 You can learn a lot about keyboard firmware from these. See [doc/other_projects.md](doc/other_projects.md).