mirror of https://github.com/qmk/qmk_firmware.git synced 2024-11-22 11:29:26 +00:00

History

James Young a03aa301de Remove Full Bootmagic (#13846 ) * 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		2021-08-06 23:59:56 -07:00
..
keymaps/default	Remove KEYMAP and LAYOUT_kc (#12160 )	2021-05-11 10:10:31 -07:00
config.h	Remove `DESCRIPTION`, H-J (#11616 )	2021-01-20 00:38:12 +11:00
i2c.c	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
i2c.h	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
info.json	Fix handwired/not_so_minidox keyboard dimensions in info.json	2019-04-13 01:27:36 -07:00
matrix.c	Remove legacy print backward compatiblitly (#11805 )	2021-02-06 16:56:13 +00:00
not_so_minidox.c	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
not_so_minidox.h	Remove KEYMAP and LAYOUT_kc (#12160 )	2021-05-11 10:10:31 -07:00
readme.md	Modified URLs to point to new locations	2019-01-13 09:11:18 -08:00
rules.mk	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00
serial.c	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
serial.h	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
split_util.c	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00
split_util.h	add not-so-minidox handwire keyboard (#3061 )	2018-05-31 08:30:05 -07:00

readme.md

not_so_minidox

A slightly larger version of the MiniDox

Keyboard Maintainer: mtdjr
Hardware Supported: None yet/ProMicro

Make example for this keyboard (after setting up your build environment):

make not_so_minidox/rev1:default

See build environment setup then the make instructions for more information.

Flashing

Note: Most of this is copied from the Let's Split readme, because it is awesome

From the root directory run make PROJECT:KEYMAP:avrdude for automatic serial port resolution and flashing. Example: make not_so_minidox/rev1:default:avrdude

Choosing which board to plug the USB cable into (choosing Master)

Because the two boards are identical, the firmware has logic to differentiate the left and right board.

It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable.

The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.

The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.

Setting the left hand as master

If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out EE_HANDS and comment out I2C_MASTER_RIGHT or MASTER_RIGHT if for some reason it was set.

Setting the right hand as master

If you always plug the usb cable into the right board, add an extra flag to your config.h

 #define MASTER_RIGHT

Setting EE_hands to use either hands as master

If you define EE_HANDS in your config.h, you will need to set the EEPROM for the left and right halves.

The EEPROM is used to store whether the half is left handed or right handed. This makes it so that the same firmware file will run on both hands instead of having to flash left and right handed versions of the firmware to each half. To flash the EEPROM file for the left half run:

avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
// or the equivalent in dfu-programmer

and similarly for right half

avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
// or the equivalent in dfu-programmer

NOTE: replace $(COM_PORT) with the port of your device (e.g. /dev/ttyACM0)

After you have flashed the EEPROM, you then need to set EE_HANDS in your config.h, rebuild the hex files and reflash.

Note that you need to program both halves, but you have the option of using different keymaps for each half. You could program the left half with a QWERTY layout and the right half with a Colemak layout using bootmagic's default layout option. Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the right half is connected.