diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 30 |
1 files changed, 25 insertions, 5 deletions
@@ -348,6 +348,10 @@ This allows you output audio on the C6 pin (needs abstracting). See the [audio s | |||
348 | 348 | ||
349 | Use this to debug changes to variable values, see the [tracing variables](#tracing-variables) section for more information. | 349 | Use this to debug changes to variable values, see the [tracing variables](#tracing-variables) section for more information. |
350 | 350 | ||
351 | `API_SYSEX_ENABLE` | ||
352 | |||
353 | This enables using the Quantum SYSEX API to send strings (somewhere?) | ||
354 | |||
351 | ### Customizing Makefile options on a per-keymap basis | 355 | ### Customizing Makefile options on a per-keymap basis |
352 | 356 | ||
353 | 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. | 357 | 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. |
@@ -1162,12 +1166,12 @@ For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring | |||
1162 | 1166 | ||
1163 | RGBLIGHT_ENABLE = yes | 1167 | RGBLIGHT_ENABLE = yes |
1164 | 1168 | ||
1165 | In order to use the underglow timer functions, you need to have `#define RGBLIGHT_TIMER` in your `config.h`, and have audio disabled (`AUDIO_ENABLE = no` in your Makefile). | 1169 | In order to use the underglow animation functions, you need to have `#define RGBLIGHT_ANIMATIONS` in your `config.h`. |
1166 | 1170 | ||
1167 | Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the `F4` pin by default: | 1171 | Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the `F4` pin by default: |
1168 | 1172 | ||
1169 | #define RGB_DI_PIN F4 // The pin your RGB strip is wired to | 1173 | #define RGB_DI_PIN F4 // The pin your RGB strip is wired to |
1170 | #define RGBLIGHT_TIMER // Require for fancier stuff (not compatible with audio) | 1174 | #define RGBLIGHT_ANIMATIONS // Require for fancier stuff (not compatible with audio) |
1171 | #define RGBLED_NUM 14 // Number of LEDs | 1175 | #define RGBLED_NUM 14 // Number of LEDs |
1172 | #define RGBLIGHT_HUE_STEP 10 | 1176 | #define RGBLIGHT_HUE_STEP 10 |
1173 | #define RGBLIGHT_SAT_STEP 17 | 1177 | #define RGBLIGHT_SAT_STEP 17 |
@@ -1318,14 +1322,30 @@ You probably don't want to "brick" your keyboard, making it impossible | |||
1318 | to rewrite firmware onto it. Here are some of the parameters to show | 1322 | to rewrite firmware onto it. Here are some of the parameters to show |
1319 | what things are (and likely aren't) too risky. | 1323 | what things are (and likely aren't) too risky. |
1320 | 1324 | ||
1321 | - If a keyboard map does not include RESET, then, to get into DFU | 1325 | - If your keyboard map does not include RESET, then, to get into DFU |
1322 | mode, you will need to press the reset button on the PCB, which | 1326 | mode, you will need to press the reset button on the PCB, which |
1323 | requires unscrewing some bits. | 1327 | requires unscrewing the bottom. |
1324 | - Messing with tmk_core / common files might make the keyboard | 1328 | - Messing with tmk_core / common files might make the keyboard |
1325 | inoperable | 1329 | inoperable |
1326 | - Too large a .hex file is trouble; `make dfu` will erase the block, | 1330 | - Too large a .hex file is trouble; `make dfu` will erase the block, |
1327 | test the size (oops, wrong order!), which errors out, failing to | 1331 | test the size (oops, wrong order!), which errors out, failing to |
1328 | flash the keyboard | 1332 | flash the keyboard, leaving it in DFU mode. |
1333 | - To this end, note that the maximum .hex file size on Planck is | ||
1334 | 7000h (28672 decimal) | ||
1335 | ```Linking: .build/planck_rev4_cbbrowne.elf [OK] | ||
1336 | Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK] | ||
1337 | |||
1338 | Size after: | ||
1339 | text data bss dec hex filename | ||
1340 | 0 22396 0 22396 577c planck_rev4_cbbrowne.hex | ||
1341 | ``` | ||
1342 | - The above file is of size 22396/577ch, which is less than | ||
1343 | 28672/7000h | ||
1344 | - As long as you have a suitable alternative .hex file around, you | ||
1345 | can retry, loading that one | ||
1346 | - Some of the options you might specify in your keyboard's Makefile | ||
1347 | consume extra memory; watch out for BOOTMAGIC_ENABLE, | ||
1348 | MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE | ||
1329 | - DFU tools do /not/ allow you to write into the bootloader (unless | 1349 | - DFU tools do /not/ allow you to write into the bootloader (unless |
1330 | you throw in extra fruitsalad of options), so there is little risk | 1350 | you throw in extra fruitsalad of options), so there is little risk |
1331 | there. | 1351 | there. |