0ae20e7457
* 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> |
||
|---|---|---|
| .. | ||
| ChangeLog | ||
| de | ||
| es | ||
| fr-fr | ||
| gitbook/images | ||
| he-il | ||
| ja | ||
| ko-kr | ||
| pt-br | ||
| ru-ru | ||
| zh-cn | ||
| _langs.md | ||
| _summary.md | ||
| .nojekyll | ||
| adc_driver.md | ||
| api_development_environment.md | ||
| api_development_overview.md | ||
| api_docs.md | ||
| api_overview.md | ||
| arm_debugging.md | ||
| audio_driver.md | ||
| breaking_changes_history.md | ||
| breaking_changes_instructions.md | ||
| breaking_changes.md | ||
| chibios_upgrade_instructions.md | ||
| cli_commands.md | ||
| cli_configuration.md | ||
| cli_development.md | ||
| cli_tab_complete.md | ||
| cli.md | ||
| CNAME | ||
| coding_conventions_c.md | ||
| coding_conventions_python.md | ||
| compatible_microcontrollers.md | ||
| config_options.md | ||
| configurator_architecture.md | ||
| configurator_default_keymaps.md | ||
| configurator_diagram.drawio | ||
| configurator_diagram.svg | ||
| configurator_step_by_step.md | ||
| configurator_troubleshooting.md | ||
| contributing.md | ||
| custom_matrix.md | ||
| custom_quantum_functions.md | ||
| data_driven_config.md | ||
| documentation_best_practices.md | ||
| documentation_templates.md | ||
| driver_installation_zadig.md | ||
| easy_maker.md | ||
| eeprom_driver.md | ||
| faq_build.md | ||
| faq_debug.md | ||
| faq_general.md | ||
| faq_keymap.md | ||
| faq_misc.md | ||
| feature_advanced_keycodes.md | ||
| feature_audio.md | ||
| feature_auto_shift.md | ||
| feature_backlight.md | ||
| feature_bluetooth.md | ||
| feature_bootmagic.md | ||
| feature_combo.md | ||
| feature_command.md | ||
| feature_debounce_type.md | ||
| feature_digitizer.md | ||
| feature_dip_switch.md | ||
| feature_dynamic_macros.md | ||
| feature_encoders.md | ||
| feature_grave_esc.md | ||
| feature_haptic_feedback.md | ||
| feature_hd44780.md | ||
| feature_joystick.md | ||
| feature_key_lock.md | ||
| feature_key_overrides.md | ||
| feature_layers.md | ||
| feature_layouts.md | ||
| feature_leader_key.md | ||
| feature_led_indicators.md | ||
| feature_led_matrix.md | ||
| feature_macros.md | ||
| feature_midi.md | ||
| feature_mouse_keys.md | ||
| feature_oled_driver.md | ||
| feature_pointing_device.md | ||
| feature_ps2_mouse.md | ||
| feature_rawhid.md | ||
| feature_rgb_matrix.md | ||
| feature_rgblight.md | ||
| feature_sequencer.md | ||
| feature_space_cadet.md | ||
| feature_split_keyboard.md | ||
| feature_st7565.md | ||
| feature_stenography.md | ||
| feature_swap_hands.md | ||
| feature_tap_dance.md | ||
| feature_terminal.md | ||
| feature_thermal_printer.md | ||
| feature_unicode.md | ||
| feature_userspace.md | ||
| feature_velocikey.md | ||
| feature_wpm.md | ||
| flashing_bootloadhid.md | ||
| flashing.md | ||
| fuse.txt | ||
| getting_started_docker.md | ||
| getting_started_github.md | ||
| getting_started_introduction.md | ||
| getting_started_make_guide.md | ||
| getting_started_vagrant.md | ||
| hand_wire.md | ||
| hardware_avr.md | ||
| hardware_drivers.md | ||
| hardware_keyboard_guidelines.md | ||
| how_a_matrix_works.md | ||
| how_keyboards_work.md | ||
| i2c_driver.md | ||
| index.html | ||
| internals_defines.md | ||
| internals_gpio_control.md | ||
| internals_input_callback_reg.md | ||
| internals_midi_device_setup_process.md | ||
| internals_midi_device.md | ||
| internals_midi_util.md | ||
| internals_send_functions.md | ||
| internals_sysex_tools.md | ||
| isp_flashing_guide.md | ||
| keycodes_basic.md | ||
| keycodes_magic.md | ||
| keycodes_us_ansi_shifted.md | ||
| keycodes.md | ||
| keymap.md | ||
| mod_tap.md | ||
| newbs_building_firmware_configurator.md | ||
| newbs_building_firmware.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_git_best_practices.md | ||
| newbs_git_resolving_merge_conflicts.md | ||
| newbs_git_resynchronize_a_branch.md | ||
| newbs_git_using_your_master_branch.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
| newbs.md | ||
| one_shot_keys.md | ||
| other_eclipse.md | ||
| other_vscode.md | ||
| platformdev_chibios_earlyinit.md | ||
| platformdev_selecting_arm_mcu.md | ||
| power.txt | ||
| pr_checklist.md | ||
| proton_c_conversion.md | ||
| qmk_custom_dark.css | ||
| qmk_custom_light.css | ||
| qmk.css | ||
| quantum_keycodes.md | ||
| README.md | ||
| redirects.json | ||
| ref_functions.md | ||
| reference_configurator_support.md | ||
| reference_glossary.md | ||
| reference_info_json.md | ||
| reference_keymap_extras.md | ||
| serial_driver.md | ||
| spi_driver.md | ||
| support.md | ||
| sw.js | ||
| syllabus.md | ||
| tap_hold.md | ||
| translating.md | ||
| uart_driver.md | ||
| understanding_qmk.md | ||
| unit_testing.md | ||
| usb_nkro.txt | ||
| ws2812_driver.md | ||
Quantum Mechanical Keyboard Firmware
What is QMK Firmware?
QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.
Get Started
?> Basic QMK Configurator
User friendly graphical interfaces, no programming knowledge required.
?> Advanced Use The Source
More powerful, but harder to use.
Make It Yours
QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.
Need help?
Check out the support page to see how you can get help using QMK.
Give Back
There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.
- Help people out on our forums and chat rooms:
- Contribute to our documentation by clicking "Edit This Page" at the bottom
- Translate our documentation into your language
- Report a bug
- Open a Pull Request