mirror of https://github.com/openstenoproject/qmk synced 2024-11-14 20:44:38 +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
..
galaxy	__flash? (#13799 )	2021-07-31 14:35:30 +01:00
hades	__flash? (#13799 )	2021-07-31 14:35:30 +01:00
venus	__flash? (#13799 )	2021-07-31 14:35:30 +01:00
config.h
dgk6x.c
dgk6x.h
halconf.h
mcuconf.h
readme.md
rules.mk	Remove Full Bootmagic (#13846 )	2021-08-06 23:59:56 -07:00

readme.md

DGK6X = Venus, Hades, Galaxy, etc.

This DGK6X code is shared between the ANSI variants of Venus, Hades and Galaxy keyboards.

Keyboard Maintainer: J-Sully and dkjer
Hardware Supported: Durgod Venus, Hades or Galaxy board with STM32F070RBT6
Hardware Availability: Venus, Hades and Galaxy

Instructions

Build

Instructions for building the Venus, Hades and Galaxy firmware can be found here:

Initial Flash

For first Flashing from initial Stock's Firmware

Back up original Firmware Image:

Unplug
Short Boot0 to Vdd (See below)
Plug In USB
Make a Flash Image's Backup in case you wanted to restore the Keyboard to Stock's Image:
- Using dfu-util:
```
dfu-util --list
dfu-util --alt 0 --dfuse-address 0x08000000 --upload ${OLD_STOCK_BIN}
```

Flash the QMK Firmware Image.

Put board into Bootloader mode, using the same method as when backing up the original Firmware (above)
Here are a few options for performing the initial Flash:
- Using QMK Toolbox
- Using dfu-util:
```
dfu-util --alt 0 --dfuse-address 0x08000000 --download ${NEW_QMK_BIN}
```

You can short Boot0 to Vdd by shorting R19 to C30 on the sides closest to the processor, as shown:

Hades & Venus:
Galaxy 75

Subsequent Flashing

For repeating Flashing you can use BootMagic:

BootMagic Lite has been enabled with Assigned "Esc" key
Unplug USB Cable
Holding Esc Button
Plug in USB Cable, Keyboard should be in ST-Bootloader state