summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-11-26New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036)precondition
* New feature: `DYNAMIC_TAPPING_TERM_ENABLE` 3 new quantum keys to configure the tapping term on the fly. * Replace sprintf call in tapping_term_report by get_u16_str * Replace tab with 4 spaces
2021-11-25Tidy up adjustable ws2812 timing (#15299)Joel Challis
2021-11-25Add ifndef to WS2812 timing constraints (#14678)Jordan Banasik
* Add ifndef to WS2812 timing constraints Due to the way that the PrimeKB Meridian PCB was designed, this change is needed in order to properly adjust the LEDs. Testing: * Compiled primekb/meridian:default successfully * Compiled random board (walletburner/neuron:default) successfully * Fix linting errors Missed some spacing * More linting fixes Spacing on the comments... really? * Rename WS2812 timing parameters for clarity; add comments * Add docs update for the WS2812 timing macros * Fix typo on comment * Add ifndef for WS2812_RES * Update double backticks and table with parameters * Move timing adjustments documentation to ws2812_drivers * Move timings adjustment discussion to bitbang section * Update T0H and T1H definitions in subtractions * format Co-authored-by: Gondolindrim <alvaro.volpato@usp.br> Co-authored-by: zvecr <git@zvecr.com>
2021-11-25Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto ↵Isaac Elenbaas
Shifts (#11059) * Add Retro Shift and Custom Auto Shifts * Fix compilation errors with no RETRO_SHIFT value
2021-11-24Remove use of __flash due to LTO issues (#15268)Joel Challis
2021-11-23[Docs] Squeezing space out of AVR (#15243)Drashna Jaelre
* [Docs] Squeezing space out of AVR * Add more info * Apply suggestions from code review Co-authored-by: Nick Brassel <nick@tzarc.org> * Add oled section * Apply suggestions from code review Co-authored-by: Nick Brassel <nick@tzarc.org> * Update layers and intro wording * Rename doc file * add get_u8_str support * oled clarifications Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-11-22Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-23layer_combo → sd_combo (#15266)precondition
2021-11-22Macros in JSON keymaps (#14374)Zach White
* macros in json keymaps * add advanced macro support to json * add a note about escaping macro strings * add simple examples * format json * add support for language specific keymap extras * switch to dictionaries instead of inline text for macros * use SS_TAP on the innermost tap keycode * add the new macro format to the schema * document the macro limit * add the json keyword for syntax highlighting * fix format that vscode screwed up * Update feature_macros.md * add tests for macros * change ding to beep * add json support for SENDSTRING_BELL * update doc based on feedback from sigprof * document host_layout * remove unused var * improve carriage return handling * support tab characters as well * Update docs/feature_macros.md Co-authored-by: Nick Brassel <nick@tzarc.org> * escape backslash characters * format * flake8 * Update quantum/quantum_keycodes.h Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-11-20Rework encoders to enable asymmetric split keyboards (#12090)Balz Guenat
Co-authored-by: Balz Guenat <balz.guenat@siemens.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-11-19Move tmk_core/common/<plat> (#13918)Joel Challis
2021-11-18[Docs] Clarify "nested" and "rolling" key sequences (#14655)Henré Botha
2021-11-17Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-17Call steno_set_mode inside eeconfig_init_user in the doc (#15176)Alexis Jeandeau
2021-11-16Rename RGB fractal (#15174)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-15Require explicit enabling of RGB Matrix modes (#15018)Drashna Jaelre
2021-11-16Reimplements WPM feature to be smaller & precise (#13902)vectorstorm
* Reimplements WPM feature. - Now calculates exact WPM over the last up to three seconds of typing. - WPM_SMOOTHING removed, as it's no longer needed. - WPM_SAMPLE_SECONDS added, to specify how long a period to average WPM over, set to 5 seconds by default. - WPM_SAMPLE_PERIODS added, to specify how many sampling buffers we'll use. Each one uses one extra byte of space. Having more will lead to smoother decay of WPM values. Defaults to 50 (we're saving so many bytes of firmware space I felt like being extravagent, and this change is still a big size saving overall) - WPM_UNFILTERED option added (defaults to unset), which disables all filtering within the WPM feature. This saves some space in the firmware and also reduces latency between typing and the WPM calculation measuring it. (saves 70 bytes in my tests) - WPM_LAUNCH_CONTROL added (defaults to unset). When typing begins while the current displayed WPM value is zero, the WPM calculation only considers the time elapsed since typing began, not the whole WPM_SAMPLE_SECONDS buffer. The result of this is that the displayed WPM value much more rapidly reaches an accurate WPM value, even when results are being filtered. (costs 22 bytes in my tests) - Updates documentation to reflect changed options. Saves about 900 bytes, in my tests, compared against the previous implementation, with default settings. * Apply suggestions from code review Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Trevor Powell <trevor@vectorstorm.org> Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2021-11-15Add support for deferred executors. (#14859)Nick Brassel
* Add support for deferred executors. * More docs. * Include from quantum.h * Cleanup. * Parameter checks * Comments. * qmk format-c * I accidentally a few words. * API name change. * Apply suggestions from code review Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Review comments. * qmk format-c * Review comments. Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2021-11-14Rework and expand Pointing Device support (#14343)Drashna Jaelre
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2021-11-13Update UART driver API (#14839)Ryan
* Add uart_puts() and uart_gets() * Add some docs * Rework API * Formatting * Update docs/uart_driver.md Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Simplify a uart_write() loop * Update platforms/avr/drivers/uart.c Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
2021-11-13Merge remote-tracking branch 'origin/master' into developDrashna Jael're
2021-11-13Fix hebrew emoji in langs.md (#15140)peepeetee
2021-11-12Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-12[Docs] Correct logic of tap hold statement (#14992)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-12Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-12[Docs] Codify not using code from other keyboards in PRs (#15128)Drashna Jaelre
* [Docs] Codify not using code from other keyboards in PRs * add additional comments
2021-11-05Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-05Add example for turning off RGB colors and retaining indicator function (#14997)Albert Y
* Add init function for solid effect with colors off * Restructure sentence Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-05Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-05Rework ISP flashing guide (#14938)Ryan
Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2021-11-05Merge remote-tracking branch 'upstream/master' into developNick Brassel
2021-11-05CLI: Add 'cd' subcommand (#12584)Erovia
* CLI: Add 'cd' subcommand Go to your qmk_firmware dir with ease. * Fix for Windows and do not run if already under QMK Home * Make flake8 happy * Fix prompt for Windows * Make flake8 happy once again * I'll get it right eventually * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Add subcommand to __init__.py and fixup after rebase * Update Windows code to use milc's run * Unify the subshell starting with os.execl * Exit with error msg when output is redirected to non-TTY. * Revert Windows-specific code Co-authored-by: Ryan <fauxpark@gmail.com>
2021-11-05Remove `BOOTMAGIC_ENABLE = lite` option (#15002)James Young
* remove BOOTMAGIC_ENABLE=lite setting * change keyboard BOOTMAGIC_ENABLE rules Edits keyboard-level instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. * change keyboard BOOTMAGIC_ENABLE inline comments Edits keyboard-level BOOTMAGIC_ENABLE inline comments to "Enable Bootmagic Lite". * change keymap BOOTMAGIC_ENABLE rules Edits keymap-level instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. * change keymap BOOTMAGIC_ENABLE inline comments Edits/adds keymap-level BOOTMAGIC_ENABLE inline comments to read "Enable Bootmagic Lite". * change layout/user BOOTMAGIC_ENABLE rules/comments Edits instances of `BOOTMAGIC_ENABLE = lite` to `BOOTMAGIC_ENABLE = yes`. Edits/adds keymap-level BOOTMAGIC_ENABLE inline comments to read "Enable Bootmagic Lite". * update non-rules.mk BOOTMAGIC_ENABLE references in keyboards/ * remove docs references to Full Bootmagic * convert data-driven Bootmagic Lite instances * remove Bootmagic Lite bodge from data-driven generation * Merge remote-tracking branch 'upstream/develop' into rm/bootmagic-full_q4a * update docs/ja/config_options.md per mtei * update docs/faq_misc.md per mtei Remove remaining Full Bootmagic reference.
2021-11-04Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-05Refactor new-keyboard to be python3.7 compatible (#14707)Mikkel Jeppesen
* Use copy_tree from distutils for python 3.7 support * Bump python version in docs * Changed new-keyboard to use printf-style format strings * Use username for manunfacturer / maintainer * Update lib/python/qmk/cli/new/keyboard.py Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: Zach White <skullydazed@drpepper.org>
2021-11-04Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-05`qmk docs`: Run `docsify serve` if available (#15056)Ryan
2021-11-03Basic keycode overhaul (#14726)Ryan
2021-11-03Update to ChibiOS 20.3.4, support builds against trunk (#14208)Nick Brassel
* Add support for building against ChibiOS svn/trunk. * Swap to 21.6.x * Update to latest branch revision as released version is broken. * Updated configs. * Conf updates. * Updated ChibiOS * Convert STM32L422 to actual L422 ChibiOS platform. * Downgrade to 20.3.4 as ChibiOS 21.6.x is being aborted. * Rollback L422-based boards.
2021-11-02Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-11-02Clarify placement of configuration options (#15015)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-02haptic: Feature to disable it when usb port is not configured or suspended. ↵Purdea Andrei
(#12692) This also add support for specifying a LED pin to indicate haptic status, and also adds support for a haptic-enable pin, which is useful to turn off the boost converter on the solenoid driver.
2021-11-02Add Pixel Rain RGB Matrix effect (#14155)Albert Y
* Add Pixel animation header file * Add Pixel animation to documentation * Add Pixel animation to core include file * Remove unintended spaces * Remove seeding of PRNG * Increase frequency of lit keys Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-02Enable de-ghosting for RGB/LED matrix on all ISSI LED drivers (#14508)donicrosby
* Initial work for de-ghost enable * Dumb mistake with the redefine * Added Copywrite stuff on source files * Fixed whitespace errors * Added support for all ISSI LED drivers * Updated docs for support for ISSI LED driver pull-up pull-down * Applied clang format * Added 'boolean' flag to enable de-ghosting for the is31fl3731 IC * Fixed some of the grammer in the docs * Fixed comment placement and grammer of comment * Fixed whitespace errors from lint Co-authored-by: donicrosby <donicrosby1995@gmail.com>
2021-11-02[Core] Change OLED task function to be boolean (#14864)Drashna Jaelre
* [Core] Add kb level callbacks to OLED driver * Update keyboards and keymaps * Update docs * Update userspace configs * Add fix for my keymap ... * update lefty
2021-11-02Add support for ISSI drivers on both sides of a split keyboard (#13842)Vlad K
* Gets RGB working on a split keyboard with IS31FL3733. Currently needs small tweak to re-enable WS2812 * Added helper function * Trying to integrate the function * Moved functionality into a macro * Swapped conditional for a macro everywhere * Tidying up * More code cleanup * Documentation updates * Fixed formatting via linter * Switching to a function from a macro * Fixed compile error * Fixing WS2812 behavior. UNTESTED. * Updated documentation about the driver addresses. * Fixed code for WS2812 * Trying to add in LED_MATRIX support * Updated effects for LED matrix * Updated third-party effect defines. * Ran format-c on modified files * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Move to static inline. Avoids issues with gcc v8+ * Move helper function for LED_matrix to static inline to avoid issues with gcc v8+ Co-authored-by: Vlad Kvitnevskiy <vladkvit@outlook.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2021-11-02Add Fractal RGB matrix effects (#12670)Albert Y
* Squashed fractal effect commit for easier rebase * Update documentation * Squashed fractal effect commit for easier rebase * Update documentation * Update doc spacing Co-authored-by: Ryan <fauxpark@gmail.com> * Update feature_rgb_matrix.md Co-authored-by: filterpaper <filterpaper@localhost> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
2021-10-30Enable configuration of PWM frequency for IS31FL3733B (#14983)Joel Challis
* Enable PWM frequency for IS31FL3733B * Document config option * clang
2021-10-27Merge remote-tracking branch 'origin/master' into developQMK Bot
2021-10-27[Docs] Add instructions to create keymap before proceeding (#14945)Albert Y
Co-authored-by: filterpaper <filterpaper@localhost>