X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=a01de8c6f81a4d14b9340524f9f3d9c1f222aa7a;hb=fa545c87f74833856761572ef631d20accc1d026;hp=eccb1bd77e39ed42b3c5f7a7d91db8316a39364d;hpb=e59fb6f908e3e05ed135bf6d004524b0b6bf9119;p=tmk_firmware.git diff --git a/README.md b/README.md index eccb1bd..a01de8c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ These features can be used in your keyboard. * Virtual DIP Switch - Configurations stored EEPROM(Boot Magic) * Locking CapsLock - Mechanical switch support for CapsLock * Breathing Sleep LED - Sleep indicator with charm during USB suspend +* Backlight - Control backlight levels Projects @@ -32,13 +33,15 @@ You can find some keyboard specific projects under `converter` and `keyboard` di ### converter * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2] * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb] -* [m0110_usb](converter/m0110_usb) - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110] +* [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110] * [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] * [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news] * [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k] * [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?) * [pc98_usb](converter/pc98_usb/) - [PC98] to USB * [usb_usb](converter/usb_usb/) - USB to USB(experimental) +* [ascii_usb](converter/ascii_usb/) - ASCII(Serial console terminal) to USB +* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard Converter][GH_ibm4704] ### keyboard * [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board** @@ -48,6 +51,8 @@ You can find some keyboard specific projects under `converter` and `keyboard` di * [phantom](keyboard/phantom/) - [Phantom] keyboard (by Tranquilite) * [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung) * [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired] +* [KMAC](keyboard/kmac/) - Korean custom keyboard +* [Lightsaber](keyboard/lightsaber/) - Korean custom keyboard [GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 [GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 @@ -59,6 +64,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di [GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272 [GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060 [GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483 +[GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0 [HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions [Phantom]: http://geekhack.org/index.php?topic=26742 [GH60]: http://geekhack.org/index.php?topic=34959 @@ -88,7 +94,7 @@ See [doc/keymap.md](doc/keymap.md). -Magic Comannds +Magic Commands -------------- To see help press `Magic` + `H`. @@ -102,7 +108,6 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag x: toggle matrix debug k: toggle keyboard debug m: toggle mouse debug - p: toggle print enable v: print device version & info t: print timer count s: print status @@ -120,12 +125,14 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag **TBD** ### Boot Magic Configuration - Virtual DIP Switch -Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable. +Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable. 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. -#### EEPROM -- Skip reading EEPROM(`ESC`) -- Clear configuration stored in EEPROM(`Backspace`) +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 [common/bootmagic.h](common/bootmagic.h). + +#### General +- Skip reading EEPROM to start with default configuration(`ESC`) +- Clear configuration stored in EEPROM to reset configuration(`Backspace`) #### Bootloader - Kick up Bootloader(`B`) @@ -138,28 +145,38 @@ Note that you must use keys of **Layer 0** as Magic keys. These settings are sto #### Keymap - Swap Control and CapsLock(`Left Control`) -- Change CapsLock to Control(`Casp Lock`) +- Change CapsLock to Control(`Caps Lock`) - Swap LeftAlt and Gui(`Left Alt`) - Swap RightAlt and Gui(`Right Alt`) - Disable Gui(`Left Gui`) - Swap Grave and Escape(`Grave`) - Swap BackSlash and BackSpace(`Back Slash`) +- Enable NKRO on boot(`N`) #### Default Layer - Set Default Layer to 0(`0`) -- Set Default Layer to 0(`1`) -- Set Default Layer to 0(`2`) -- Set Default Layer to 0(`3`) +- Set Default Layer to 1(`1`) +- Set Default Layer to 2(`2`) +- Set Default Layer to 3(`3`) +- Set Default Layer to 4(`4`) +- Set Default Layer to 5(`5`) +- Set Default Layer to 6(`6`) +- Set Default Layer to 7(`7`) + +#### Caution +Unintentional use of this feature will cause user confusion. + +TODO: Magic key combination to avoid unintentional press during plug in **TBD** -Mechanical Locking support for CapsLock ---------------------------------------- -To enable this feature define these two macros in `config.h` and use `KC_LCAP` for locking CapsLock in keymap instead of normal `KC_CAPS`. Resync option tries to keep lock switch state consistent with keyboard LED state. +Mechanical Locking support +-------------------------- +This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state. - #define CAPSLOCK_LOCKING_ENABLE - #define CAPSLOCK_LOCKING_RESYNC_ENABLE + #define LOCKING_SUPPORT_ENABLE + #define LOCKING_RESYNC_ENABLE Start Your Own Project @@ -198,33 +215,11 @@ Architecture -Debuging +Debugging -------- Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack. -You will see output from firmware like this. - - r/c 01234567 - 00: 00000000 - 01: 00000000 - 02: 00000000 - 03: 00000000 - 04: 00000000 - 05: 00000000 - 06: 00000000 - 07: 00000000 - - ---- action_exec: start ----- - EVENT: 0307u(22511) - Tapping: Tap release(2) - ACTION: ACT_LAYER[5:2C] - LAYER_PRESSED: Tap: unregister_code - TAPPING_KEY=0307u(22511):2 - processed: 0307u(22511):2 - - Tapping: End(Timeout after releasing last tap): FFFFu(22715) - TAPPING_KEY=0000u(0):0 - +You can use xprintf() to display debug info on `hid_listen`, see `common/xprintf.h`. @@ -237,7 +232,7 @@ Files and Directories * converter/ - protocol converter projects * doc/ - documents * common.mk - Makefile for common -* protoco.mk - Makefile for protocol +* protocol.mk - Makefile for protocol * rules.mk - Makefile for build rules ### Common @@ -273,6 +268,12 @@ Files and Directories +Coding Style +------------- +- Doesn't use Tab to indent, use 4-spaces instead. + + + Other Keyboard Firmware Projects ------------------ See [doc/other_projects.md](doc/other_projects.md).