Add Bootmagic Lite to QMK #4215

drashna · 2018-10-23T02:10:18Z

This allows for boards to have the "hold while plugging in" option to jump into the bootloader without the headache that full on bootmagic can bring with it.

Documentation is included on how to set the key in question (row and column), as well as the ability to replace the function to customize it based on the board.

yiancar · 2018-10-23T08:44:41Z

Could we add a second key and && them together?
I think just one single key to be held down is too little safety.
Also could there be an eeprom clear command before the bootloader jump? In my experience, its the eeprom clear that saves the day and not the jump:)

wilba · 2018-10-23T14:28:51Z

@yiancar there are hundreds of M6-A's out there with only a single key bootmagic_lite, you worry too much, friendo ;-)

But I agree with you on the EEPROM reset, that's the #1 thing that solves Zeal60 customer issues, because of some random bit of QMK magic being stuck on...

mechmerlin

I would almost prefer BOOTMAGIC_LITE_ENABLE = yes rather than using lite for BOOTMATIC_ENABLE. Or maybe even calling it something else? What's a lite version of magic? Alchemy? lol.

docs/feature_bootmagic.md

drashna · 2018-10-23T15:47:23Z

@yiancar I could, and that's what I had originally. But Wilba has a point about the single key stuff.

Additionally, if you noticed, I defined the function weakly. So if you want 2 keys required on your board, you can add bootmagic_lite to your keyboard's c file, and it will use that function instead. This allows for customization of the feature.... up to the point that you could emulate full bootmagic.

@mechmerlin I thought about that, but the problem with that, is then I need to check both option's status and error out if both are enabled. This is a simpler way to ensure that only one of them is enabled, and with minimal change to keymaps.

I'm not sure which approach is best, though. I personally like this one better, though.
@jackhumbert @skullydazed @fredizzimo, any input on how to handle enabling this feature?

yiancar · 2018-10-23T15:48:24Z

Yep I saw that so no complains for the single key! However the eeprom is a must I think:)

drashna · 2018-10-23T16:33:03Z

@yiancar I'm not sold on the eeprom reset.

In fact, I found it more of a pain in the ass, for me.

~~However, I can re-add it, if there is a good reason for it.~~

I've re-added the EEPROM reset, despite misgivings I may have about it.

And add eeprom-less version to drashna userspace for his sanity

And default yes to "full" for compatibility

jackhumbert · 2018-10-27T18:53:55Z

Great! Thanks :)

* upstream/master: (1215 commits) Add Bootmagic Lite to QMK (qmk#4215) Keymap: update keymap transmogrified (qmk#4241) Keyboard: Redox keymaps refactoring (qmk#4258) Keymap: Personal dz60 keymap (qmk#4251) Keymap: add my planck rev 5 layout (qmk#4085) Redox Wireless configurator support (qmk#4256) Keyboard: Add new keyboard Zinc (qmk#4245) Docs: Add references to One Shot functions, and clean up formatting (qmk#4189) Add caveat for basic keycodes in Tap Dance docs Add delayed flashing option for DFU Util (qmk#4225) RGB Support for Panc60 (qmk#4253) Add key caveat to combos doc Fix mouse_send() on chibiOS so it won't lock up the firmware Keymap: Update userspace (I want my Hacktoberfest shirt!) (qmk#4252) Keyboard: Add HS60 V2 (qmk#4250) add better example add support for encoders to core Ergodox Infinity: Swapped Row and Column in comments (qmk#4247) JD45: readme update JD45: mjt6u keymap refactor ...

* Preliminary additon of bootmagic lite functionality * Cleanup code * Clean up bootmagic code * Add documentation and clean up code * Make 'lite' an option for BOOTMAGIC_ENABLE * Update Templates with note about Bootmagic Lite option * Detect Debounce variable * Make sure debounce is a non-zero number * Capitalize Bootmagic * Capitalize bootmagic * Update wording * Re-add EEPROM reset, by popular demand And add eeprom-less version to drashna userspace for his sanity * Fix spacing * Set BOOTMAGIC_ENABLE to use full/lite/off And default yes to "full" for compatibility * Add Bootmagic lite info to templates * Remove text from makefiles * Cleanup of makefile * mention yes in bootmagic docs * Wordsmitthing the docs * Fix white spaces * Readd default bootmagic setting, because it's necessary

drashna added 6 commits October 22, 2018 10:49

Preliminary additon of bootmagic lite functionality

cadc6d9

Cleanup code

084a1e9

Clean up bootmagic code

30eaee2

Add documentation and clean up code

6b9a25f

Make 'lite' an option for BOOTMAGIC_ENABLE

64d78b4

Update Templates with note about Bootmagic Lite option

145ee2b

drashna added core enhancement labels Oct 23, 2018

drashna requested review from fredizzimo, jackhumbert and skullydazed October 23, 2018 02:10

drashna added 2 commits October 22, 2018 20:57

Detect Debounce variable

af25c93

Make sure debounce is a non-zero number

89d90cf

mechmerlin reviewed Oct 23, 2018

View reviewed changes

docs/feature_bootmagic.md Outdated Show resolved Hide resolved

docs/feature_bootmagic.md Outdated Show resolved Hide resolved

docs/feature_bootmagic.md Outdated Show resolved Hide resolved

drashna added 3 commits October 23, 2018 08:41

Capitalize Bootmagic

91d9c7f

Capitalize bootmagic

e022f9c

Update wording

ebf971a

Re-add EEPROM reset, by popular demand

c779bb2

And add eeprom-less version to drashna userspace for his sanity

drashna force-pushed the bootmagic_lite branch from 4a3a932 to c779bb2 Compare October 23, 2018 16:42

drashna added 6 commits October 23, 2018 10:31

Fix spacing

c42f222

Set BOOTMAGIC_ENABLE to use full/lite/off

0f15016

And default yes to "full" for compatibility

Add Bootmagic lite info to templates

032347c

Remove text from makefiles

2daf3d2

Cleanup of makefile

6f092d8

mention yes in bootmagic docs

b5b9376

drashna added 3 commits October 26, 2018 22:20

Wordsmitthing the docs

a0a425e

Fix white spaces

fab3078

Readd default bootmagic setting, because it's necessary

08c5a81

jackhumbert merged commit 4ffcacd into qmk:master Oct 27, 2018

drashna deleted the bootmagic_lite branch October 27, 2018 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Bootmagic Lite to QMK #4215

Add Bootmagic Lite to QMK #4215

drashna commented Oct 23, 2018

yiancar commented Oct 23, 2018 •

edited

wilba commented Oct 23, 2018

mechmerlin left a comment

drashna commented Oct 23, 2018

yiancar commented Oct 23, 2018

drashna commented Oct 23, 2018 •

edited

jackhumbert commented Oct 27, 2018

Add Bootmagic Lite to QMK #4215

Add Bootmagic Lite to QMK #4215

Conversation

drashna commented Oct 23, 2018

yiancar commented Oct 23, 2018 • edited

wilba commented Oct 23, 2018

mechmerlin left a comment

Choose a reason for hiding this comment

drashna commented Oct 23, 2018

yiancar commented Oct 23, 2018

drashna commented Oct 23, 2018 • edited

jackhumbert commented Oct 27, 2018

yiancar commented Oct 23, 2018 •

edited

drashna commented Oct 23, 2018 •

edited