diff options
| author | tmk <nobody@nowhere> | 2013-03-11 16:01:35 +0900 |
|---|---|---|
| committer | tmk <nobody@nowhere> | 2013-03-11 16:01:35 +0900 |
| commit | 8b9bd51d3a13959a4d59fdbc819a033cd8b0a3ce (patch) | |
| tree | 10d0192d4efe3d5b3613aa3a29aeb136207b2cf0 /README.md | |
| parent | 48433a5e9988647a737234c11dd9db4080fd4a4e (diff) | |
| download | qmk_firmware-8b9bd51d3a13959a4d59fdbc819a033cd8b0a3ce.tar.gz qmk_firmware-8b9bd51d3a13959a4d59fdbc819a033cd8b0a3ce.zip | |
Add description of Boot Magic in README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 23 insertions, 12 deletions
| @@ -18,6 +18,7 @@ Features | |||
| 18 | * Macro - Very primitive at this time | 18 | * Macro - Very primitive at this time |
| 19 | * Keyboard Tricks - Oneshot modifier and modifier with tapping feature | 19 | * Keyboard Tricks - Oneshot modifier and modifier with tapping feature |
| 20 | * Debug Console - Messages for debug and interaction with firmware | 20 | * Debug Console - Messages for debug and interaction with firmware |
| 21 | * Virtual DIP Switch - Configurations stored EEPROM(Boot Magic) | ||
| 21 | 22 | ||
| 22 | 23 | ||
| 23 | Projects | 24 | Projects |
| @@ -164,13 +165,15 @@ Makefile Options | |||
| 164 | ### 2. Features | 165 | ### 2. Features |
| 165 | Note that ***comment out*** to disable them. | 166 | Note that ***comment out*** to disable them. |
| 166 | 167 | ||
| 167 | MOUSEKEY_ENABLE = yes # Mouse keys | 168 | BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000) |
| 168 | PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support | 169 | MOUSEKEY_ENABLE = yes # Mouse keys(+4700) |
| 169 | EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control) | 170 | EXTRAKEY_ENABLE = yes # Audio control and System control(+450) |
| 170 | NKRO_ENABLE = yes # USB Nkey Rollover | 171 | CONSOLE_ENABLE = yes # Console for debug(+400) |
| 172 | #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA | ||
| 173 | #PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support | ||
| 171 | 174 | ||
| 172 | ### 3. Programmer | 175 | ### 3. Programmer |
| 173 | Optional. Set proper command for your controller, bootloader and programmer. | 176 | Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. |
| 174 | 177 | ||
| 175 | # for PJRC Teensy | 178 | # for PJRC Teensy |
| 176 | PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex | 179 | 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 | |||
| 273 | Caps: Lock Keyboard(Child Proof) | 276 | Caps: Lock Keyboard(Child Proof) |
| 274 | Paus: jump to bootloader | 277 | Paus: jump to bootloader |
| 275 | 278 | ||
| 276 | ### Boot Magic | 279 | **TBD** |
| 277 | Magic commands are executed when boot time. Press `Magic` command key then pulgin. | ||
| 278 | 280 | ||
| 279 | Define these macros in config.h. | 281 | ### Conguration with Boot Magic |
| 282 | Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable. | ||
| 283 | These settings are stored in EEPROM. | ||
| 280 | 284 | ||
| 281 | IS_BOOTMAGIC_DEBUG | 285 | - Clear configuration stored in EEPROM(`Backspace`) |
| 282 | IS_BOOTMAGIC_BOOTLOADER | 286 | - Kick up Bootloader(`B`) |
| 287 | - Debug enable(`D`) | ||
| 288 | - Swap Control and CapsLock(`Left Control`) | ||
| 289 | - Change CapsLock to Control(`Casp Lock`) | ||
| 290 | - Swap LeftAlt and Gui(`Left Alt`) | ||
| 291 | - Swap RightAlt and Gui(`Right Alt`) | ||
| 292 | - Disable Gui(`Left Gui`) | ||
| 293 | - Swap Grave and Escape(`Grave`) | ||
| 294 | - Swap BackSlash and BackSpace(`Back Slash`) | ||
| 283 | 295 | ||
| 284 | ***TODO: sample impl*** | 296 | **TBD** |
| 285 | See `keyboard/hhkb/config.h` for sample. | ||
| 286 | 297 | ||
| 287 | 298 | ||
| 288 | 299 | ||
