summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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
2020-08-29Change analogRead calls to analogReadPin (#9023)Ryan
* Change analogRead calls to analogReadPin * Add ChangeLog * Update docs, remove mention of `analogRead()` * Retarget changelog for next round
2020-08-25Add noeeprom speed function for RGBLIGHT (#9706)Drashna Jaelre
* [Docs] Add Speed functions to RGB Light docs * Add noeeprom functions for speed * Fix wording in doc Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-08-22Update i2c_driver.md (#10131)Ikta
Update i2c_driver.md to change ARM pin number documentation, line 84 and 85
2020-08-19Fix typo in docs/feature_dynamic_macros (#10085)Jason Fields
s/completly/completely
2020-08-17Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943)nopunin10did
* Issue 9942: Add Quantum defines Add codes to quantum_keycodes for LSA, RSA, RCS, and their corresponding _T macros * 9942: Add documentation for new defines Add documentation for new defines in feature request 9942. Also define SAGR and SAGR_T as aliases for RSA and RSA_T. * Update quantum/quantum_keycodes.h * Update docs/keycodes.md * Update docs/keycodes.md * Update docs/keycodes.md * Update docs/keycodes.md
2020-08-17[Docs] Japanese translation of docs/proton_c_conversion.md (#9927)Takeshi ISHII
* start translation docs/ja/proton_c_conversion.md * Japanese translation is in progress. * Japanese translation is in progress. * update * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * Update docs/ja/proton_c_conversion.md * update docs/ja/_summary.md: GPIO congtrol
2020-08-16Update Japanese translation of _summary.md. (#10051)shela
2020-08-07Add PR checklist document. (#9913)Nick Brassel
* Add PR checklist document. * Update docs/pr_checklist.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Reword the lower/raise/adjust suggestion somewhat for clarity. * Add suggestion from @Didel for coding conventions. Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-08-05Add Indicator flag for RGB Matrix (#9933)Drashna Jaelre
* Add Indicator flag for RGB Matrix This adds a new flag for the RGB Matrix feature that lets you specify if the LED is an indicator LED, to be used to indicate the system state of the keyboard (eg caps/num/etc lock status, layer indication, modifer status, etc). * Better formatting of table
2020-08-03[Docs] small text and formatting fixes in vscode manual (#9156)Marco Syfrig
* small text and formatting fixes in vscode manual fix double opening <kbd> tags for correct formatting expand two points for better understanding * restored <kbd>, clarified how to open the terminal restored <kbd> tags that were deleted with the last commit; they are correct as they were to have the whole menu "breadcrumb" nested inside a box clarified how to open the terminal escaped backtick for shortcut Ctrl+` as I’ve added backticks for code on the same line * Update docs/other_vscode.md
2020-07-31[Docs] Update Japanese translation of newbs_flashing.md. (#9819)shela
* Update Japanese translation of newbs_flashing.md. * Update docs/ja/newbs_flashing.md
2020-07-31[Docs] Update Japanese translation of newbs_getting_started.md. (#9813)shela
2020-07-31[Docs] Japanese translation of docs/internals_input_callback_reg.md (#9752)umi
* add internals_input_callback_reg.md translation * update based on comment
2020-07-31[Docs] Update Japanese translation of newbs_building_firmware.md. (#9810)shela
* Update Japanese translation of newbs_building_firmware.md. * fix original document version. * Apply suggestions from code review
2020-07-31[Docs] Japanese translation of docs/other_vscode.md (#9756)umi
* add other_vscode.md translation * update based on comment * update based on comment * update based on comment
2020-07-31[Docs] Update Japanese translation of keymap.md. (#9807)shela
* Update Japanese translation of keymap.md. * fix original document version. * Apply suggestions from code review * Update translation
2020-07-31[Docs] Update Japanese translation of feature_backlight.md. (#9803)shela
* Update Japanese translation of feature_backlight.md. * fix original document version. * Apply suggestions from code review
2020-07-31Remove unnecessary break after return from documentation (#9892)Rustam Zagirov
2020-07-30[Docs] Update Japanese translation of feature_tap_dance.md. (#9808)shela
* Update Japanese translation of feature_tap_dance.md. * fix original document version. * Update docs/ja/feature_tap_dance.md
2020-07-30[Docs] Update Japanese translation of feature_ps2_mouse.md. (#9815)shela
2020-07-30[Docs] Update Japanese translation of feature_mouse_keys.md. (#9809)shela
* Update Japanese translation of feature_mouse_keys.md. * fix original document version. * Update docs/ja/feature_mouse_keys.md * update based on comment
2020-07-30[Docs] Update Japanese translation of feature_macros.md. (#9767)shela
* Update Japanese translation of feature_macros.md. * Update feature_macros.md fix original document version.
2020-07-29[Docs] Japanese translation of docs/internals_gpio_control.md (#9751)umi
* add internals_gpio_control.md translation * update based on comment * update based on comment * update based on comment
2020-07-29[Docs] Japanese translation of docs/other_eclipse.md (#9755)umi
* add other_eclipse.md translation * update based on comment * update based on comment
2020-07-29[Docs] Japanese translation of docs/one_shot_keys.md (#9754)umi
* add one_shot_keys.md translation * update based on comment * update based on comment
2020-07-29[Docs] Japanese translation of docs/mod_tap.md (#9753)umi
* add mod_tap.md translation * update based on comment * update based on comment
2020-07-29[Docs] Japanese translation of docs/how_keyboards_work.md (#9683)umi
* add how_keyboards_work.md translation * update based on comment * update based on comment * update based on comment
2020-07-29[Docs] Japanese translation of docs/how_a_matrix_works.md (#9682)umi
* add how_a_matrix_works.md translation * update based on comment * update based on comment
2020-07-27[Docs] Japanese translation of docs/feature_stenography.md (#9525)umi
* add feature_stenography.md translation * update based on comment * Update docs/ja/feature_stenography.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/feature_stenography.md ご指摘ありがとうございます。 「速記プロトコル」で更新しました。 Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com>
2020-07-25[Docs] Update Japanese translation of custom_quantum_functions.md. (#9760)shela
* Update Japanese translation of custom_quantum_functions.md. * Update custom_quantum_functions.md fix original document version.
2020-07-25[Docs] Japanese translation of docs/getting_started_docker.md (#9681)umi
* add getting_started_docker.md translation * fix some typo * update based on comment
2020-07-25[Docs] Japanese translation of docs/flashing_bootloadhid.md (#9680)umi
* add flashing_bootloadhid.md translation * update based on comment
2020-07-25Japanese documents 'original document' comment fix (#9816)Takeshi ISHII
2020-07-24[Docs] Update Japanese translation of feature_pointing_device.md. (#9771)shela
* Update Japanese translation of feature_pointing_device.md. * Update docs/ja/feature_pointing_device.md * Update feature_pointing_device.md fix original document version.
2020-07-24[Docs] Update Japanese translation of feature_userspace.md. (#9775)shela
2020-07-24[Docs] Update Japanese translation of feature_hd44780.md. (#9766)shela
2020-07-24[Docs] Update Japanese translation of faq_build.md. (#9762)shela
2020-07-23Update Japanese translation of _summary.md. (#9777)shela
2020-07-23[Docs] Update Japanese translation of feature_split_keyboard.md. (#9780)shela
* Update Japanese translation of feature_split_keyboard.md. * Update docs/ja/feature_split_keyboard.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-07-23Update Japanese translation of feature_layers.md. (#9769)shela
2020-07-23Update Japanese translation of feature_encoders.md. (#9765)shela
2020-07-23Update Japanese translation of feature_dynamic_macros.md. (#9764)shela
2020-07-23Update Japanese translation of feature_dip_switch.md. (#9763)shela
2020-07-23Update Japanese translation of driver_installation_zadig.md. (#9761)shela
2020-07-23Update Japanese translation of config_options.md. (#9759)shela