Features
--------
-* Multi-layer Keymap - Multiple keyboard layouts with layer switching.
+* Multi-layer Keymap - Multiple keyboard layouts with layer switching
* Mouse key - Mouse control with keyboard
* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
* Macro - Very primitive at this time
* Keyboard Tricks - Oneshot modifier and modifier with tapping feature
* Debug Console - Messages for debug and interaction with firmware
+* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
Projects
You can find some keyboard specific projects under `converter` and `keyboard` directory.
### converter
-* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
-* adb_usb - [ADB keyboard to USB][GH_adb]
-* m0110_usb - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
-* terminal_usb - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
-* news_usb - [Sony NEWS keyboard to USB][GH_news]
-* x68k_usb - [Sharp X68000 keyboard to USB][GH_x68k]
-* sun_usb - Sun to USB(type4, 5 and 3?)
-* usb_usb - USB to USB(experimental)
+* [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]
+* [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)
### keyboard
-* hhkb - [Happy Hacking Keyboard professional][GH_hhkb]
-* macway - [Compact keyboard mod][GH_macway]
-* hbkb - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
-* IIgs_Standard - Apple IIGS keyboard mod(by JeffreySung)
-* hid_liber - [HID liberation controller][HID_liber](by alaricljs)
-* phantom - [Phantom keyboard][PHANTOM] (by Tranquilite)
-* gh60 - [GH60 keyboard][GH60]
+* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb]
+* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway]
+* [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
+* [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
+* [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs)
+* [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite)
+* [gh60](keyboard/gh60/) - [GH60 keyboard][GH60]
[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
[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
+[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
+[Sun]: http://en.wikipedia.org/wiki/Sun-3
+[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
### 2. Features
Note that ***comment out*** to disable them.
- MOUSEKEY_ENABLE = yes # Mouse keys
- PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
- EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control)
- NKRO_ENABLE = yes # USB Nkey Rollover
+ BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
+ MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
+ EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
+ CONSOLE_ENABLE = yes # Console for debug(+400)
+ #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
+ #PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
### 3. Programmer
-Optional. Set proper command for your controller, bootloader and programmer.
+Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`.
# for PJRC Teensy
PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
Caps: Lock Keyboard(Child Proof)
Paus: jump to bootloader
-### Boot Magic
-Magic commands are executed when boot time. Press `Magic` command key then pulgin.
+**TBD**
-Define these macros in config.h.
+### Conguration with Boot Magic
+Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
+These settings are stored in EEPROM.
- IS_BOOTMAGIC_DEBUG
- IS_BOOTMAGIC_BOOTLOADER
+- Clear configuration stored in EEPROM(`Backspace`)
+- Kick up Bootloader(`B`)
+- Debug enable(`D`)
+- Swap Control and CapsLock(`Left Control`)
+- Change CapsLock to Control(`Casp 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`)
-***TODO: sample impl***
-See `keyboard/hhkb/config.h` for sample.
+**TBD**