summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* [Docs] add sync options heading, update led indicators (#14441)Dasky2021-09-152-8/+13
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] fixed incorrect amount of steps for oled usage (#13519)vsrivastava2021-09-141-1/+1
| | | | | changed line 21 from saying "three steps" to "two steps" as there are only two steps Co-authored-by: feynmantf <46390109+feynmantf@users.noreply.github.com>
* update compatible_microcontrollers.md translation (#14401)umi2021-09-121-2/+2
|
* Remove width, height and key_count from info.json (#14274)Ryan2021-09-122-16/+4
|
* Change USBasp and bootloadHID bootloaders to lowercase (#14354)Ryan2021-09-105-36/+36
|
* Align rgb/led matrix docs with current behaviour (#14367)Joel Challis2021-09-102-60/+60
|
* Bugfix for Joystick and JSON schema (#14295)Ryan2021-09-091-3/+2
|
* Highlight keycode (#14317)Niko Wenselowski2021-09-051-1/+1
| | | This should make it consistent with other docs and hopefully will make less people miss this detail.
* [Core] Add `is_oled_scrolling` (#14305)JayceFayne2021-09-051-0/+4
|
* Fix Space Cadet md link (#14300)JayceFayne2021-09-041-1/+1
|
* [Docs] Update path to keycode.h (#14263)qieq2021-09-011-1/+1
|
* Documentation: Fix links in key overrides (#14228)coliss862021-08-311-1/+1
| | | Co-authored-by: Joel Challis <git@zvecr.com>
* move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230)Zach White2021-08-292-2/+2
|
* Bootmagic lite docs clarity. (#14204)Nick Brassel2021-08-291-1/+1
|
* 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198)Nick Brassel2021-08-293-6/+565
| | | | | | | | | | | | | * Initial changelog. * Data driven. * Submodule update. * Updated breaking changes docs. * Aliases. * Aliases.
* [Docs] Add examples to RGB Matrix Indicators docs (#12797)Drashna Jaelre2021-08-271-0/+39
|
* [Core] Refactor OLED to allow easy addition of other types (#13454)Xelus222021-08-241-3/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add docs * core changes * update keyboards to new OLED * updated users to new OLED * update layouts to new OLED * fixup docs * drashna's suggestion * fix up docs * new keyboards with oled * core split changes * remaining keyboard files * Fix The Helix keyboards oled options * reflect develop Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: mtei <2170248+mtei@users.noreply.github.com>
* adding uf2 flash support for blackpill 401 (#13968)Path Nirvana2021-08-241-1/+1
| | | | | | | | | | | | | * adding uf2 flash support for blackpill 401 * forgot to add blackpill to keyboard header file * making changes requested by drashna * fixing tzarc s comments * removing the keyboard * undo the change to dactyl_manuform.h
* Make solo half of split keyboards (more) usable. (#13523)Joakim Tufvegren2021-08-222-3/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Make solo half of split keyboards (more) usable. Using only one half of a split keyboard (that's using the split_common framework to communicate) is not a great experience, since several read timeouts per scan cycle cause an unusably slow scan rate. This change blocks all split communication attempts for 500 ms (configurable) after an error occurs, causing the scan rate to become at least _more_ usable, but might need some tweaking to work fully on most keyboards. One read timeout still needs to occur after the 500 ms has passed, and if that timeout isn't low enough, some scan cycles may still be too slow. * Fix lint complaint. * Require 25 consecutive comm errors to see comms as disconnected. The number of max errors can be overridden by defining `SPLIT_MAX_CONNECTION_ERRORS`. * Add comments to new defines, and ability to disable disconnection check. Also increase `SPLIT_MAX_CONNECTION_ERRORS` to 40, since it's divisible by most relevant numbers for the description. * Make lint happy ...again * Only update `connection_check_timer` when needed. * Add new defines to split keyboard documentation. * Move connection timeout logic to transport.c, add `is_transport_connected`. * Use split_common disconnection logic in matrix.c. Instead of doing more or less the same thing twice. * Move disconnection logic to `transport_master`. Is a cleaner implementation, and causes the scan rate while disconnected to increase instead of decrease. * Lint fixes. * Lower default `SERIAL_USART_TIMEOUT` to 20 ms. The read timeout must be low enough to not cause exessively long scan cycles when using a solo split half. 10 ms was determined from testing to work fine even with the slowest defined baudrate of 19200 (5 ms was too low for that case), so 20 ms should be fine for most cases. * Remove `SERIAL_USART_TIMEOUT` from ergodox_infinity/config.h Was somewhat mistakenly included in an earlier PR. * Fix building with `USE_I2C`. * Reduce built firmware size. Not really sure why this works, the idea was taken from tzarc's work on split disconnection. * Tweak and improve opt-out for split disconnection logic. There are now two ways to opt out from this feature: * Set `SPLIT_MAX_CONNECTION_ERRORS` to 0. This will completely disable the connection status checks (also affects the slave matrix reset logic in matrix.c, though). * Set `SPLIT_CONNECTION_CHECK_TIMEOUT` to 0. This will only disable the communication throttling while disconnected. Will make the firmware smaller. * Make split disconnection logic work with custom transports. Includes a fallback implementation for keyboards using a custom split_util.c but not a custom matrix.c (currently no such keyboard seems to be merged, though). * Remove unnecessary include of timer.h Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-2017-17/+3
|\
| * [Core] [Docs] Remove travis-ci references (#13916)Spaceman2021-08-2017-17/+3
| |
* | Added right vs left specific pin assignments for dip switch (#13074)XScorpion22021-08-192-1/+4
| | | | | | | | | | | | | | * Added right vs left specific pin assignments for dip switch * Update feature_dip_switch.md * Ran formatting tools
* | Allow for removal of hysteresis on 4x encoders (#13698)tucvbif2021-08-181-0/+6
| | | | | | | | | | | | | | * Remove hysteresis on 4x encoders Sometimes, controller skips encoder pulses and when it returns to default position, the encoder_pulses variable isn't equals 0. And when I turn encoder in opposite direciton, it skips first click becase of encoder_pulses crosses zero. To prevent this, I add the ENCODER_DEFAULT_POS constant, and reset encoder_pulses into 0 when the state variable equals ENCODER_DEFAULT_POS. * Documentation for ENCODER_DEFAULT_POS
* | Add a toggle key for GUI On/Off in Magic feature (#13830)Drashna Jaelre2021-08-181-0/+1
| |
* | `--parallel` improvements (#13800)ruro2021-08-181-3/+14
| | | | | | | | | | | | | | * improve make parallel jobs support * document the --parallel option * disable the output-sync for interactive targets
* | Digitizer HID interface : absolute coordinates for mouse cursor (#12851)a-chol2021-08-182-0/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add digitizer HID interface for setting the mouse cursor position at absolute screen coordinates. Tested on Pro Micro, Proton C and Blackpill. * Update docs/feature_digitizer.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-authored-by: Ryan <fauxpark@gmail.com> * Add missing copyrights Add V-USB support * Add support for digitizer dedicated endpoint for lufa and chibios. Fix formatting issues Move digitizer_task definition to the feature's base implementation file * Run cformat on modified files * Change digitizer report usage to Digitizer instead of Pen to avoid pointer disappearing on Windows. * Update tmk_core/protocol/vusb/vusb.c Co-authored-by: Ryan <fauxpark@gmail.com> * Run cformat from docker image * Remove send_digitizer from host_driver_t and instead rely on the declaration being the interface to the implementation in each HW-specific usb implementation. * Fix build : send_digitizer shouldn't be static in vusb and add weak-linkage implementation for tests without usb implementation * Change digitizer user interface to match pointing device's * Update documentation with new API Co-authored-by: a-chol <nothing@none.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* | Steno combinedkeys (#12538)freqmod2021-08-181-0/+15
| | | | | | | | | | * Add support for steno keys that press adjacent keys simultaniously * Add some docs for steno combined keys
* | Rgb matrix/enable modes explicitly (#13758)Drashna Jaelre2021-08-182-60/+60
| | | | | | | | | | | | | | | | | | | | | | * Change animations to require explicet activation * Add support for legacy config * Make default for now * Add LED Matrix support * change LED Matrix docs
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-171-82/+88
|\|
| * update feature_tap_dance.md translation (#13496)s-show2021-08-181-82/+88
| | | | | | | | | | | | | | | | | | | | | | * update feature_tap_dance.md translation * Update docs/ja/feature_tap_dance.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update based on comment. Co-authored-by: shela <shelaf@users.noreply.github.com>
* | Fixup Audio startup and add to documents (#13606)Drashna Jaelre2021-08-151-0/+26
| | | | | | | | | | * Fixup Audio startup and add to documents * fix doc descriptions
* | Enable sync of OLED/ST7565 display on/off state on Splits (#13542)Drashna Jaelre2021-08-152-0/+18
| | | | | | | | | | | | | | | | | | * Enable sync of OLED/ST7565 display on/off state on Splits * Only send if states are not matched Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
* | [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321)Zach White2021-08-142-0/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * new keyboard: handwired/directpins * fix promicro keyboard_name * add teensy2 and teensy2++ support * align with handwired/onekey * tweak pids * add teensy 3.2 and teensy lc to directpins * move directpins from handwired to ez_maker * add docs for easy maker
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-141-75/+80
|\|
| * Rework keymap_extras docs (#13949)Ryan2021-08-151-75/+80
| |
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-121-0/+35
|\|
| * Update 20210529.md (#13170)Felix Sargent2021-08-131-0/+35
| | | | | | This was confusing to me when I updated, so I want to make it more clear for those that come after.
* | Fix some additional bootmagic settings (#13979)Drashna Jaelre2021-08-121-1/+1
| |
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-104-0/+66
|\|
| * Architecture documentation for Configurator and API (#13935)Zach White2021-08-104-0/+66
| | | | | | | | | | | | | | | | | | * 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>
* | Merge remote-tracking branch 'origin/master' into developQMK Bot2021-08-101-0/+2
|\|
| * Update feature_wpm.md (#13936)Stefan Subich2021-08-101-0/+2
| | | | | | Fix example markdown code formatting
* | Remove backwards compatibility of debounce names (#13877)Joel Challis2021-08-092-34/+0
| | | | | | | | | | | | | | * Remove backwards compatibility of debounce names * Update docs * Update keyboards/keymaps
* | Add support for STM32F407x MCUs. (#13718)thpoll832021-08-092-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* | Remove Full Bootmagic (#13846)James Young2021-08-0612-176/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404)Sergey Vlasov2021-08-071-19/+89
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* | Process combos earlier & overlapping combos (#8591)Pete Sevander2021-08-062-34/+272
| | | | | | | | | | | | | | | | | | | | | | |