di0ib/tmk_keyboard_custom
Archived
1
0
Fork 0
Code Releases Activity

Add description of Boot Magic in README

Browse Source
This commit is contained in:
tmk 2013-03-11 16:01:35 +09:00
parent 8b01649a6a
commit b57451f141
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -18,6 +18,7 @@ Features
* Macro - Very primitive at this time * Macro - Very primitive at this time
* Keyboard Tricks - Oneshot modifier and modifier with tapping feature * Keyboard Tricks - Oneshot modifier and modifier with tapping feature
* Debug Console - Messages for debug and interaction with firmware * Debug Console - Messages for debug and interaction with firmware
* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
Projects Projects
@ -164,13 +165,15 @@ Makefile Options
### 2. Features ### 2. Features
Note that ***comment out*** to disable them. Note that ***comment out*** to disable them.
MOUSEKEY_ENABLE = yes # Mouse keys BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control) EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
NKRO_ENABLE = yes # USB Nkey Rollover 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 ### 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 # for PJRC Teensy
PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
@ -273,16 +276,24 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
Caps: Lock Keyboard(Child Proof) Caps: Lock Keyboard(Child Proof)
Paus: jump to bootloader Paus: jump to bootloader
### Boot Magic **TBD**
Magic commands are executed when boot time. Press `Magic` command key then pulgin.
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 - Clear configuration stored in EEPROM(`Backspace`)
IS_BOOTMAGIC_BOOTLOADER - 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*** **TBD**
See `keyboard/hhkb/config.h` for sample.