@ -348,6 +348,10 @@ This allows you output audio on the C6 pin (needs abstracting). See the [audio s
Use this to debug changes to variable values, see the [tracing variables](#tracing-variables) section for more information.
Use this to debug changes to variable values, see the [tracing variables](#tracing-variables) section for more information.
`API_SYSEX_ENABLE`
This enables using the Quantum SYSEX API to send strings (somewhere?)
### Customizing Makefile options on a per-keymap basis
### Customizing Makefile options on a per-keymap basis
If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard.
If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options for your particular keyboard.
@ -1318,14 +1322,30 @@ You probably don't want to "brick" your keyboard, making it impossible
to rewrite firmware onto it. Here are some of the parameters to show
to rewrite firmware onto it. Here are some of the parameters to show
what things are (and likely aren't) too risky.
what things are (and likely aren't) too risky.
- If a keyboard map does not include RESET, then, to get into DFU
- If your keyboard map does not include RESET, then, to get into DFU
mode, you will need to press the reset button on the PCB, which
mode, you will need to press the reset button on the PCB, which
requires unscrewing some bits.
requires unscrewing the bottom.
- Messing with tmk_core / common files might make the keyboard
- Messing with tmk_core / common files might make the keyboard
inoperable
inoperable
- Too large a .hex file is trouble; `make dfu` will erase the block,
- Too large a .hex file is trouble; `make dfu` will erase the block,
test the size (oops, wrong order!), which errors out, failing to
test the size (oops, wrong order!), which errors out, failing to
flash the keyboard
flash the keyboard, leaving it in DFU mode.
- To this end, note that the maximum .hex file size on Planck is
7000h (28672 decimal)
```Linking: .build/planck_rev4_cbbrowne.elf [OK]
Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK]
Size after:
text data bss dec hex filename
0 22396 0 22396 577c planck_rev4_cbbrowne.hex
```
- The above file is of size 22396/577ch, which is less than
28672/7000h
- As long as you have a suitable alternative .hex file around, you
can retry, loading that one
- Some of the options you might specify in your keyboard's Makefile
consume extra memory; watch out for BOOTMAGIC_ENABLE,