summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-10-06[CLI] Add c2json (#8817)Erovia
* Basic keymap parsing finally works * Add 'keymap.json' creation to the qmk.keymap module * Add tests and fix formatting * Fix/exclude flake8 errors * Convert keymap.c to valid keymap.json * Fix some errors * Add tests * Finalize keymap.json creation, add json template * Add docs * Move pygments to the standard requirements * Add support for nameless layers, fix tests * Fix things after rebase * Add missing 'keymap' value. * Fix missing layer numbers from advanced keycodes Buckwich noticed that if the advanced keycode / layer toggling key contains a number, it goes missing. Now we properly handle them. Thx for noticing! * Apply suggestions from code review * fixup tests Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: skullY <skullydazed@gmail.com>
2020-10-05Fixes small typo in docs (#10515)Joe Strong
2020-10-03Mark 'key_count' as optional within info.json docs (#10513)George Mao
* Update reference_info_json.md key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array. * Updated Japanese documentation as well
2020-10-01Doc followup 9942 (#10473)nopunin10did
* Update feature_advanced_keycodes.md * Update mod_tap.md
2020-09-27Consolidate udev rules into a single file (#9693)Ryan
* Consolidate udev rules into a single file * Update rules in doctor.py * Simplify doctor rule checking * Fix errors * Add TMK "FEED" VID to list of deprecated udev rules * A comma would be nice * Split rules back up into bootloaders * Link to docs page in "missing" case * Add Pololu VID * Be more specific about Caterina devices, and add LilyPad PID
2020-09-26[Docs] Wording & formatting changes in the Tapping Force Hold section of the ↵precondition
Tap Hold page + removed trailing whitespaces (#10391) * Wording & formatting changes in Tapping Force Hold The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes around "tapping". * Removed all trailing whitespaces from tap hold doc * "it's simply really:" → "it's simple really:" * "This allows to keep the ability" → "This allows keeping the ability" Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs. Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
2020-09-22[Docs] Japanese translation of docs/understanding_qmk.md (#10136)umi
* add understanding_qmk.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment
2020-09-22Add description in Bluetooth docs for requiring NKRO to be disabled (#10359)Peter Landoll
2020-09-21Add OLED driver function to determine if the screen is currently on (#10382)Fred Silberberg
2020-09-21[Docs] Clarify functionality of update_tri_layer_state (#10370)Dustin Bosveld
* Add information to docs - If layer z is not a higher layer than both x and y, the layer change code does not function correctly. * Update docs/ref_functions.md * Update docs/ref_functions.md * Update docs/ref_functions.md
2020-09-19Be more specific about Caterina devices, and add LilyPad PIDfauxpark
2020-09-19Add Pololu VIDfauxpark
2020-09-19Add TMK "FEED" VID to list of deprecated udev rulesfauxpark
2020-09-19Update rules in doctor.pyfauxpark
2020-09-19Consolidate udev rules into a single filefauxpark
2020-09-17[Docs] Japanese translation of docs/tap_hold.md (#10017)umi
* add tap_hold.md translation * update based on comment * update based on comment * update based on comment
2020-09-17Update led_conf_t example (#10327)TJ
2020-09-13Fixed typo in vscode docs (#10303)undermark5
.vscode/c_cpp_properies.json -> .vscode/c_cpp_properties.json
2020-09-11[Docs] Update Japanese translation of feature_split_keyboard.md (#10283)Takeshi ISHII
Apply #10242 changes to ja/feature_split_keyboard.md
2020-09-08[Docs] Japanese translation of docs/reference_keymap_extras.md (#10138)umi
* add reference_keymap_extras.md translation * update based on comment * update based on comment * update based on comment
2020-09-06Replace figures in docs/feature_split_keyboard.md (#10242)Takeshi ISHII
* Replace figures in feature_split_keyboard.md * fig update * Update docs/feature_split_keyboard.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-09-06quantum/debounce: rename debouncing algorithms (#9564)Purdea Andrei
* quantum/debounce: rename debouncing algorithms according to Issue 8763 This is the second attempt at implementation, with no ts_ and cy_ prefixes, since those will be implemented with macros. * Debouncing documentation: Refactor, add some generic info, and merge into a single document
2020-09-06Docs/PR_checklist: Reorder, unify and pet-peeves (#10253)Erovia
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-09-05[Docs] Japanese translation of docs/reference_configurator_support.md (#9879)umi
* add reference_configurator_support.md translation * update based on comment * update based on comment * update based on comment * update based on comment
2020-09-04fix link in docs/ja/*.md (#10232)Takeshi ISHII
* fix link in docs/ja/feature_split_keyboard.md * fix link in docs/ja/faq_build.md * fix link in docs/ja/faq_general.md * fix link in docs/ja/faq_keymap.md * fix link in docs/ja/how_a_matrix_works.md * fix link in docs/ja/reference_glossary.md
2020-09-03[Docs] Japanese translation of docs/serial_driver.md (#10014)umi
* add serial_drive.md translation * update table style * update based on comment * update based on comment
2020-09-03[Docs] Japanese translation of api_*.md (#9992)umi
* add api related translation * update based on comment * update based on comment * update based on comment
2020-09-03[Docs] Japanese translation of docs/reference_glossary.md (#9880)umi
* add reference_glossary.md translation * update based on comment * update based on comment * update based on comment
2020-09-03[Docs] Japanese translation of docs/quantum_keycodes.md (#10137)umi
* add quantum_keycodes.md translation * update based on comment
2020-09-03[Docs] Japanese translation of docs/syllabus.md (#10016)umi
* add syllabus.md translation * update based on comment * update based on comment
2020-09-03[Docs] Japanese translation of docs/support.md (#10015)umi
* add support.md translation * update based on comment
2020-09-04[Docs] Japanese translation of docs/translating.md (#10018)umi
* add translating.md translation * update based on comment * update based on comment
2020-09-04[Docs] Japanese translation of docs/reference_info_json.md (#9881)umi
* add reference_info_json.md translation * update based on comment * update based on comment
2020-09-01[Docs] Japanese translation of docs/ref_functions.md (#9878)umi
* add ref_functions.md translation * modify internal link for ja * update based on comment * reflect #9892 change * update based on comment * update based on comment
2020-08-29update "Breaking Changes" docJames Young
2020-08-29Add ChangeLog for 2020 Aug 29 Breaking ChangesJames Young
2020-08-29Allow joysticks to be used without analog pins (#10169)Zach White
* Allow joysticks to be used without analog pins * change how analog/digital joysticks are specified
2020-08-29Remove support for Adafruit EZ-Key (#10103)Ryan
* Remove support for Adafruit EZ-Key * Update docs/ja/feature_bluetooth.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-08-29Add a method to read the OLED display buffer from user space (#8777)Richard
* Adding extern and declaration * Change to mediated buffer read * Adding raw byte read * Restore write raw... D'Oh * Working struct return * Pack that struct * Remove conditional packing and add example to docs * Cleanup tab/spaces * Update docs/feature_oled_driver.md Prettify formatting * Update drivers/oled/oled_driver.h Prettify formatting
2020-08-29Better handle LTO_ENABLE (#9832)Drashna Jaelre
* Better handle LTO_ENABLE Especially when calling from command line * Replace LINK_TIME_OPTIMIZATION_ENABLE with LTO_ENABLE * Remove long for LTO from show_options.mk
2020-08-29Remove f072 backlight warning (#10040)Joel Challis
* Remove f072 backlight warning * Remove f072 backlight warning from docs
2020-08-29#define AUTO_SHIFT_SETUP (#8441)Greg Wright
* #define AUTO_SHIFT_SETUP * Clarification Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP * AUTO_SHIFT_NO_SETUp
2020-08-29Add `st-flash` flash target (#9964)Sergey Vlasov
* Add `st-flash` flash target Add support for flashing the firmware via the `st-flash` utility from the STLink Tools package (https://github.com/stlink-org/stlink). * Add `st-flash` to the `qmk flash -b` output
2020-08-29Noeeprom functions for rgb_matrix (#9487)Tynan Beatty
* Add eeprom_helpers for toggle, mode, sethsv, speed; add set_speed; add noeeprom versions of toggle, step, hue, sat, val, and speed * qmk cformat rgb_matrix * Add rgb_matrix_set_speed and *_noeeprom functions * Do not expose rgb_matrix_*_eeprom_helper functions
2020-08-29Tweak the Christmas animation effect to be less harsh on the eyes (#7648)Max Rumpf
* Tweak the Christmas animation effect to be less harsh on the eyes * Further improve the tweaked Christmas animation code - Use constants where it makes sense - Instead of complicated math, use a static variable to keep track if it's animating from or to red - Don't use pow (but a simple macro instead) - Using floating point math is necessary for the fraction in the cubic bezier function to work * Update docs for the tweaked Christmas animation effect * Further improve memory usage - Don't use floats, but 32 bit ints instead (where needed) - Replace limits.h with constant * Fix typo
2020-08-29Hid joystick interface (#4226)a-chol
* add support for hid gamepad interface add documentation for HID joystick Add joystick_task to read analog axes values even when no key is pressed or release. update doc Update docs/feature_joystick.md Manage pin setup and read to maintain matrix scan after analog read * Incorporates patches and changes to HID reporting There are some patches provided by @a-chol incorporated on this commit, and also some changes I made to the HID Report structure. The most interesting is the one dealing with number of buttons: Linux doesn't seem to care, but Windows requires the HID structure to be byte aligned (that's in the spec). So if one declares 8/16/32... buttons they should not have any issues, but this is what happens when you have 9 buttons: ``` bits |0|1|2|3|4|5|6|7| |*|*|*|*|*|*|*|*| axis 0 (report size 8) |*|*|*|*|*|*|*|*| ... |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| axis 6 |*|*|*|*|*|*|*|*| first 8 buttons (report size 1) |*| | | | | | | | last of 9 buttons, not aligned ``` So for that I added a conditonal that will add a number of reports with size 1 to make sure it aligns to the next multiple of 8. Those reports send dummy inputs that don't do anything aside from aligning the data. Tested on Linux, Windows 10 and Street Fighter (where the joystick is recognized as direct-input) * Add save and restore of each pin used in reading joystick (AVR). Allow output pin to be JS_VIRTUAL_AXIS if the axis is connected to Vcc instead of an output pin from the MCU. Fix joystick report id Fix broken v-usb hid joystick interface. Make it more resilient to unusual settings (none multiple of eight button count, 0 buttons or 0 axes) Correct adc reading for multiple axes. Piecewise range conversion for uncentered raw value range. Input, output and ground pin configuration per axis. Documentation fixes * Fix port addressing for joystick analog read * The other required set of changes As per the PR, the changes still holding it up. Add onekey for testing. Fix ARM builds. Fix device descriptor when either axes or buttons is zero. Add compile-time check for at least one axis or button. Move definition to try to fix conflict. PR review comments. qmk cformat * avoid float functions to compute range mapping for axis adc reading * Remove V-USB support for now. Updated docs accordingly. * Update tmk_core/protocol/lufa/lufa.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Add support for joystick adc reading for stm32 MCUs. Fix joystick hid report sending for chibios * Fix HID joystick report sending for ChibiOS. Add one analog axis to the onekey:joystick keymap. Fix pin state save and restore during joystick analog read for STM32 MCUs. * Update tmk_core/protocol/chibios/usb_main.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/lufa/lufa.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Add missing mcuconf.h and halconf.h to onekey:joystick keymap. Add suggested fixes from PR. * Switch saveState and restoreState signature to use pin_t type. onekey:joystick : add a second axis, virtual and programmatically animated. * Update docs/feature_joystick.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Update docs/feature_joystick.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Add PR corrections * Remove halconf.h and mcuconf.h from onekey keymaps * Change ADC_PIN to A0 Co-authored-by: achol <allecooll@hotmail.com> Co-authored-by: José Júnior <jose.junior@gmail.com> Co-authored-by: a-chol <achol@notamail.com> Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-08-29Update features to use Custom Tapping Term when appropriate (#6259)Drashna Jaelre
* Update Space Cadet to use Custom Tapping Term functionality * Detect correct keycode for space cadet tapping term * Update tap dancing to use global custom tapping term * Update documentation for Tap Dances * formatting pass * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_tap_dance.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update for future * Update user keymaps for space cadet * Fix typos * Clean up tapping term stuff * Fix compiler issue if NO_ACTION_TAPPING is enabled Co-authored-by: fauxpark <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-08-29Bigger combo index (#9318)Pete Sevander
* Add change log * Change combo index from uint8_t to uint16_t
2020-08-29Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge ↵Nick Brassel
RC circuit. (#8778)
2020-08-29Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471)Nick Brassel
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-19 06:33:45 +0000