opensteno_qmk/keyboards/tada68
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 Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
config.h Remove DESCRIPTION, R-V (#11632) 2021-01-20 12:40:35 +11:00
info.json
readme.md
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
tada68.c Refactor to use led config - Part 5 (#10975) 2020-11-21 19:11:24 +00:00
tada68.h

TADA68

A compact 65% keyboard.

  • Keyboard Maintainer: QMK Community
  • Hardware Supported: TADA68 PCB
  • Hardware Availability: kbdfans, kbdist

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

make tada68:default

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Firmware Format

Out of the box the tada68 uses a .bin firmware file instead of a .hex like other custom keyboards. By default QMK will build and copy the correct .bin file for you. If for some reason you need a hex file instead, you can add :hex to your make command, or look inside qmk_firmware/.build to find the hex file.

Flashing Instructions (Win)

Read all the instructions, there are a few warnings of things to avoid doing to avoid bricking your Tada68. It is much too easy to do!

  1. from the qmk_firmware\ directory run:
$ make tada68:default:flashbin
  1. Connect your keyboard to Windows computer, hit the reset button on the TADA, the lights will start flashing.

  2. You'll see a new drive on your computer called TADA68. Backup the original factory FLASH.BIN file thats inside it.

  3. Delete FLASH.BIN from the TADA drive and copy tada68_default.bin that was generated at the root of the qmk directory into the TADA drive.

  4. Do not eject the USB device. Hit ESC on the keyboard. The lights will stop flashing and your firmware is loaded!

Flashing Instructions (Mac)

When flashing the keyboard from a Mac, you must delete some files that are automatically created by the operating system in order to prevent bricking your keyboard. Original information from /u/pawlwall from https://www.reddit.com/r/MechanicalKeyboards/comments/520cov/using_an_originative_tada86_on_a_mac/

  1. from the qmk_firmware\ directory run:
$ make tada68:default:flashbin
  1. Connect your keyboard to your Mac, hit the reset button on the bottom of the TADA, the lights will start flashing.

  2. You'll see a new drive on your computer called TADA68. Backup the original factory FLASH.BIN file that's inside it.

  3. Open the terminal and cd to the folder where the keyboard has been mounted

cd /Volumes/TADA68\ /

  1. Copy over your new firmware to the keyboard

cp -r <path to your qmk_firmware folder>/FLASH.bin .

  1. Remove files that MacOS automatically created which interfere with the keyboard

rm -fr .Trashes/ .fseventsd/ ._.Trashes ._FLASH.bin

  1. Eject the USB device or hit ESC on the keyboard. The lights will stop flashing and your firmware is loaded!

Flashing Instructions (Linux)

Use these instructions at your own risk. Mount settings originally found at https://www.reddit.com/r/MechanicalKeyboards/comments/8e2nnp/help_problems_flashing_firmware_on_tada68_from/

  1. from the qmk_firmware\ directory run:
$ make tada68:default:flashbin
  1. Connect your keyboard to the computer, hit the reset button on the TADA, the lights will start flashing.

  2. A new entry should appear at /dev/sd*. Mount the board using this command:

mount -t vfat -o rw,nosuid,nodev,relatime,uid=1000,gid=1000,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,showexec,utf8,flush,errors=remount-ro,uhelper=udisks2 <path to device> /mnt/tada68
  1. Back up the original firmware

mv /mnt/tada68/FLASH.BIN ~

  1. Copy over your new firmware to the keybaord

cp <path to your qmk_firmware folder>/FLASH.bin /mnt/tada68

  1. Do not eject the USB device. Hit ESC on the keyboard. The lights will stop flashing and your firmware is loaded!