summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-08-15Rework keymap_extras docs (#13949)Ryan
2021-08-12Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-13Update 20210529.md (#13170)Felix Sargent
This was confusing to me when I updated, so I want to make it more clear for those that come after.
2021-08-12Fix some additional bootmagic settings (#13979)Drashna Jaelre
2021-08-10Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-10Architecture documentation for Configurator and API (#13935)Zach White
* Architecture documentation for the configurator and api * Apply suggestions from code review Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2021-08-10Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-10Update feature_wpm.md (#13936)Stefan Subich
Fix example markdown code formatting
2021-08-09Remove backwards compatibility of debounce names (#13877)Joel Challis
* Remove backwards compatibility of debounce names * Update docs * Update keyboards/keymaps
2021-08-09Add support for STM32F407x MCUs. (#13718)thpoll83
* Add support for STM32F407x MCUs. * Removing STMF407 MCU variation * Update quantum/mcu_selection.mk Remove options for dfu flashing Co-authored-by: Ryan <fauxpark@gmail.com> * DISABLE STM32_USB_USE_OTG1 * Update platforms/chibios/GENERIC_STM32_F407XE/configs/mcuconf.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update platforms/chibios/GENERIC_STM32_F407XE/configs/mcuconf.h Co-authored-by: thomas.pollak <thomas.pollak@dynatrace.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-08-06Remove Full Bootmagic (#13846)James Young
* 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-07Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404)Sergey Vlasov
* Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys Implement an additional option for dual-role keys which converts the dual-role key press into a hold action immediately when another key is pressed (this is different from the existing PERMISSIVE_HOLD option, which selects the hold action when another key is tapped (pressed and then released) while the dual-role key is pressed). The Mod-Tap keys already behave in a similar way, unless the IGNORE_MOD_TAP_INTERRUPT option is enabled (but with some additional delays); the added option makes this behavior available for all other kinds of dual-role keys. * [Docs] Update tap-hold docs for HOLD_ON_OTHER_KEY_PRESS Document the newly added HOLD_ON_OTHER_KEY_PRESS option and update the documentation for closely related options (PERMISSIVE_HOLD and IGNORE_MOD_TAP_INTERRUPT). Use Layer Tap instead of Mod Tap in examples for PERMISSIVE_HOLD and HOLD_ON_OTHER_KEY_PRESS, because the effect of using these options with Mod Tap keys is mostly invisible without IGNORE_MOD_TAP_INTERRUPT. Add comments before return statements in sample implementations of `get_ignore_mod_tap_interrupt()`, `get_hold_on_other_key_press()` and `get_permissive_hold()`. Thanks to @Erovia and @precondition for comments and suggestions to improve the documentation.
2021-08-06Process combos earlier & overlapping combos (#8591)Pete Sevander
* Combo processing improvements. Now it is possible to use ModTap and LayerTap keys as part of combos. Overlapping combos also don't trigger all the combos, just exactly the one that you press. New settings: - COMBO_MUST_HOLD_MODS - COMBO_MOD_TERM - COMBO_TERM_PER_COMBO - COMBO_MUST_HOLD_PER_COMBO - COMBO_STRICT_TIMER - COMBO_NO_TIMER * Remove the size flags from combo_t struct boolean members. This in the end actually saves space as the members are accessed so many times. The amount of operations needed to access the bits uses more memory than setting the size saves. * Fix `process_combo_key_release` not called correctly with tap-only combos * Fix not passing a pointer when NO_ACTION_TAPPING is defined. * Docs for `COMBO_ONLY_FROM_LAYER` * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update quantum/process_keycode/process_combo.c Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Add `EXTRA_SHORT_COMBOS` option. Stuff combo's `disabled` and `active` flags into `state`. Possibly can save some space. * Add more examples and clarify things with dict management system. - Simple examples now has a combo that has modifiers included. - The slightly more advanced examples now are actually more advanced instead of just `tap_code16(<modded-keycode>)`. - Added a note that `COMBO_ACTION`s are not needed anymore as you can just use custom keycodes. - Added a note that the `g/keymap_combo.h` macros use the `process_combo_event` function and that it is not usable in one's keymap afterwards. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Change "the" combo action example to "email" example. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Fix sneaky infinite loop with `combo_disable()` No need to call `dump_key_buffer` when disabling combos because the buffer is either being dumped if a combo-key was pressed, or the buffer is empty if a non-combo-key is pressed. * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Update docs/feature_combo.md Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-08-06[Feature] Swap buttons on PS2 Mouse/Trackball (#9205)Juan Pablo Kutianski
* [Feature Request] Swap buttons on PS2 Mouse/Trackball * [Feature Request] Swap buttons on PS2 Mouse/Trackball * Added id: to the doc * Missing space * Solve comment https://github.com/qmk/qmk_firmware/pull/9205#discussion_r430783182 * Solve comments https://github.com/qmk/qmk_firmware/pull/9205#discussion_r430783182 & https://github.com/qmk/qmk_firmware/pull/9205#discussion_r430783884 * Format code more according to https://docs.qmk.fm/#/coding_conventions_c * change logic to LUT * WIP: Clean up * WIP: Solution with xor operators to mask the change * delete #endif & added the missed xor operator (ahhh) * Variable (mouse_report->buttons): avoid setting twice https://github.com/qmk/qmk_firmware/pull/9205#discussion_r430783884 * Update tmk_core/protocol/ps2_mouse.c Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: juank <juank@fktech.net> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-08-06Arm ps2 mouse interrupt (#6490)JohSchneider
* ps2_mouse on ARM: an interrupt-version of the ps2-mouse code ported to ARM/chibios * ps2_mouse on ARM: link EXT callback-channel selection to the user defined PS2_LINE_CLOCK * ps2_mouse on ARM: replace DELAY_X defines with hardware-agnostic wait_X * ps2_mouse on ARM: replace chibios-specific defines for the pins/lines with defines from quantum/config_common.h and drop the '_LINE' component from teh define name * ps2_mouse on ARM: expose the software-intterupt port as a user editable define * Update docs/feature_ps2_mouse.md Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update feature_ps2_mouse.md * use a define to deduce the PS_DATA_PORT instead * reduce all-zero extcfg to oneliner * ps2_mouse: use generic wait instead of avr-delay * Update docs/feature_ps2_mouse.md * ps2_mouse: changes for new chibios version (17.6.0 -> 19.1.0) replacing the legacy externa-interrupt driver with pal-callbacks * ps2_mouse: use PLATFORM_KEY Co-Authored-By: Joel Challis <git@zvecr.com> * ps2_mouse: clang-format corrections * ps2_mouse: add systemlocks using the chibios equivalent to AVRs cli: chSys[Unl|L]ock Co-authored-by: Johannes <you@example.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com>
2021-08-04Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-04Updated settings.json file to fit VSC's docs (#13829)Changsu Park
This change fixes the warning caused by deprecated way of configuring terminal profiles. The warning caused by old settings.json is the following: This is deprecated, the new recommended way to configure your default shell is by creating a terminal profile in `#terminal.integrated.profiles.windows#` and setting its profile name as the default in `#terminal.integrated.defaultProfile.windows#`. This will currently take priority over the new profiles settings but that will change in the future. Refer to the link below for more information: https://code.visualstudio.com/docs/editor/integrated-terminal#_configuration
2021-08-03Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-08-02[Docs] Remove extra word it bootmagic page (#13855)plarso
2021-07-31__flash? (#13799)Joel Challis
2021-07-31Move some led drivers to common folder (#13749)Joel Challis
* Move some led drivers to common folder
2021-07-30Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-31Explicitly state that VIA should not be enabled in the default keymap. (#13803)Nick Brassel
2021-07-30Port new_keyboard.sh to CLI (#13706)Ryan
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2021-07-30Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-30`qmk docs`: Add flag to open in browser (#13788)Ryan
* `qmk docs`: Add flag to open in browser * Add docs
2021-07-29Merge remote-tracking branch 'upstream/master' into developJames Young
2021-07-29[Docs] Added information on soldering diodes in parallel (#13117)officereso
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-07-29Remove references to info.json `width` and `height` in CLI (#13728)Ryan
2021-07-28Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-28matrix_scan_x -> x_task (#13748)Joel Challis
2021-07-28fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754)Shane Celis
`ON_TOGG` doesn't exist in the codebase.
2021-07-27Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-26[Docs] Add `default` case in Tap Dance Example 6 (#13727)ForsakenRei
Added a `default` case in `switch(ql_tap_state.state)` at line 493 and 494. Without it compile firmware with Example 6 code will encounter 2 errors: `enumeration value 'TD_NONE' not handled in switch` `enumeration value 'TD_UNKNOWN' not handled in switch`
2021-07-25Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-25Allow output of logging when running unit tests (#13556)Joel Challis
* Initial pass at enabling logging for unit tests * Add to docs * Bind debug for more test types * Force everything * Tidy up slightly
2021-07-24Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588)Drashna Jaelre
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-07-25docs/cli_commands: fix typo (#13697)Marc Tamsky
2021-07-24Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines (#13689)Drashna Jaelre
2021-07-24[Docs] Fix typo in dip switch example (#13688)Dasky
2021-07-24Remove deprecated callbacks for encoders and dip switches (#13404)Drashna Jaelre
2021-07-23CLI/Docs: Fix the format commands' name (#13668)Erovia
PR #13296 changed the name of the `cformat` and `pyformat` commands to `format-c` and `format-py` respectively. This PR updates the documentation and some parts of the CLI to use the new names. Also add documentation for the new `format-text` subcommand, introduced in the same PR.
2021-07-21Retain brightness with lighting layers (#13025)Patrick Stadler
Add guard `RGBLIGHT_LAYERS_RETAIN_VAL` to retain the currently used val when applying lighting layers.
2021-07-20Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-20[Docs] Added note about no split support (#12512)aydenvis
Currently, this feature isn't supported on splits, spent about an hour troubleshooting my board and firmware before asking, and turns out it's not in place. Note added to save others from this in the future.
2021-07-19[Bug] Develop - Change uint32_t to layer_state_t (#13596)Xelus22
* fix sat75 * update uint32_t to layer_state
2021-07-16Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-17Improve driver installation docs (#13562)Ryan
2021-07-16Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-07-16Remove unwanted notes (#13563)shela