mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-12-11 20:58:15 +06:00
Code Issues Packages Projects Releases Wiki Activity
7f475b590a
keychron_qmk_firmware/docs
History
Andre Brait 7f475b590a
Tweak OS detect, add OS_DETECTION_SINGLE_REPORT (#24379) 
* Default OS_DETECTION_DEBOUNCE bumped from 200ms to 250ms
* Add OS_DETECTION_SINGLE_REPORT to prevent undesired multiple reports
* Prevents random stability issues on ARM MacBooks after switching via KVM
* Works for every device I could test, including ARM MacBooks
* Disabled by default to keep current behavior
* Add Troubleshooting section on documentation
* Tweak reset logic to prevent a freeze with some KVMs

The USB stack on ARM MacBooks is more similar to that of iOS and,
for some reason, it seems to like sending packets that influence
the OS detection and results in a second OS_MACOS report being sent
at a random period of time after plugging the keyboard back. This
does not always happen and the consequences of this vary based on
what the user is doing in the callback, but since this is not
obvious and it's hard to debug, I've decided to add a flag for
those affected by such issue. The stability issue I had in mine was
a combination of factors and I found the actual cause being my own
bad math when changing the default layer, but this change alone is
also confirmed to fix it. Lastly, soem KVMs seem to leave the USB
controlled in a suspended state when cold-booting Windows, meaning
the keyboard would hang and the reset logic would not work. This
tunes it so that it can get out of such state. Also retested for
compatibility with my old KVM to ensure the logic works for both.
2024-10-06 21:50:39 +13:00
..
ChangeLog Changelog update with actual qmk_userspace_via link. (#24332) 2024-08-26 23:05:45 +01:00
drivers WS2812 API rework (#24364) 2024-10-06 21:01:07 +13:00
features Tweak OS detect, add OS_DETECTION_SINGLE_REPORT (#24379) 2024-10-06 21:50:39 +13:00
public Ensure documentation pull requests build (#23908) 2024-06-13 02:59:37 +01:00
__capabilities_inc.md
__capabilities.md [docs] Remove gitbook directory (#23839) 2024-06-01 10:37:40 +10:00
_aliases.json Remove references to bootloadHID flashing page in keyboard readmes (#23942) 2024-06-17 20:23:45 +01:00
_sidebar.json [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
api_development_environment.md
api_development_overview.md
api_docs.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
api_overview.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
arm_debugging.md
breaking_changes_history.md 2024q3 breaking changes changelog (#24324) 2024-08-26 09:46:12 +10:00
breaking_changes_instructions.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
breaking_changes.md Update next breaking changes date (#24331) 2024-08-26 15:14:06 +10:00
chibios_upgrade_instructions.md
cli_commands.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
cli_configuration.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
cli_development.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
cli_tab_complete.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
cli.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
coding_conventions_c.md
coding_conventions_python.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
compatible_microcontrollers.md Remove arm_atsam platform (#24337) 2024-09-02 03:48:17 +01:00
config_options.md Remove RING_BUFFERED_6KRO_REPORT_ENABLE due to disuse. (#24433) 2024-09-24 12:53:55 +01:00
configurator_architecture.md
configurator_default_keymaps.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md Remove suggestion of creating issues for unsupported keyboards. (#23918) 2024-06-14 00:23:57 +01:00
configurator_troubleshooting.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
contributing.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
custom_matrix.md
custom_quantum_functions.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
data_driven_config.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
documentation_best_practices.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
documentation_templates.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
driver_installation_zadig.md [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
easy_maker.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_build.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_debug.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_general.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
faq_keymap.md [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
faq_misc.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
feature_advanced_keycodes.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_converters.md Rename promicro_rp2040 converter to sparkfun_pm2040 (#24192) 2024-07-25 22:51:32 +01:00
feature_debounce_type.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
feature_eeprom.md [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
feature_layers.md Add easier way to set default single layer (#24376) 2024-10-06 21:39:21 +13:00
feature_layouts.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
feature_macros.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_userspace.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
flashing.md [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
fuse.txt
getting_started_docker.md doc: "docker getting started" mentions flash limitations (#24336) 2024-09-01 10:59:21 -06:00
getting_started_github.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
getting_started_introduction.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
getting_started_make_guide.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
hand_wire.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
hardware_drivers.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
hardware_keyboard_guidelines.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
how_a_matrix_works.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
how_keyboards_work.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
index.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
isp_flashing_guide.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
keycodes_basic.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
keycodes_magic.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
keycodes_us_ansi_shifted.md
keycodes.md Add new connection keycodes for Bluetooth, 2.4GHz. (#24251) 2024-08-27 10:52:23 +10:00
keymap.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
mod_tap.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
newbs_building_firmware_configurator.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_building_firmware_workflow.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
newbs_building_firmware.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
newbs_external_userspace.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_flashing.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
newbs_getting_started.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
newbs_git_best_practices.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_resolving_merge_conflicts.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_resynchronize_a_branch.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_using_your_master_branch.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_learn_more_resources.md
newbs_testing_debugging.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
one_shot_keys.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
other_eclipse.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
other_vscode.md [Maintenance] builddefs: common_rules: overhaul debug information generation (#24352) 2024-09-01 19:54:53 +02:00
platformdev_blackpill_f4x1.md
platformdev_chibios_earlyinit.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
platformdev_proton_c.md
platformdev_rp2040.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
platformdev_selecting_arm_mcu.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
porting_your_keyboard_to_qmk.md Fix dead link in porting_your_keyboard_to_qmk.md (#24306) 2024-08-19 20:04:37 +01:00
power.txt
pr_checklist.md Update PR Checklist for 'via' keymaps (#24330) 2024-08-27 07:28:23 +10:00
quantum_keycodes.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_lvgl.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_qff.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_qgf.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_rle.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter.md Add LD7032 support to QP. (#20828) 2024-09-18 21:44:33 +10:00
ref_functions.md Add easier way to set default single layer (#24376) 2024-10-06 21:39:21 +13:00
reference_configurator_support.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
reference_glossary.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
reference_info_json.md [docs] reference_info_json: add type hints (#24443) 2024-09-30 00:26:31 +01:00
reference_keymap_extras.md add farsi keymap extras (#23650) 2024-06-20 16:12:16 -07:00
squeezing_avr.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
support_deprecation_policy.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
support.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
syllabus.md [Docs] Remove references to bootmagic lite (#24369) 2024-09-06 17:30:54 +01:00
tap_hold.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
understanding_qmk.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
unit_testing.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
usb_nkro.txt