1 # girst's fork of evangs/tmk_keyboard
3 This repository contains my keymap for the Minivan (rev2) keyboard. After changing the layout to my pleasing, I've converted the layout to use `actionmaps` to support all my planned features. Then, I merged upstream fixes from `tmk/tmk_keyboard`, because I needed `ba2883f`. The version without merges from upstream is preserved at branch `evangs_firmware`.
7 ,-------------------------------------------------.
8 |Esc| Q| W| E| R| T| Z| U| I| O| P| BSp |
9 |-------------------------------------------------|
10 |Ctrl| A| S| D| F| G| H| J| K| L| ?/|Fn2 |
11 |-------------------------------------------------|
12 |Shift| Y| X| C| V| B| N| M| ,| .| -|Sft|
13 |-------------------------------------------------|
14 |Alt |Tab/Fn2|Fn1 |Enter| Space |Fn1 |Super| Fn3 |
15 `-------------------------------------------------'
17 Layer 1: Movement and Miscellaneous
18 ,-------------------------------------------------.
19 |Esc| |wrd| |End| | |PUp| |Hom|Ins| Del |
20 |-------------------------------------------------|
21 |Ctrl| | |PDn| | |Lft| Up| Dn| Rt| | |
22 |-------------------------------------------------|
23 |Shift|PSc| | | |bck| |Pau|NUM|CAP|SCR|Sft|
24 |-------------------------------------------------|
25 |Alt | | | | | |Super| |
26 `-------------------------------------------------'
28 Layer 2: Numbers and ASCII-Symbols
29 ,-------------------------------------------------.
30 | ^| !| "| '| $| %| &| @| (| )| =| BSp |
31 |-------------------------------------------------|
32 | `| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0|Fn2 |
33 |-------------------------------------------------|
34 | #| <| || >| +| *| {| [| ]| }| \| ~|
35 |-------------------------------------------------|
36 |Alt |Tab/Fn2| | | | |Super| |
37 `-------------------------------------------------'
39 Layer 3: Function Keys and Unicode Symbols
40 ,-------------------------------------------------.
41 | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11| F12|
42 |-------------------------------------------------|
43 |Ctrl| | | | | | | | Ä| Ö| Ü| |
44 |-------------------------------------------------|
45 |Shift| €| §| °| ²| ³| µ| ä| ö| ü| ß|Sft|
46 |-------------------------------------------------|
47 |Alt | | | | | |Super| Fn3 |
48 `-------------------------------------------------'
51 TMK Keyboard Firmware Collection
52 ================================
53 This repository includes keyboard and converter firmware projects built with [`tmk_core`][tmk_core] keyboard library.
55 The latest source code is available here: <http://github.com/tmk/tmk_keyboard>
61 Keymap framework was updated. `fn_actions[]` should be defined as `action_t` instead of `uint16_t`. And default code for keymap handling is now included in core you just need define `uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS]` and `action_t fn_actions[]`.
65 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>
68 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.
71 Core library was separated to other branch `core`. <https://github.com/tmk/tmk_keyboard/tree/core>
73 In `Makefile` you need to set `TMK_DIR` to indicate core library location now.
75 TMK_DIR = ../../tmk_core
81 You can find some keyboard specific projects under `converter` and `keyboard` directory.
84 * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
85 * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
86 * [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
87 * [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
88 * [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
89 * [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
90 * [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
91 * [pc98_usb](converter/pc98_usb/) - [PC98] to USB
92 * [usb_usb](converter/usb_usb/) - [USB to USB][GH_usb]
93 * [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard to USB][GH_ibm4704]
94 * [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)
97 * [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
98 * [alps64](keyboard/alps64/) - [Alps64 PCB](https://geekhack.org/index.php?topic=69740.0)
99 * [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
100 * [Infinity](keyboard/infinity/) - Massdrop [Infinity keyboard][Infinity]
101 * [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
102 * [onekey](keyboard/onekey/) - Simple one key keyboard example
105 ### Projects based tmk_keyboard or tmk_core
106 https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects
109 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
110 [GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
111 [GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
112 [GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
113 [GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
114 [GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
115 [GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
116 [GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
117 [GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
118 [GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0
119 [GH60]: http://geekhack.org/index.php?topic=34959
120 [GH60_proto]: http://geekhack.org/index.php?topic=37570.0
121 [PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
122 [Sun]: http://en.wikipedia.org/wiki/Sun-3
123 [Infinity]: https://www.massdrop.com/buy/infinity-keyboard-kit
124 [tmk_core]: https://github.com/tmk/tmk_core
130 **GPLv2** or later. Some protocol files are under **Modified BSD License**.
132 Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
136 Build Firmware and Program Controller
137 -------------------------------------
138 See [tmk_core/doc/build.md](tmk_core/doc/build.md).
144 See [tmk_core/doc/keymap.md](tmk_core/doc/keymap.md).
150 To see help press `Magic` + `H`.
152 `Magic` key combination is `LShift` + `RShift` in many projects, but `Power` key on ADB converter.
153 `Magic` keybind can be vary on each project, check `config.h` in project directory.
155 Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
157 ----- Command Help -----
158 c: enter console mode
159 d: toggle debug enable
160 x: toggle matrix debug
161 k: toggle keyboard debug
162 m: toggle mouse debug
163 v: print device version & info
166 e: print eeprom config
168 0/F10: switch to Layer0
169 1/F1: switch to Layer1
170 2/F2: switch to Layer2
171 3/F3: switch to Layer3
172 4/F4: switch to Layer4
173 PScr: power down/remote wake-up
174 Caps: Lock Keyboard(Child Proof)
175 Paus: jump to bootloader
179 Boot Magic Configuration - Virtual DIP Switch
180 ---------------------------------------------
181 Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
182 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.
184 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).
187 - Skip reading EEPROM to start with default configuration(`ESC`)
188 - Clear configuration stored in EEPROM to reset configuration(`Backspace`)
191 - Kick up Bootloader(`B`)
195 - Debug matrix enable(`D`+`X`)
196 - Debug keyboard enable(`D`+`K`)
197 - Debug mouse enable(`D`+`M`)
200 - Swap Control and CapsLock(`Left Control`)
201 - Change CapsLock to Control(`Caps Lock`)
202 - Swap LeftAlt and Gui(`Left Alt`)
203 - Swap RightAlt and Gui(`Right Alt`)
204 - Disable Gui(`Left Gui`)
205 - Swap Grave and Escape(`Grave`)
206 - Swap BackSlash and BackSpace(`Back Slash`)
207 - Enable NKRO on boot(`N`)
210 - Set Default Layer to 0(`0`)
211 - Set Default Layer to 1(`1`)
212 - Set Default Layer to 2(`2`)
213 - Set Default Layer to 3(`3`)
214 - Set Default Layer to 4(`4`)
215 - Set Default Layer to 5(`5`)
216 - Set Default Layer to 6(`6`)
217 - Set Default Layer to 7(`7`)
221 Mechanical Locking support
222 --------------------------
223 This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
224 or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
225 UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
226 ync option tries to keep switch state consistent with keyboard LED state.
228 #define LOCKING_SUPPORT_ENABLE
229 #define LOCKING_RESYNC_ENABLE
233 Start Your Own Project
234 -----------------------
235 1. Add `tmk_core` into your repository using `git submodule` or `git subtree`.
236 2. Copy files from `tmk_keybaord` or other project similar to yours
237 3. Edit those files to support your keyboard.
239 See these as examples.
240 - https://github.com/tmk/infinity_ergodox
241 - https://github.com/tmk/whitefox
247 Use PJRC's `hid_listen` to see debug messages. You can use xprintf() to display debug info, see `tmk_core/common/xprintf.h`.
249 - https://www.pjrc.com/teensy/hid_listen.html
253 Files and Directories
256 * keyboard/ - keyboard projects
257 * converter/ - protocol converter projects
258 * tmk_core/ - core library
259 * tmk_core/doc/ - documents
265 - Report bugs in github **[Issues](https://github.com/tmk/tmk_keyboard/issues)**.
266 - Pull requets are also welcomed.
272 - Doesn't use Tab to indent, use 4-spaces instead.
276 Other Keyboard Firmware Projects
278 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.