README.md

   1 TMK Keyboard Firmware Collection
   2 ================================
   3 This repository includes keyboard and converter firmware projects built with [`tmk_core`][tmk_core] keyboard library.
   4
   5 The latest source code is available here: <http://github.com/tmk/tmk_keyboard>
   6
   7
   8 Updates
   9 -------
  10 #### 2016/06/22
  11 Some projects were moved from `converter` and `keyboard` to `orphan` directory. Those might be removed in some future but you will be able to access them with `orphans` tag. See <https://github.com/tmk/tmk_keyboard/issues/173>
  12
  13 #### 2016/02/10
  14 core: flabbergast's Chibios protocol was merged from <https://github.com/flabbergast/tmk_keyboard/tree/chibios> (@72b1668). See [tmk_core/protocol/chibios/README.md](tmk_core/protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis.
  15
  16 #### 2015/04/22
  17 Core library was separated to other branch `core`. <https://github.com/tmk/tmk_keyboard/tree/core>
  18
  19 In `Makefile` you need to set `TMK_DIR` to indicate core library location now.
  20
  21     TMK_DIR = ../../tmk_core
  22
  23
  24
  25 Projects
  26 --------
  27 You can find some keyboard specific projects under `converter` and `keyboard` directory.
  28
  29 ### converter
  30 * [ps2_usb](converter/ps2_usb/)             - [PS/2 keyboard to USB][GH_ps2]
  31 * [adb_usb](converter/adb_usb/)             - [ADB keyboard to USB][GH_adb]
  32 * [m0110_usb](converter/m0110_usb)          - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
  33 * [terminal_usb](converter/terminal_usb/)   - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
  34 * [news_usb](converter/news_usb/)           - [Sony NEWS keyboard to USB][GH_news]
  35 * [x68k_usb](converter/x68k_usb/)           - [Sharp X68000 keyboard to USB][GH_x68k]
  36 * [sun_usb](converter/sun_usb/)             - [Sun] to USB(type4, 5 and 3?)
  37 * [pc98_usb](converter/pc98_usb/)           - [PC98] to USB
  38 * [usb_usb](converter/usb_usb/)             - [USB to USB][GH_usb]
  39 * [ibm4704_usb](converter/ibm4704_usb)      - [IBM 4704 keyboard to USB][GH_ibm4704]
  40 * [next_usb](converter/next_usb)            - NeXT(Non-ADB) to USB, contributed by [BCG](https://github.com/bgould) and based on [Adafruit's work](https://learn.adafruit.com/usb-next-keyboard-with-arduino-micro/overview)
  41
  42 ### keyboard
  43 * [hhkb](keyboard/hhkb/)                    - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
  44 * [alps64](keyboard/alps64/)                - [Alps64 PCB](https://geekhack.org/index.php?topic=69740.0)
  45 * [hbkb](keyboard/hbkb/)                    - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
  46 * [Infinity](keyboard/infinity/)            - Massdrop [Infinity keyboard][Infinity]
  47 * [gh60](keyboard/gh60/)                    - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
  48 * [onekey](keyboard/onekey/)                - Simple one key keyboard example
  49
  50
  51 ### Projects based tmk_keyboard or tmk_core
  52 https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects
  53
  54
  55 [GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
  56 [GH_ps2]:       http://geekhack.org/showwiki.php?title=Island:14618
  57 [GH_adb]:       http://geekhack.org/showwiki.php?title=Island:14290
  58 [GH_hhkb_bt]:   http://geekhack.org/showwiki.php?title=Island:20851
  59 [GH_m0110]:     http://geekhack.org/showwiki.php?title=Island:24965
  60 [GH_news]:      http://geekhack.org/showwiki.php?title=Island:25759
  61 [GH_terminal]:  http://geekhack.org/showwiki.php?title=Island:27272
  62 [GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
  63 [GH_hbkb]:      http://geekhack.org/showwiki.php?title=Island:29483
  64 [GH_ibm4704]:   http://geekhack.org/index.php?topic=54706.0
  65 [GH60]:         http://geekhack.org/index.php?topic=34959
  66 [GH60_proto]:   http://geekhack.org/index.php?topic=37570.0
  67 [PC98]:         http://en.wikipedia.org/wiki/NEC_PC-9801
  68 [Sun]:          http://en.wikipedia.org/wiki/Sun-3
  69 [Infinity]:     https://www.massdrop.com/buy/infinity-keyboard-kit
  70
  71
  72
  73 License
  74 -------
  75 **GPLv2** or later. Some protocol files are under **Modified BSD License**.
  76
  77 Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
  78
  79
  80
  81 Build Firmware and Program Controller
  82 -------------------------------------
  83 See [tmk_core/doc/build.md](tmk_core/doc/build.md).
  84
  85
  86
  87 Change your keymap
  88 ------------------
  89 See [tmk_core/doc/keymap.md](tmk_core/doc/keymap.md).
  90
  91
  92
  93 Magic Commands
  94 --------------
  95 To see help press `Magic` + `H`.
  96
  97 `Magic` key combination is `LShift` + `RShift` in many projects, but `Power` key on ADB converter.
  98 `Magic` keybind can be vary on each project, check `config.h` in project directory.
  99
 100 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
 101
 102     ----- Command Help -----
 103     c:      enter console mode
 104     d:      toggle debug enable
 105     x:      toggle matrix debug
 106     k:      toggle keyboard debug
 107     m:      toggle mouse debug
 108     v:      print device version & info
 109     t:      print timer count
 110     s:      print status
 111     e:      print eeprom config
 112     n:      toggle NKRO
 113     0/F10:  switch to Layer0
 114     1/F1:   switch to Layer1
 115     2/F2:   switch to Layer2
 116     3/F3:   switch to Layer3
 117     4/F4:   switch to Layer4
 118     PScr:   power down/remote wake-up
 119     Caps:   Lock Keyboard(Child Proof)
 120     Paus:   jump to bootloader
 121
 122
 123
 124 Boot Magic Configuration - Virtual DIP Switch
 125 ---------------------------------------------
 126 Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
 127 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.
 128
 129 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).
 130
 131 #### General
 132 - Skip reading EEPROM to start with default configuration(`ESC`)
 133 - Clear configuration stored in EEPROM to reset configuration(`Backspace`)
 134
 135 #### Bootloader
 136 - Kick up Bootloader(`B`)
 137
 138 #### Debug
 139 - Debug enable(`D`)
 140 - Debug matrix enable(`D`+`X`)
 141 - Debug keyboard enable(`D`+`K`)
 142 - Debug mouse enable(`D`+`M`)
 143
 144 #### Keymap
 145 - Swap Control and CapsLock(`Left Control`)
 146 - Change CapsLock to Control(`Caps Lock`)
 147 - Swap LeftAlt and Gui(`Left Alt`)
 148 - Swap RightAlt and Gui(`Right Alt`)
 149 - Disable Gui(`Left Gui`)
 150 - Swap Grave and Escape(`Grave`)
 151 - Swap BackSlash and BackSpace(`Back Slash`)
 152 - Enable NKRO on boot(`N`)
 153
 154 #### Default Layer
 155 - Set Default Layer to 0(`0`)
 156 - Set Default Layer to 1(`1`)
 157 - Set Default Layer to 2(`2`)
 158 - Set Default Layer to 3(`3`)
 159 - Set Default Layer to 4(`4`)
 160 - Set Default Layer to 5(`5`)
 161 - Set Default Layer to 6(`6`)
 162 - Set Default Layer to 7(`7`)
 163
 164
 165
 166 Mechanical Locking support
 167 --------------------------
 168 This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
 169 or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
 170 UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
 171 ync option tries to keep switch state consistent with keyboard LED state.
 172
 173     #define LOCKING_SUPPORT_ENABLE
 174     #define LOCKING_RESYNC_ENABLE
 175
 176
 177
 178 Start Your Own Project
 179 -----------------------
 180 1. Add `tmk_core` into your repository using `git submodule` or `git subtree`.
 181 2. Copy files from `tmk_keybaord` or other project similar to yours
 182 3. Edit those files to support your keyboard.
 183
 184 See these as examples.
 185 - https://github.com/tmk/infinity_ergodox
 186 - https://github.com/tmk/whitefox
 187
 188
 189
 190 Debugging
 191 --------
 192 Use PJRC's `hid_listen` to see debug messages. You can use xprintf() to display debug info, see `tmk_core/common/xprintf.h`.
 193
 194 - https://www.pjrc.com/teensy/hid_listen.html
 195
 196
 197
 198 Files and Directories
 199 -------------------
 200 ### Top
 201 * keyboard/     - keyboard projects
 202 * converter/    - protocol converter projects
 203 * tmk_core/     - core library
 204 * tmk_core/doc/ - documents
 205
 206
 207
 208 Contribution
 209 ------------
 210 - Report bugs in github **[Issues](https://github.com/tmk/tmk_keyboard/issues)**.
 211 - Pull requets are also welcomed.
 212
 213
 214
 215 Coding Style
 216 -------------
 217 - Doesn't use Tab to indent, use 4-spaces instead.
 218
 219
 220
 221 Other Keyboard Firmware Projects
 222 ------------------
 223 You can learn a lot about keyboard firmware from these. See [Other Projects](https://github.com/tmk/tmk_keyboard/wiki/Other-Projects) other than TMK.