a03aa301de
* disambiguate Bootmagic rules in keymaps
The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.
This commit edits the files to specify that full Bootmagic is intended.
* remove BOOTMAGIC_ENABLE=full setting
* unify commented BOOTMAGIC_ENABLE rules in keyboards
Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no # Virtual DIP switch configuration;g' {} +
```
* remove commented Bootmagic rules from keymap/user level
Command:
```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```
* update keyboard BOOTMAGIC_ENABLE rule formatting
Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```
* update keyboards' BOOTMAGIC_ENABLE settings
Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Command:
```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```
* update keymap/user BOOTMAGIC_ENABLE settings
Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```
* remove and replace inline comments in keyboards and keymap/user files
Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.
Commands:
```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1 # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1 # Enable Bootmagic Lite;g' '{}' +
```
* rename improperly named makefiles
Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.
This commit corrects the filenames of the affected files.
* update renamed file with new rule formatting
* update QMK's template files
Updates QMK's `rules.mk` templates to use the new inline comment.
* update QMK Docs
- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes
* rules.mk patch for coarse/ixora and coarse/vinta
|
||
|---|---|---|
| .. | ||
| keymaps | ||
| MEMO.txt | ||
| board_is31fl3731c.h | ||
| board_st7565.h | ||
| chconf.h | ||
| config.h | ||
| ergodox_infinity.c | ||
| ergodox_infinity.h | ||
| gfxconf.h | ||
| halconf.h | ||
| info.json | ||
| mcuconf.h | ||
| readme.md | ||
| rules.mk | ||
| simple_visualizer.h | ||
| visualizer.c | ||
readme.md
ErgoDox Infinity
The Infinity is two completely independent keyboards, and needs to be flashed for the left and right halves seperately. To flash them:
-
Make sure you are in the top-level qmk_firmware directory
-
Build the firmware with
make ergodox_infinity:keymapname -
Plug in the left hand keyboard only.
-
Press the program button (back of keyboard, above thumb pad).
-
Install the firmware with
sudo make ergodox_infinity:keymapname:dfu-util -
Build right hand firmware with
make ergodox_infinity:keymapname MASTER=right -
Plug in the right hand keyboard only.
-
Press the program button (back of keyboard, above thumb pad).
-
Install the firmware with
sudo make ergodox_infinity:keymapname:dfu-util MASTER=right
More information on the Infinity firmware is available in the TMK/chibios for Input Club Infinity Ergodox
Infinity Master/Two Halves
The Infinity is two completely independent keyboards, that can connect together. You have a few options in how you flash the firmware:
-
Add
#define EE_HANDSto your config.h, initialize the EEPROM values (see below), and then flash the same firmware to both halves. -
Flash the left half, rebuild the firmware with "MASTER=right" and then flash the right half. This allows you to plug in either half directly to the computer and is what the above instructions do.
-
Flash the left half, then flash the same firmware on the right. This only works when the left half is plugged directly to the computer and the keymap is mirrored. It saves the small extra step of rebuilding with "MASTER=right".
-
The same as the previous one but with "MASTER=right" when you build the firmware, then flash the same firmware to both halves. You just have to directly connect the right half to the computer.
-
For minor changes such as changing only the keymap without having updated any part of the firmware code itself, you can program only the MASTER half, but it is safest to program both halves.
EE_HANDS initialization
To initialize the EEPROM values for EE_HANDS to work properly, these steps should work.
They only need to be done once, unless you reset the EEPROM later.
-
Plug in the left keyboard half to the computer, and press its program button.
-
Flash the left half with
make ergodox_infinity:default:dfu-util-split-left(If you need to use a different method to flash your keyboard, still run this command, and abort it with Ctrl+C when the flashing attempts starts to print errors, then flash the built firmware). -
On the left half, press the top vertical 1.5U key (second from the top in the rightmost column) once, then the 1U key at the bottom in the opposite corner (bottom left corner).
-
Plug in the right keyboard half to the computer, and press its program button.
-
Flash the right half with
make ergodox_infinity:default:dfu-util-split-right -
On the right half, press the top vertical 1.5U key (second from the top in the leftmost column) once, then the 1U key at the bottom in the opposite corner (bottom right corner).
-
Add
#define EE_HANDSto the config.h file of your keymap, and build your firmware usingmake ergodox_infinity:keymapname. -
After this, you can flash both halves with the same firmware, without having to rebuild with "MASTER=right" or risking a mirrored keyboard when connected the wrong way. If you reset your EEPROM later, you'll have to follow these steps again, though.