tzarc
2 years ago
67 changed files with 2458 additions and 642 deletions
Split View
Diff Options
-
+557 -0ChangeLog/20210828.md
-
+6 -1_summary.md
-
+11 -6breaking_changes.md
-
+1 -0breaking_changes_history.md
-
+56 -0chibios_upgrade_instructions.md
-
+36 -14cli_commands.md
-
+2 -2cli_development.md
-
+3 -0compatible_microcontrollers.md
-
+50 -3config_options.md
-
+9 -1custom_quantum_functions.md
-
+4 -4de/cli.md
-
+3 -2driver_installation_zadig.md
-
+31 -0easy_maker.md
-
+3 -0eeprom_driver.md
-
+20 -18es/hardware_avr.md
-
+1 -1faq_keymap.md
-
+26 -0feature_audio.md
-
+13 -128feature_bootmagic.md
-
+259 -33feature_combo.md
-
+1 -1feature_command.md
-
+2 -19feature_debounce_type.md
-
+35 -0feature_digitizer.md
-
+12 -7feature_dip_switch.md
-
+6 -0feature_encoders.md
-
+25 -1feature_haptic_feedback.md
-
+229 -0feature_key_overrides.md
-
+23 -50feature_led_matrix.md
-
+17 -3feature_oled_driver.md
-
+36 -2feature_ps2_mouse.md
-
+187 -90feature_rgb_matrix.md
-
+28 -23feature_rgblight.md
-
+139 -11feature_split_keyboard.md
-
+274 -0feature_st7565.md
-
+15 -0feature_stenography.md
-
+1 -1feature_tap_dance.md
-
+48 -2flashing.md
-
+4 -4fr-fr/cli.md
-
+20 -18hardware_avr.md
-
+2 -2hardware_keyboard_guidelines.md
-
+0 -27internals_pfleury_lcd.md
-
+7 -7internals_udi_hid_group.md
-
+6 -6internals_udi_hid_group_internal.md
-
+1 -1internals_udi_hid_keyboard_group_single_desc.md
-
+1 -1internals_usb_device_group.md
-
+15 -15internals_usb_hid_protocol.md
-
+7 -7ja/cli_commands.md
-
+2 -2ja/cli_development.md
-
+3 -0ja/compatible_microcontrollers.md
-
+1 -1ja/feature_bootmagic.md
-
+0 -17ja/feature_debounce_type.md
-
+12 -6ja/feature_dip_switch.md
-
+7 -3ja/feature_encoders.md
-
+2 -2ja/feature_led_matrix.md
-
+1 -1ja/feature_tap_dance.md
-
+20 -18ja/hardware_avr.md
-
+0 -2ja/reference_configurator_support.md
-
+0 -4ja/reference_info_json.md
-
+36 -36keycodes.md
-
+36 -0keycodes_magic.md
-
+1 -1ref_functions.md
-
+0 -2reference_configurator_support.md
-
+0 -4reference_info_json.md
-
+10 -9serial_driver.md
-
+2 -1syllabus.md
-
+89 -19tap_hold.md
-
+1 -0understanding_qmk.md
-
+3 -3zh-cn/custom_quantum_functions.md
+ 557
- 0
ChangeLog/20210828.md
View File
| @ -0,0 +1,557 @@ | |||
| # QMK Breaking Changes - 2021 August 28 Changelog | |||
| ## Notable Features :id=notable-features | |||
| ### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) :id=combo-processing-improvements | |||
| Combo processing has been reordered with respect to keypress handling, allowing for much better compatibility with mod taps. | |||
| It is also now possible to define combos that have keys overlapping with other combos, triggering only one. For example, a combo of `A`, `B` can coexist with a longer combo of `A`, `B`, `C` -- previous functionality would trigger both combos if all three keys were pressed. | |||
| ### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) :id=key-overrides | |||
| QMK now has a new feature: [key overrides](https://docs.qmk.fm/#/feature_key_overrides). This feature allows for overriding the output of key combinations involving modifiers. As an example, pressing <kbd>Shift+2</kbd> normally results in an <kbd>@</kbd> on US-ANSI keyboard layouts -- the new key overrides allow for adding similar functionality, but for any <kbd>modifier + key</kbd> press. | |||
| To illustrate, it's now possible to use the key overrides feature to translate <kbd>Shift + Backspace</kbd> into <kbd>Delete</kbd> -- an often-requested example of where this functionality comes in handy. | |||
| There's far more to describe that what lives in this changelog, so head over to the [key overrides documentation](https://docs.qmk.fm/#/feature_key_overrides) for more examples and info. | |||
| ### Digitizer support ([#12851](https://github.com/qmk/qmk_firmware/pull/12851)) | |||
| QMK gained the ability to pretend to be a digitizer device -- much like a tablet device. A mouse uses delta-coordinates -- move up, move right -- but a digitizer works with absolute coordinates -- top left, bottom right. | |||
| ## Changes Requiring User Action :id=changes-requiring-user-action | |||
| ### Updated Keyboard Codebases :id=updated-keyboard-codebases | |||
| The following keyboards have had their source moved within QMK: | |||
| Old Keyboard Name | New Keyboard Name | |||
| ------------------------------|--------------------------------------------------------- | |||
| aeboards/constellation | aeboards/constellation/rev1, aeboards/constellation/rev2 | |||
| bakeneko65 | bakeneko65/rev2, bakeneko65/rev3 | |||
| bm16a | kprepublic/bm16a | |||
| bm16s | kprepublic/bm16s | |||
| bm40hsrgb | kprepublic/bm40hsrgb | |||
| bm43a | kprepublic/bm43a | |||
| bm60poker | kprepublic/bm60poker | |||
| bm60rgb | kprepublic/bm60rgb | |||
| bm60rgb_iso | kprepublic/bm60rgb_iso | |||
| bm68rgb | kprepublic/bm68rgb | |||
| clawsome/gamebuddy | clawsome/gamebuddy/v1_0, clawsome/gamebuddy/v1_m | |||
| cospad | kprepublic/cospad | |||
| custommk/genesis | custommk/genesis/rev1, custommk/genesis/rev2 | |||
| daisy | ktec/daisy | |||
| durgod/k320 | durgod/k3x0/k320 | |||
| dztech/volcano660 | ilumkb/volcano660 | |||
| ergodone | ktec/ergodone | |||
| gmmk/pro | gmmk/pro/ansi, gmmk/pro/iso | |||
| handwired/p1800fl | team0110/p1800fl | |||
| jj40 | kprepublic/jj40 | |||
| jj4x4 | kprepublic/jj4x4 | |||
| jj50 | kprepublic/jj50 | |||
| kyria | splitkb/kyria | |||
| lazydesigners/the60 | lazydesigners/the60/rev1, lazydesigners/the60/rev2 | |||
| matrix/m12og | matrix/m12og/rev1, matrix/m12og/rev2 | |||
| mechlovin/hannah65/mechlovin9 | mechlovin/mechlovin9/rev1, mechlovin/mechlovin9/rev2 | |||
| peiorisboards/ixora | coarse/ixora | |||
| ramonimbao/mona | ramonimbao/mona/v1, ramonimbao/mona/v1_1 | |||
| staryu | ktec/staryu | |||
| tokyo60 | tokyokeyboard/tokyo60 | |||
| vinta | coarse/vinta | |||
| xd002 | xiudi/xd002 | |||
| xd004 | xiudi/xd004 | |||
| xd60 | xiudi/xd60 | |||
| xd68 | xiudi/xd68 | |||
| xd75 | xiudi/xd75 | |||
| xd84 | xiudi/xd84 | |||
| xd84pro | xiudi/xd84pro | |||
| xd87 | xiudi/xd87 | |||
| xd96 | xiudi/xd96 | |||
| ### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) :id=bootmagic-full-removal | |||
| As noted during last breaking changes cycle, QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. | |||
| This pull request changes the behavior of `BOOTMAGIC_ENABLE` such that specifying `full` results in an error, allowing only `no`, `yes`, or `lite`. | |||
| Next cycle, `lite` will be removed, so `yes` and `no` should be used in to minimise disruption. | |||
| #### Bootmagic Full Deprecation Schedule | |||
| This is the current roadmap for the behavior of `BOOTMAGIC_ENABLE`: | |||
| - (done) From 2021 May 29, setting `BOOTMAGIC_ENABLE = yes` will enable Bootmagic Lite instead of full Bootmagic. | |||
| - (now) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. | |||
| - (next) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. | |||
| ### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) :id=dip-switch-boolean | |||
| To match the encoder change last breaking changes cycle, DIP switch callbacks now return `bool`, too. | |||
| Example code before change: | |||
| ```c | |||
| void dip_switch_update_kb(uint8_t index, bool active) { | |||
| dip_switch_update_user(index, active); | |||
| } | |||
| void dip_switch_update_user(uint8_t index, bool active) { | |||
| switch (index) { | |||
| case 0: | |||
| if(active) { audio_on(); } else { audio_off(); } | |||
| break; | |||
| } | |||
| } | |||
| void dip_switch_update_mask_kb(uint32_t state) { | |||
| dip_switch_update_mask_user(state); | |||
| } | |||
| void dip_switch_update_mask_user(uint32_t state) { | |||
| if (state & (1UL<<0) && state & (1UL<<1)) { | |||
| layer_on(_ADJUST); // C on esc | |||
| } else { | |||
| layer_off(_ADJUST); | |||
| } | |||
| } | |||
| ``` | |||
| Example code after change: | |||
| ```c | |||
| bool dip_switch_update_kb(uint8_t index, bool active) { | |||
| if !(dip_switch_update_user(index, active)) { return false; } | |||
| return true; | |||
| } | |||
| bool dip_switch_update_user(uint8_t index, bool active) { | |||
| switch (index) { | |||
| case 0: | |||
| if(active) { audio_on(); } else { audio_off(); } | |||
| break; | |||
| } | |||
| return true; // Returning true allows keyboard code to execute, false will tell the keyboard code "I've already handled it". | |||
| } | |||
| bool dip_switch_update_mask_kb(uint32_t state) { | |||
| if (!dip_switch_update_mask_user(state)) { return false; } | |||
| return true; | |||
| } | |||
| bool dip_switch_update_mask_user(uint32_t state) { | |||
| if (state & (1UL<<0) && state & (1UL<<1)) { | |||
| layer_on(_ADJUST); // C on esc | |||
| } else { | |||
| layer_off(_ADJUST); | |||
| } | |||
| return true; // Returning true allows keyboard code to execute, false will tell the keyboard code "I've already handled it". | |||
| } | |||
| ``` | |||
| ## Notable core changes :id=notable-core | |||
| ### Split transport improvements :id=split-transport-improvements | |||
| Split keyboards gained a significant amount of improvements during this breaking changes cycle, specifically: | |||
| * Extensible split data sync ([#11930](https://github.com/qmk/qmk_firmware/pull/11930)) -- rewritten data sharing between sides, allowing for data transfer only when required, as well as enabling keyboards and keymaps to define their own shared data. | |||
| * Full-duplex ARM USART split ([#13081](https://github.com/qmk/qmk_firmware/pull/13081)) -- adds to the previous half-duplex driver and now allows for full-duplex support on ARM. | |||
| * Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523)) -- allows the slave to be disconnected, enabling one-handed use. | |||
| * Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418)) | |||
| !> If you're updating your split keyboard, you will need to flash both sides of the split with the your firmware. | |||
| ### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) :id=teensy-4-x-support | |||
| Updated ChibiOS and ChibiOS-Contrib, which brought in support for Teensy 4.x dev boards, running NXP i.MX1062. | |||
| ### Data Driven Improvements ([#13366](https://github.com/qmk/qmk_firmware/pull/13366)) | |||
| QMK's pursuit of data-driven keyboards has progressed, allowing substantially more configurable options to be specified in `info.json`. | |||
| #### Tags | |||
| Tags will let you categorize your keyboard, and will be used in the future to allow browsing and sorting through keyboards in QMK. Tags are free-form text identifiers that identify attributes about your keyboard. To add tags you simply add a `tags` key to your `info.json`: | |||
| "tags": ["tkl", "backlight", "encoder"] | |||
| #### Dot Notation | |||
| With this release we are moving towards using JSON dot notation in more places. For example, when using `qmk info -f text`: | |||
| ``` | |||
| $ qmk info -f text -kb clueboard/card | |||
| bootloader: atmel-dfu | |||
| debounce: 20 | |||
| diode_direction: ROW2COL | |||
| features.audio: True | |||
| features.backlight: True | |||
| features.bluetooth: False | |||
| features.bootmagic: False | |||
| features.command: True | |||
| features.console: True | |||
| features.extrakey: True | |||
| features.lto: True | |||
| features.midi: False | |||
| features.mousekey: True | |||
| features.nkro: False | |||
| features.rgblight: True | |||
| features.unicode: False | |||
| height: 8 | |||
| keyboard_folder: clueboard/card | |||
| keyboard_name: Cluecard | |||
| layout_aliases.LAYOUT: LAYOUT_all | |||
| layouts: LAYOUT_all | |||
| maintainer: skullydazed | |||
| manufacturer: Clueboard | |||
| matrix_pins.cols: F1, F6, F7 | |||
| matrix_pins.rows: B4, F0, F4, F5 | |||
| platform: unknown | |||
| processor: atmega32u4 | |||
| processor_type: avr | |||
| protocol: LUFA | |||
| rgblight.brightness_steps: 17 | |||
| rgblight.hue_steps: 10 | |||
| rgblight.led_count: 4 | |||
| rgblight.pin: E6 | |||
| rgblight.saturation_steps: 17 | |||
| split.transport.protocol: serial | |||
| usb.device_ver: 0x0001 | |||
| usb.pid: 0x2330 | |||
| usb.vid: 0xC1ED | |||
| width: 10 | |||
| ``` | |||
| #### New configuration keys | |||
| We've added dozens of new keys to `info.json` so that you can configure more than ever without writing a single line of code. A quick overview of the new items you can configure: | |||
| * `audio.pins`, `audio.voices` | |||
| * `backlight.breathing`, `backlight.breathing_period`, `backlight.levels`, `backlight.pin`, | |||
| * `bluetooth.driver`, `bluetooth.lto` | |||
| * `bootloader_instructions` | |||
| * `build.debounce_type`, `build.firmware_format`, `build.lto` | |||
| * `combo.count`, `combo.term` | |||
| * `leader_key.timing`, `leader_key.strict_processing`, `leader_key.timeout` | |||
| * `matrix.custom`, `matrix.custom_lite`, `matrix.ghost`, `matrix.io_delay` | |||
| * `mouse_key.enabled`, `mouse_key.delay`, `mouse_key.interval`, `mouse_key.max_speed`, `mouse_key.time_to_max`, `mouse_key.wheel_delay` | |||
| * `oneshot.tap_toggle`, `oneshot.timeout` | |||
| * `rgblight.layers.blink`, `rgblight.layers.enabled`, `rgblight.layers.max`, `rgblight.layers.override_rgb`, `rgblight.rgbw` | |||
| * `split.enabled`, `split.matrix_grid`, `split.matrix_pins`, `split.main`, `split.soft_serial_pin`, `split.soft_serial_speed`, `split.transport.protocol`, `split.transport.sync_matrix_state`, `split.transport.sync_modifiers`, `split.usb_detect` | |||
| * `tapping.force_hold`, `tapping.force_hold_per_key`, `tapping.ignore_mod_tap_interrupt`, `tapping.ignore_mod_tap_interrupt_per_key`, `tapping.permissive_hold`, `tapping.permissive_hold_per_key`, `tapping.retro`, `tapping.retro_per_key`, `tapping.term`, `tapping.term_per_key`, `tapping.toggle` | |||
| * `usb.force_nkro`, `usb.max_power`, `usb.no_startup_check`, `usb.polling_interval`, `usb.shared_endpoint.keyboard`, `usb.shared_endpoint.mouse`, `usb.suspend_wakeup_delay`, `usb.wait_for` | |||
| * `qmk.keys_per_scan`, `qmk.tap_keycode_delay`, `qmk.tap_capslock_delay` | |||
| ### Codebase restructure and cleanup :id=codebase-restructure | |||
| QMK was originally based on TMK, and has grown in size considerably since its first inception. To keep moving things forward, restructure of some of the core areas of the code is needed to support new concepts and new hardware, and progress is happening along those lines: | |||
| * Move RGBLight code into its own folder ([#13312](https://github.com/qmk/qmk_firmware/pull/13312)) | |||
| * Migrate platform independent code from tmk_core -> quantum ([#13673](https://github.com/qmk/qmk_firmware/pull/13673)) | |||
| * matrix_scan_x -> x_task ([#13748](https://github.com/qmk/qmk_firmware/pull/13748)) | |||
| * Move some led drivers to common folder ([#13749](https://github.com/qmk/qmk_firmware/pull/13749)) | |||
| * Move chibios board files to allow tmk_core platform migration ([#13777](https://github.com/qmk/qmk_firmware/pull/13777)) | |||
| * Begin to carve out platform/protocol API - Single main loop ([#13843](https://github.com/qmk/qmk_firmware/pull/13843)) | |||
| * Relocate platform specific drivers ([#13894](https://github.com/qmk/qmk_firmware/pull/13894)) | |||
| * Move all the flash logic from tmk_core ([#13927](https://github.com/qmk/qmk_firmware/pull/13927)) | |||
| * Move USB Host Shield and Arduino core to `lib/` ([#13973](https://github.com/qmk/qmk_firmware/pull/13973)) | |||
| * Unify behaviour of wait on AVR ([#14025](https://github.com/qmk/qmk_firmware/pull/14025)) | |||
| * Move nix folder alongside vagrant ([#14132](https://github.com/qmk/qmk_firmware/pull/14132)) | |||
| * Align some quantum sub-directories ([#14134](https://github.com/qmk/qmk_firmware/pull/14134)) | |||
| --- | |||
| ## Full changelist | |||
| Core: | |||
| * Arm ps2 mouse interrupt ([#6490](https://github.com/qmk/qmk_firmware/pull/6490)) | |||
| * Process combos earlier & overlapping combos ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) | |||
| * Swap buttons on PS2 Mouse/Trackball ([#9205](https://github.com/qmk/qmk_firmware/pull/9205)) | |||
| * Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys ([#9404](https://github.com/qmk/qmk_firmware/pull/9404)) | |||
| * add yaml_build_options target ([#10533](https://github.com/qmk/qmk_firmware/pull/10533)) | |||
| * Warn when building a board that uses arm_atsam ([#10904](https://github.com/qmk/qmk_firmware/pull/10904)) | |||
| * Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) | |||
| * Refactor `quantum/command.{c,h}` for code size & {read,maintain}ability ([#11842](https://github.com/qmk/qmk_firmware/pull/11842)) | |||
| * Extensible split data sync ([#11930](https://github.com/qmk/qmk_firmware/pull/11930)) | |||
| * Move print/debug files to quantum ([#12069](https://github.com/qmk/qmk_firmware/pull/12069)) | |||
| * Unconditionally call led_init_ports ([#12116](https://github.com/qmk/qmk_firmware/pull/12116)) | |||
| * Support using a timer for wait_us() on ChibiOS-based boards ([#12211](https://github.com/qmk/qmk_firmware/pull/12211)) | |||
| * Add support for NO_PIN to all matrix types ([#12238](https://github.com/qmk/qmk_firmware/pull/12238)) | |||
| * Avoid 8-bit timer overflows in debounce algorithms ([#12240](https://github.com/qmk/qmk_firmware/pull/12240)) | |||
| * Add Per Key exclusions for Haptic Feedback ([#12386](https://github.com/qmk/qmk_firmware/pull/12386)) | |||
| * Steno combinedkeys ([#12538](https://github.com/qmk/qmk_firmware/pull/12538)) | |||
| * eeprom_stm32: implement high density wear leveling ([#12567](https://github.com/qmk/qmk_firmware/pull/12567)) | |||
| * eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. ([#12617](https://github.com/qmk/qmk_firmware/pull/12617)) | |||
| * Add CRC8 calculation subsystem to quantum ([#12641](https://github.com/qmk/qmk_firmware/pull/12641)) | |||
| * Limit saturation for RGB_MATRIX_JELLYBEAN_RAINDROPS ([#12669](https://github.com/qmk/qmk_firmware/pull/12669)) | |||
| * Add asym_eager_defer_pk debounce type ([#12689](https://github.com/qmk/qmk_firmware/pull/12689)) | |||
| * Include lib8tion.c into RGB/LED matrix build list ([#12699](https://github.com/qmk/qmk_firmware/pull/12699)) | |||
| * Add readPort() and some API to 'tmk_core/common/*/gpio.h' ([#12754](https://github.com/qmk/qmk_firmware/pull/12754)) | |||
| * add wait_cpuclock() macro for AVR and CPU_CLOCK macro ([#12755](https://github.com/qmk/qmk_firmware/pull/12755)) | |||
| * Trigger a wakeup after USB Reset on ChibiOS. ([#12831](https://github.com/qmk/qmk_firmware/pull/12831)) | |||
| * Add sync_timer support over serial_link (i.e. Ergodox Infinity) ([#12845](https://github.com/qmk/qmk_firmware/pull/12845)) | |||
| * Digitizer HID interface : absolute coordinates for mouse cursor ([#12851](https://github.com/qmk/qmk_firmware/pull/12851)) | |||
| * Add config.h and rules.mk support for data driven keymaps ([#12859](https://github.com/qmk/qmk_firmware/pull/12859)) | |||
| * Add alternate ldscript for STM32duino (F103xB) ([#12914](https://github.com/qmk/qmk_firmware/pull/12914)) | |||
| * `keymap_extras`: Remove deprecated defines ([#12949](https://github.com/qmk/qmk_firmware/pull/12949)) | |||
| * Retain brightness with lighting layers ([#13025](https://github.com/qmk/qmk_firmware/pull/13025)) | |||
| * Move optical sensor code to drivers folder ([#13044](https://github.com/qmk/qmk_firmware/pull/13044)) | |||
| * Change the prototype of matrix_output_unselect_delay() ([#13045](https://github.com/qmk/qmk_firmware/pull/13045)) | |||
| * Add weak refs on reading rows/cols. ([#13062](https://github.com/qmk/qmk_firmware/pull/13062)) | |||
| * Use single memcmp to determine if matrix changed. ([#13064](https://github.com/qmk/qmk_firmware/pull/13064)) | |||
| * Improve layer mask handling ([#13065](https://github.com/qmk/qmk_firmware/pull/13065)) | |||
| * mousekey: expose current report to users ([#13069](https://github.com/qmk/qmk_firmware/pull/13069)) | |||
| * ChibiOS SVN mirror script. ([#13070](https://github.com/qmk/qmk_firmware/pull/13070)) | |||
| * Added right vs left specific pin assignments for dip switch ([#13074](https://github.com/qmk/qmk_firmware/pull/13074)) | |||
| * make RESET key work with Teensy 4.x ([#13076](https://github.com/qmk/qmk_firmware/pull/13076)) | |||
| * wire up flash make target for Teensy 4.x ([#13077](https://github.com/qmk/qmk_firmware/pull/13077)) | |||
| * bump USB spec version in device descriptor to 2.0 ([#13078](https://github.com/qmk/qmk_firmware/pull/13078)) | |||
| * Unite half-duplex and full-duplex serial drivers ([#13081](https://github.com/qmk/qmk_firmware/pull/13081)) | |||
| * Add ST7565 LCD driver ([#13089](https://github.com/qmk/qmk_firmware/pull/13089)) | |||
| * `spi_master` Kinetis support ([#13098](https://github.com/qmk/qmk_firmware/pull/13098)) | |||
| * GMMK Pro RGB Support ([#13147](https://github.com/qmk/qmk_firmware/pull/13147)) | |||
| * Remove dfu-util arguments from mcu_selection ([#13150](https://github.com/qmk/qmk_firmware/pull/13150)) | |||
| * Add subcommand to generate version.h ([#13151](https://github.com/qmk/qmk_firmware/pull/13151)) | |||
| * Add oled_invert ([#13172](https://github.com/qmk/qmk_firmware/pull/13172)) | |||
| * ST7565 invert ([#13237](https://github.com/qmk/qmk_firmware/pull/13237)) | |||
| * RGB Matrix eeprom write limiting ([#13238](https://github.com/qmk/qmk_firmware/pull/13238)) | |||
| * Temporary disable of CRC ([#13252](https://github.com/qmk/qmk_firmware/pull/13252)) | |||
| * Move LED/RGB Matrix code into their own directories ([#13257](https://github.com/qmk/qmk_firmware/pull/13257)) | |||
| * Skip EEPROM writes once done. ([#13293](https://github.com/qmk/qmk_firmware/pull/13293)) | |||
| * Remove rgblight stubs ([#13302](https://github.com/qmk/qmk_firmware/pull/13302)) | |||
| * Allow settable SPI divisor for AW20216 driver, set default to 4 ([#13309](https://github.com/qmk/qmk_firmware/pull/13309)) | |||
| * Move RGBLight code into its own folder ([#13312](https://github.com/qmk/qmk_firmware/pull/13312)) | |||
| * Unify matrix for split common and regular matrix ([#13330](https://github.com/qmk/qmk_firmware/pull/13330)) | |||
| * Relocate RGB/HSV color defs to a more fitting place ([#13377](https://github.com/qmk/qmk_firmware/pull/13377)) | |||
| * Adds support for STM32L412xB, STM32L422xB. ([#13383](https://github.com/qmk/qmk_firmware/pull/13383)) | |||
| * Convert Dip Switch callbacks to boolean functions ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) | |||
| * Use string literals for `SERIAL_NUMBER` ([#13403](https://github.com/qmk/qmk_firmware/pull/13403)) | |||
| * Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418)) | |||
| * Improve 'show_build_options' target ([#13425](https://github.com/qmk/qmk_firmware/pull/13425)) | |||
| * AW20216 use register increment for framebuffer flushes ([#13430](https://github.com/qmk/qmk_firmware/pull/13430)) | |||
| * Allow invert of SPLIT_HAND_PIN logic ([#13433](https://github.com/qmk/qmk_firmware/pull/13433)) | |||
| * chibios: bootloader: use integer pointers as volatile ([#13450](https://github.com/qmk/qmk_firmware/pull/13450)) | |||
| * Refactor OLED to allow easy addition of other types ([#13454](https://github.com/qmk/qmk_firmware/pull/13454)) | |||
| * Dual RGB Matrix IS31FL3737 driver support to address #13442 ([#13457](https://github.com/qmk/qmk_firmware/pull/13457)) | |||
| * Enable g_is31_leds PROGMEM for RGB Matrix IS31FL3737 driver ([#13480](https://github.com/qmk/qmk_firmware/pull/13480)) | |||
| * Switch Ergodox Infinity over to split_common ([#13481](https://github.com/qmk/qmk_firmware/pull/13481)) | |||
| * Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523)) | |||
| * Enable sync of OLED/ST7565 display on/off state on Splits ([#13542](https://github.com/qmk/qmk_firmware/pull/13542)) | |||
| * Revert "Add rgblight to RGB Matrix VPATH" ([#13559](https://github.com/qmk/qmk_firmware/pull/13559)) | |||
| * Move `SENDSTRING_BELL` code to `send_string.h` ([#13566](https://github.com/qmk/qmk_firmware/pull/13566)) | |||
| * Migrate platform independent code from tmk_core -> quantum ([#13673](https://github.com/qmk/qmk_firmware/pull/13673)) | |||
| * Avoid LTO conficts on arm_atsam ([#13676](https://github.com/qmk/qmk_firmware/pull/13676)) | |||
| * Allow for removal of hysteresis on 4x encoders ([#13698](https://github.com/qmk/qmk_firmware/pull/13698)) | |||
| * Port new_keyboard.sh to CLI ([#13706](https://github.com/qmk/qmk_firmware/pull/13706)) | |||
| * Align AW20216 driver ([#13712](https://github.com/qmk/qmk_firmware/pull/13712)) | |||
| * Haptic: driver-> feature ([#13713](https://github.com/qmk/qmk_firmware/pull/13713)) | |||
| * Add support for STM32F407x MCUs. ([#13718](https://github.com/qmk/qmk_firmware/pull/13718)) | |||
| * Remove legacy BACKLIGHT_CUSTOM_DRIVER option ([#13731](https://github.com/qmk/qmk_firmware/pull/13731)) | |||
| * Minor tidy up of key overrides ([#13747](https://github.com/qmk/qmk_firmware/pull/13747)) | |||
| * matrix_scan_x -> x_task ([#13748](https://github.com/qmk/qmk_firmware/pull/13748)) | |||
| * Move some led drivers to common folder ([#13749](https://github.com/qmk/qmk_firmware/pull/13749)) | |||
| * Allow for higher USB Polling rate on ATSAM boards ([#13755](https://github.com/qmk/qmk_firmware/pull/13755)) | |||
| * Rgb matrix/enable modes explicitly ([#13758](https://github.com/qmk/qmk_firmware/pull/13758)) | |||
| * Move chibios board files to allow tmk_core platform migration ([#13777](https://github.com/qmk/qmk_firmware/pull/13777)) | |||
| * __flash? ([#13799](https://github.com/qmk/qmk_firmware/pull/13799)) | |||
| * `--parallel` improvements ([#13800](https://github.com/qmk/qmk_firmware/pull/13800)) | |||
| * Speed up pimoroni trackball driver ([#13823](https://github.com/qmk/qmk_firmware/pull/13823)) | |||
| * Add a toggle key for GUI On/Off in Magic feature ([#13830](https://github.com/qmk/qmk_firmware/pull/13830)) | |||
| * Begin to carve out platform/protocol API - Single main loop ([#13843](https://github.com/qmk/qmk_firmware/pull/13843)) | |||
| * Remove Full Bootmagic ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) | |||
| * Remove backwards compatibility of debounce names ([#13877](https://github.com/qmk/qmk_firmware/pull/13877)) | |||
| * Relocate platform specific drivers ([#13894](https://github.com/qmk/qmk_firmware/pull/13894)) | |||
| * Remove ONEHAND_ENABLE ([#13920](https://github.com/qmk/qmk_firmware/pull/13920)) | |||
| * Move all the flash logic from tmk_core ([#13927](https://github.com/qmk/qmk_firmware/pull/13927)) | |||
| * adding uf2 flash support for blackpill 401 ([#13968](https://github.com/qmk/qmk_firmware/pull/13968)) | |||
| * Unify behaviour of wait on AVR ([#14025](https://github.com/qmk/qmk_firmware/pull/14025)) | |||
| * Add qmk-hid bootloader detection support to `qmk console` ([#14038](https://github.com/qmk/qmk_firmware/pull/14038)) | |||
| * Align DIP_SWITCH_PINS_RIGHT implementation with encoders ([#14079](https://github.com/qmk/qmk_firmware/pull/14079)) | |||
| * Tidy up quantum.c now some of tmk_core has been merged ([#14083](https://github.com/qmk/qmk_firmware/pull/14083)) | |||
| * Improve pmw3360 sensor and make it more hardware agnostic ([#14097](https://github.com/qmk/qmk_firmware/pull/14097)) | |||
| * Move nix folder alongside vagrant ([#14132](https://github.com/qmk/qmk_firmware/pull/14132)) | |||
| * Align some quantum sub-directories ([#14134](https://github.com/qmk/qmk_firmware/pull/14134)) | |||
| * Revert 14083 && 14144 ([#14150](https://github.com/qmk/qmk_firmware/pull/14150)) | |||
| CLI: | |||
| * allow LINE_PINxx for Teensy 4.x pins ([#13247](https://github.com/qmk/qmk_firmware/pull/13247)) | |||
| * Remove the redundant pin name validation ([#13251](https://github.com/qmk/qmk_firmware/pull/13251)) | |||
| * Move all our CLI file formatters to the format dir ([#13296](https://github.com/qmk/qmk_firmware/pull/13296)) | |||
| * Refactor doctor.py into a directory ([#13298](https://github.com/qmk/qmk_firmware/pull/13298)) | |||
| * Add git and venv info to doctor's output ([#13405](https://github.com/qmk/qmk_firmware/pull/13405)) | |||
| * Matrix consistency check ([#13470](https://github.com/qmk/qmk_firmware/pull/13470)) | |||
| * Remove references to info.json `width` and `height` in CLI ([#13728](https://github.com/qmk/qmk_firmware/pull/13728)) | |||
| * Make `qmk doctor` more lenient about system config ([#13804](https://github.com/qmk/qmk_firmware/pull/13804)) | |||
| * Defer the expensive search for layout macros until info.json has been processed ([#14007](https://github.com/qmk/qmk_firmware/pull/14007)) | |||
| Submodule updates: | |||
| * Update ChibiOS, ChibiOS-Contrib. ([#13056](https://github.com/qmk/qmk_firmware/pull/13056)) | |||
| * Update LUFA (18-07-2021) and add QMK-HID Bootloader support ([#13588](https://github.com/qmk/qmk_firmware/pull/13588)) | |||
| * Update LUFA Submodule (2021-07-30) ([#13819](https://github.com/qmk/qmk_firmware/pull/13819)) | |||
| * Bump gtest ([#13885](https://github.com/qmk/qmk_firmware/pull/13885)) | |||
| * Update ChibiOS-Contrib, mirroring script. ([#13896](https://github.com/qmk/qmk_firmware/pull/13896)) | |||
| * Move USB Host Shield and Arduino core to `lib/` ([#13973](https://github.com/qmk/qmk_firmware/pull/13973)) | |||
| Keyboards: | |||
| * Migrate keyboards using uGFX to LED_MATRIX ([#9657](https://github.com/qmk/qmk_firmware/pull/9657)) | |||
| * Remove MIDI Configuration boilerplate ([#11151](https://github.com/qmk/qmk_firmware/pull/11151)) | |||
| * manyboard macro ([#11896](https://github.com/qmk/qmk_firmware/pull/11896)) | |||
| * Moved tokyo60/ into tokyokeyboard/tokyo60/. ([#12023](https://github.com/qmk/qmk_firmware/pull/12023)) | |||
| * Organize KPrepublic, K.T.E.C, xiudi boards into directories ([#12159](https://github.com/qmk/qmk_firmware/pull/12159)) | |||
| * Add Durgod Taurus K310 keyboard ([#12314](https://github.com/qmk/qmk_firmware/pull/12314)) | |||
| * add support for m65 and simple 5x13 ortholinear ([#12315](https://github.com/qmk/qmk_firmware/pull/12315)) | |||
| * Relocalize and Update p1800fl ([#12425](https://github.com/qmk/qmk_firmware/pull/12425)) | |||
| * GameBuddy v1.M ([#12637](https://github.com/qmk/qmk_firmware/pull/12637)) | |||
| * Add mechlovin9 rev2 PCB ([#12767](https://github.com/qmk/qmk_firmware/pull/12767)) | |||
| * Add RGB matrix support for Kyria ([#12789](https://github.com/qmk/qmk_firmware/pull/12789)) | |||
| * RGB Matrix working for Sofle RGB ([#12861](https://github.com/qmk/qmk_firmware/pull/12861)) | |||
| * Add Durgod Hades, Galaxy and Venus Keyboards ([#12893](https://github.com/qmk/qmk_firmware/pull/12893)) | |||
| * kint36: set correct EEPROM size ([#12946](https://github.com/qmk/qmk_firmware/pull/12946)) | |||
| * Updated encoder_update_user on my keymap to follow the new signature on quantum ([#13152](https://github.com/qmk/qmk_firmware/pull/13152)) | |||
| * Add Creator Pro by SergioPoverony ([#13154](https://github.com/qmk/qmk_firmware/pull/13154)) | |||
| * Use the new ST7565 driver on Ergodox Infinity ([#13165](https://github.com/qmk/qmk_firmware/pull/13165)) | |||
| * Refactor atom47 and add rev4 and rev5 ([#13201](https://github.com/qmk/qmk_firmware/pull/13201)) | |||
| * Add Bakeneko65 V3 and revision folders ([#13228](https://github.com/qmk/qmk_firmware/pull/13228)) | |||
| * Keyboards/RGBKB/Mün ([#13239](https://github.com/qmk/qmk_firmware/pull/13239)) | |||
| * Optimize our jsonschema by using refs ([#13271](https://github.com/qmk/qmk_firmware/pull/13271)) | |||
| * Handwired/Stream_Cheap/2x4: Add via support ([#13297](https://github.com/qmk/qmk_firmware/pull/13297)) | |||
| * ez_maker/directpins for easy one-offs in qmk_configurator ([#13321](https://github.com/qmk/qmk_firmware/pull/13321)) | |||
| * add kinT kinesis keyboard controller (kint41 variant) ([#13333](https://github.com/qmk/qmk_firmware/pull/13333)) | |||
| * Error log cleanup ([#13349](https://github.com/qmk/qmk_firmware/pull/13349)) | |||
| * Drashna's split updates ([#13350](https://github.com/qmk/qmk_firmware/pull/13350)) | |||
| * Migrate SHIFT_ESC and RGB `fn_actions` to Grave Escape and RGB keycodes ([#13360](https://github.com/qmk/qmk_firmware/pull/13360)) | |||
| * Add a lot more data to info.json ([#13366](https://github.com/qmk/qmk_firmware/pull/13366)) | |||
| * Remove `API_SYSEX_ENABLE`s from rules.mk ([#13389](https://github.com/qmk/qmk_firmware/pull/13389)) | |||
| * gmmk/pro/mike1808 keymap ([#13398](https://github.com/qmk/qmk_firmware/pull/13398)) | |||
| * Remove deprecated callbacks for encoders and dip switches ([#13404](https://github.com/qmk/qmk_firmware/pull/13404)) | |||
| * first pass: matrix consistency improvements ([#13471](https://github.com/qmk/qmk_firmware/pull/13471)) | |||
| * Migrate more `fn_actions` stuff ([#13502](https://github.com/qmk/qmk_firmware/pull/13502)) | |||
| * add simple gmmk pro macos keymap with rgb ([#13504](https://github.com/qmk/qmk_firmware/pull/13504)) | |||
| * move volcano660 to ilumkb folder ([#13550](https://github.com/qmk/qmk_firmware/pull/13550)) | |||
| * Valor Rev 2 ([#13551](https://github.com/qmk/qmk_firmware/pull/13551)) | |||
| * Split GMMK Pro PCBs into separate revisions ([#13570](https://github.com/qmk/qmk_firmware/pull/13570)) | |||
| * Remove the vision_division keyboard ([#13571](https://github.com/qmk/qmk_firmware/pull/13571)) | |||
| * Develop - Change uint32_t to layer_state_t ([#13596](https://github.com/qmk/qmk_firmware/pull/13596)) | |||
| * Develop - DC01 left ([#13597](https://github.com/qmk/qmk_firmware/pull/13597)) | |||
| * Created "paddlegame" keymap ([#13629](https://github.com/qmk/qmk_firmware/pull/13629)) | |||
| * Add timer_avr to includes for broken builds ([#13641](https://github.com/qmk/qmk_firmware/pull/13641)) | |||
| * Disable console by default on all Keebio boards ([#13649](https://github.com/qmk/qmk_firmware/pull/13649)) | |||
| * Enable LTO by default on BastardKB Scylla ([#13664](https://github.com/qmk/qmk_firmware/pull/13664)) | |||
| * Reduce compile size for dz60rgb v2.1 ([#13680](https://github.com/qmk/qmk_firmware/pull/13680)) | |||
| * Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines ([#13689](https://github.com/qmk/qmk_firmware/pull/13689)) | |||
| * Remove some legacy files ([#13715](https://github.com/qmk/qmk_firmware/pull/13715)) | |||
| * [Keyboard Update] Change to L422 ([#13717](https://github.com/qmk/qmk_firmware/pull/13717)) | |||
| * Update kyria make path example ([#13720](https://github.com/qmk/qmk_firmware/pull/13720)) | |||
| * Drashna's Defaults cleanup ([#13722](https://github.com/qmk/qmk_firmware/pull/13722)) | |||
| * Reduce firmware size in prep for #12670 ([#13724](https://github.com/qmk/qmk_firmware/pull/13724)) | |||
| * Tidy up rgbkb/mun ([#13801](https://github.com/qmk/qmk_firmware/pull/13801)) | |||
| * Make default keymap for GMMK Pro reflect stock ([#13850](https://github.com/qmk/qmk_firmware/pull/13850)) | |||
| * Rework as per 9824 ([#13898](https://github.com/qmk/qmk_firmware/pull/13898)) | |||
| * Remove console from keebio via keyboards ([#13901](https://github.com/qmk/qmk_firmware/pull/13901)) | |||
| * Drashna split transport improvement ([#13905](https://github.com/qmk/qmk_firmware/pull/13905)) | |||
| * Copy GMMK Pro screw specs to ISO readme ([#13908](https://github.com/qmk/qmk_firmware/pull/13908)) | |||
| * Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines Part 2 ([#13912](https://github.com/qmk/qmk_firmware/pull/13912)) | |||
| * Add andrebrait layout for GMMK Pro ([#13932](https://github.com/qmk/qmk_firmware/pull/13932)) | |||
| * Updated RGB Matrix suspend define part 3 ([#13954](https://github.com/qmk/qmk_firmware/pull/13954)) | |||
| * Improve andrebrait keymap ([#13985](https://github.com/qmk/qmk_firmware/pull/13985)) | |||
| * Drashna's Improve OLEDs and custom Split code ([#14063](https://github.com/qmk/qmk_firmware/pull/14063)) | |||
| * Kyria default reformat ([#14080](https://github.com/qmk/qmk_firmware/pull/14080)) | |||
| * Feature rich keymap for GMMK Pro (ANSI) ([#14120](https://github.com/qmk/qmk_firmware/pull/14120)) | |||
| Keyboard fixes: | |||
| * Fix LED mapping for GMMK Pro ([#13189](https://github.com/qmk/qmk_firmware/pull/13189)) | |||
| * Fix up SplitKB keyboards ([#13511](https://github.com/qmk/qmk_firmware/pull/13511)) | |||
| * Keyboards/sol rev2 fix ([#13533](https://github.com/qmk/qmk_firmware/pull/13533)) | |||
| * Fix MATRIX_COLS for aeboards/constellation/rev2 ([#13633](https://github.com/qmk/qmk_firmware/pull/13633)) | |||
| * Fix errors with matrix_output_unselect_delay function calls ([#13645](https://github.com/qmk/qmk_firmware/pull/13645)) | |||
| * Fix default keymap for 0xCB 1337 keyboard ([#13646](https://github.com/qmk/qmk_firmware/pull/13646)) | |||
| * Fix Matrix Row number for ggkeyboards/genisis ([#13647](https://github.com/qmk/qmk_firmware/pull/13647)) | |||
| * Fix matrix issues with Promethium ([#13648](https://github.com/qmk/qmk_firmware/pull/13648)) | |||
| * Fix dc01/left so that it doesn't throw a warning ([#13653](https://github.com/qmk/qmk_firmware/pull/13653)) | |||
| * Remove broken, unmaintained converter/ibm_5291 ([#13658](https://github.com/qmk/qmk_firmware/pull/13658)) | |||
| * Quick hack to fix Astro65 board ([#13665](https://github.com/qmk/qmk_firmware/pull/13665)) | |||
| * Fix symmetric70_proto build break on develop branch ([#13667](https://github.com/qmk/qmk_firmware/pull/13667)) | |||
| * Fix matrix delay on Drop boards ([#13671](https://github.com/qmk/qmk_firmware/pull/13671)) | |||
| * Fix split matrix for sekigon grs 70ec ([#13672](https://github.com/qmk/qmk_firmware/pull/13672)) | |||
| * Fix type on pandora via keymap ([#13681](https://github.com/qmk/qmk_firmware/pull/13681)) | |||
| * Fix & clean up tronguylabs/m122_3270 ([#13684](https://github.com/qmk/qmk_firmware/pull/13684)) | |||
| * Fix up xd002 rgb keymaps ([#13685](https://github.com/qmk/qmk_firmware/pull/13685)) | |||
| * Dactyl Manuform cleanup ([#13686](https://github.com/qmk/qmk_firmware/pull/13686)) | |||
| * Fix Q1 change dip switch to bool ([#13687](https://github.com/qmk/qmk_firmware/pull/13687)) | |||
| * Fix compile size for the Merge UM70 via keymap ([#13690](https://github.com/qmk/qmk_firmware/pull/13690)) | |||
| * Fix compile size for the Lets Split Sockets via keymap ([#13691](https://github.com/qmk/qmk_firmware/pull/13691)) | |||
| * Fix Compile size on ungodly Launch Pad ([#13692](https://github.com/qmk/qmk_firmware/pull/13692)) | |||
| * dirty fix ([#13695](https://github.com/qmk/qmk_firmware/pull/13695)) | |||
| * Fix compile size for the Vitamins Included via keymap ([#13696](https://github.com/qmk/qmk_firmware/pull/13696)) | |||
| * Fix typo in Dactyl Manuform ([#13740](https://github.com/qmk/qmk_firmware/pull/13740)) | |||
| * Fix compile issues due to LED changes ([#13821](https://github.com/qmk/qmk_firmware/pull/13821)) | |||
| * Fix SRC include for matrix/m20add issi driver ([#13826](https://github.com/qmk/qmk_firmware/pull/13826)) | |||
| * fix develop branch move file ([#13832](https://github.com/qmk/qmk_firmware/pull/13832)) | |||
| * Fix knops keymaps ([#13872](https://github.com/qmk/qmk_firmware/pull/13872)) | |||
| * Switch Draculad to using WPM char hack ([#13886](https://github.com/qmk/qmk_firmware/pull/13886)) | |||
| * Fix up builds after #8591 ([#13900](https://github.com/qmk/qmk_firmware/pull/13900)) | |||
| * Fix matrix_output_unselect_delay for handwired/xealousbrown ([#13913](https://github.com/qmk/qmk_firmware/pull/13913)) | |||
| * Fixup rgb matrix config for KBD67 mkII boards ([#13931](https://github.com/qmk/qmk_firmware/pull/13931)) | |||
| * Fix compliation for ferris 0.2 bling ([#13937](https://github.com/qmk/qmk_firmware/pull/13937)) | |||
| * Fix some additional bootmagic settings ([#13979](https://github.com/qmk/qmk_firmware/pull/13979)) | |||
| * Fix default keymap for GMMK Pro Iso ([#13980](https://github.com/qmk/qmk_firmware/pull/13980)) | |||
| * Fixup Ungodly Launch Pad config ([#13992](https://github.com/qmk/qmk_firmware/pull/13992)) | |||
| * Fix errors that have cropped up in develop ([#14005](https://github.com/qmk/qmk_firmware/pull/14005)) | |||
| * Fix wait_us overflow in matrix for dactyl based boards ([#14039](https://github.com/qmk/qmk_firmware/pull/14039)) | |||
| * Fixup Neson Design N6 ISSI includes ([#14045](https://github.com/qmk/qmk_firmware/pull/14045)) | |||
| * Fixup `massdrop/alt`, `cest73/tkm`. ([#14048](https://github.com/qmk/qmk_firmware/pull/14048)) | |||
| * fix helix:fraanrosi compile error caused by #13677. ([#14061](https://github.com/qmk/qmk_firmware/pull/14061)) | |||
| * Fix compile issues for Tractyl Manuform ([#14105](https://github.com/qmk/qmk_firmware/pull/14105)) | |||
| * Disable Console on Keebio Quefrency ([#14108](https://github.com/qmk/qmk_firmware/pull/14108)) | |||
| * Fixed GMMK Pro -> stickandgum keymap readme.md ([#14123](https://github.com/qmk/qmk_firmware/pull/14123)) | |||
| * Drashna keymap fixups ([#14140](https://github.com/qmk/qmk_firmware/pull/14140)) | |||
| * fix ([#14142](https://github.com/qmk/qmk_firmware/pull/14142)) | |||
| * Fix merge artifacts ([#14146](https://github.com/qmk/qmk_firmware/pull/14146)) | |||
| * Update readme files ([#14172](https://github.com/qmk/qmk_firmware/pull/14172)) | |||
| Others: | |||
| * Add examples to RGB Matrix Indicators docs ([#12797](https://github.com/qmk/qmk_firmware/pull/12797)) | |||
| Bugs: | |||
| * Fix Indicator LED issues ([#12097](https://github.com/qmk/qmk_firmware/pull/12097)) | |||
| * Fixing incorrect keymap build when switching between multiple keymap.jsons ([#12632](https://github.com/qmk/qmk_firmware/pull/12632)) | |||
| * Fix LED Hit Counter for LED/RGB Matrix ([#12674](https://github.com/qmk/qmk_firmware/pull/12674)) | |||
| * ChibiOS fix O3 and LTO breakage of extra keys and joystick ([#12819](https://github.com/qmk/qmk_firmware/pull/12819)) | |||
| * Remove the #10088 hotfix for Teensy 3.1-like Input:Club keyboards ([#12870](https://github.com/qmk/qmk_firmware/pull/12870)) | |||
| * Fix firmware size check with avr-libc 1:2.0.0+Atmel3.6.2-1.1 (Debian bullseye) ([#12951](https://github.com/qmk/qmk_firmware/pull/12951)) | |||
| * Fix RGB/LED Suspend defines ([#13146](https://github.com/qmk/qmk_firmware/pull/13146)) | |||
| * Fix overrun in st7565_write_raw when not at (0, 0) ([#13209](https://github.com/qmk/qmk_firmware/pull/13209)) | |||
| * Upgrades Vagrant box to Debian 10 to fix Docker build error on Debian 9. ([#13236](https://github.com/qmk/qmk_firmware/pull/13236)) | |||
| * Fix issues with VIA EEPROM init and bring in line with eeconfig functionality ([#13243](https://github.com/qmk/qmk_firmware/pull/13243)) | |||
| * Fix CRC for AVR and enable again. ([#13253](https://github.com/qmk/qmk_firmware/pull/13253)) | |||
| * Fix linker error when rgblight and RGB Matrix are both enabled ([#13304](https://github.com/qmk/qmk_firmware/pull/13304)) | |||
| * Fix building layouts from JSON ([#13310](https://github.com/qmk/qmk_firmware/pull/13310)) | |||
| * Add rgblight to RGB Matrix VPATH ([#13371](https://github.com/qmk/qmk_firmware/pull/13371)) | |||
| * Fix two out of bounds accesses from #13330. ([#13525](https://github.com/qmk/qmk_firmware/pull/13525)) | |||
| * Fixes for clang not being able to run unit tests ([#13546](https://github.com/qmk/qmk_firmware/pull/13546)) | |||
| * Fixup Audio startup and add to documents ([#13606](https://github.com/qmk/qmk_firmware/pull/13606)) | |||
| * CLI/Docs: Fix the format commands' name ([#13668](https://github.com/qmk/qmk_firmware/pull/13668)) | |||
| * Disables rgblight twinkle by default. ([#13677](https://github.com/qmk/qmk_firmware/pull/13677)) | |||
| * Fix typo in dip switch example ([#13688](https://github.com/qmk/qmk_firmware/pull/13688)) | |||
| * docs/cli_commands: fix typo ([#13697](https://github.com/qmk/qmk_firmware/pull/13697)) | |||
| * Include gpio.h in solenoid driver for GPIO Control functions ([#13716](https://github.com/qmk/qmk_firmware/pull/13716)) | |||
| * Fix pimoroni trackball read address ([#13810](https://github.com/qmk/qmk_firmware/pull/13810)) | |||
| * Fix Key Override includes ([#13831](https://github.com/qmk/qmk_firmware/pull/13831)) | |||
| * Fix alignment of USB out report buffer 2 -> 4 ([#13838](https://github.com/qmk/qmk_firmware/pull/13838)) | |||
| * Fix compilation issue. ([#13926](https://github.com/qmk/qmk_firmware/pull/13926)) | |||
| * Fix `combo_disable` ([#13988](https://github.com/qmk/qmk_firmware/pull/13988)) | |||
| * Fix pmw3360 code to only output debug info if mouse debugging is enabled ([#13993](https://github.com/qmk/qmk_firmware/pull/13993)) | |||
| * Fix ifdefs for OLED split sync code ([#14017](https://github.com/qmk/qmk_firmware/pull/14017)) | |||
| * Various fixes from reorg of files ([#14051](https://github.com/qmk/qmk_firmware/pull/14051)) | |||
| * Fixup atsam builds. ([#14052](https://github.com/qmk/qmk_firmware/pull/14052)) | |||
| * Fix RGB/LED Matrix Suspend code ([#14084](https://github.com/qmk/qmk_firmware/pull/14084)) | |||
| * Fix issues with recent keymap.json changes ([#14089](https://github.com/qmk/qmk_firmware/pull/14089)) | |||
| * Fix LED Matrix suspend code ([#14090](https://github.com/qmk/qmk_firmware/pull/14090)) | |||
| * Fix up compilation issues. ([#14095](https://github.com/qmk/qmk_firmware/pull/14095)) | |||
| * Fix copypasta issue with pmw3360 sensor config ([#14106](https://github.com/qmk/qmk_firmware/pull/14106)) | |||
| * Fix typo ([#14118](https://github.com/qmk/qmk_firmware/pull/14118)) | |||
| * Fix bootloadHID comments breaking :flash ([#14133](https://github.com/qmk/qmk_firmware/pull/14133)) | |||
| * Fix Mouse Shared EP functionality ([#14136](https://github.com/qmk/qmk_firmware/pull/14136)) | |||
| * Short term bodge for firmware size bloat ([#14144](https://github.com/qmk/qmk_firmware/pull/14144)) | |||
| * Move to correct location ([#14171](https://github.com/qmk/qmk_firmware/pull/14171)) | |||
+ 6
- 1
_summary.md
View File
+ 11
- 6
breaking_changes.md
View File
+ 1
- 0
breaking_changes_history.md
View File
+ 56
- 0
chibios_upgrade_instructions.md
View File
| @ -0,0 +1,56 @@ | |||
| # ChibiOS Upgrade Procedure | |||
| ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a branch tied to the ChibiOS version in use and should not be mixed with different versions. | |||
| ## Getting ChibiOS | |||
| * `svn` Initialisation: | |||
| * Only needed to be done once | |||
| * You might need to separately install `git-svn` package in your OS's package manager | |||
| * `git svn init --stdlayout --prefix='svn/' http://svn.osdn.net/svnroot/chibios/` | |||
| * `git remote add qmk git@github.com:qmk/ChibiOS.git` | |||
| * Updating: | |||
| * `git svn fetch` | |||
| * First time around this will take several hours | |||
| * Subsequent updates will be incremental only | |||
| * Tagging example (work out which version first!): | |||
| * `git tag -a ver20.3.3 -m ver20.3.3 svn/tags/ver20.3.3` | |||
| * `git push qmk ver20.3.3` | |||
| * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN svn/tags/ver20.3.3` | |||
| * `git push qmk breaking_YYYY_qN` | |||
| ## Getting ChibiOS-Contrib | |||
| * `git` Initialisation: | |||
| * `git clone git@github.com:qmk/ChibiOS-Contrib` | |||
| * `git remote add upstream https://github.com/ChibiOS/ChibiOS-Contrib` | |||
| * `git checkout -b chibios-20.3.x upstream/chibios-20.3.x` | |||
| * Updating: | |||
| * `git fetch --all --tags --prune` | |||
| * `git checkout chibios-20.3.x` | |||
| * `git pull --ff-only` | |||
| * `git push origin chibios-20.3.x` | |||
| * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN chibios-20.3.x` | |||
| * `git push origin breaking_YYYY_qN` | |||
| ## Updating submodules | |||
| * Update the submodules | |||
| * `cd $QMK_FIRMWARE` | |||
| * `git checkout develop` | |||
| * `git pull --ff-only` | |||
| * `git checkout -b chibios-version-bump` | |||
| * `cd lib/chibios` | |||
| * `git fetch --all --tags --prune` | |||
| * `git checkout breaking_YYYY_qN` | |||
| * `cd ../chibios-contrib` | |||
| * `git fetch --all --tags --prune` | |||
| * `git checkout breaking_YYYY_qN` | |||
| * Build everything | |||
| * `cd $QMK_FIRMWARE` | |||
| * `qmk multibuild -j4` | |||
| * Make sure there are no errors | |||
| * Push to the repo | |||
| * `git commit -am 'Update ChibiOS to XXXXXXXXX'` | |||
| * `git push --set-upstream origin chibios-version-bump` | |||
| * Make a PR to qmk_firmware with the new branch | |||
+ 36
- 14
cli_commands.md
View File
+ 2
- 2
cli_development.md
View File
+ 3
- 0
compatible_microcontrollers.md
View File
+ 50
- 3
config_options.md
View File
+ 9
- 1
custom_quantum_functions.md
View File
+ 4
- 4
de/cli.md
View File
+ 3
- 2
driver_installation_zadig.md
View File
+ 31
- 0
easy_maker.md
View File
| @ -0,0 +1,31 @@ | |||
| # Easy Maker - Build One-Off Projects In Configurator | |||
| Have you ever needed an easy way to program a controller, such as a Proton C or Teensy 2.0, for a one-off project you're building? QMK has you covered with the Easy Maker. Now you can create a firmware in minutes using QMK Configurator. | |||
| There are different styles of Easy Maker available depending on your needs: | |||
| * [Direct Pin](https://config.qmk.fm/#/?filter=ez_maker/direct) - Connect a single switch to a single pin | |||
| * Direct Pin + Backlight (Coming Soon) - Like Direct Pin but dedicates a single pin to [Backlight](feature_backlight.md) control | |||
| * Direct Pin + Numlock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED | |||
| * Direct Pin + Capslock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED | |||
| * Direct Pin + Encoder (Coming Soon) - Like Direct Pin but uses 2 pins to add a single rotary encoder | |||
| ## Quickstart | |||
| The easiest way to get started is with the Direct Pin boards. This will assign a single key to each pin and you can short that pin to ground to activate it. Select your MCU from the Keyboard dropdown here: | |||
| * <https://config.qmk.fm/#/?filter=ez_maker/direct> | |||
| For more details see the [Direct Pin](#direct-pin) section. | |||
| # Direct Pin | |||
| As its name implies Direct Pin works by connecting one switch per pin. The other side of the switch should be connected to ground (VSS or GND.) You don't need any other components, your MCU has internal pull-up resistors so that the switch sensing can work. | |||
| Here is a schematic showing how we connect a single button to pin A3 on a ProMicro: | |||
|  | |||
| Once you have wired your switches you can assign keycodes to each pin and build a firmware by selecting the MCU you are using from the Keyboard dropdown. Use this link to show only Easy Maker Direct Pin: | |||
| * <https://config.qmk.fm/#/?filter=ez_maker/direct> | |||
+ 3
- 0
eeprom_driver.md
View File
+ 20
- 18
es/hardware_avr.md
View File
+ 1
- 1
faq_keymap.md
View File
+ 26
- 0
feature_audio.md
View File
+ 13
- 128
feature_bootmagic.md
View File
+ 259
- 33
feature_combo.md
View File
+ 1
- 1
feature_command.md
View File
+ 2
- 19
feature_debounce_type.md
View File
+ 35
- 0
feature_digitizer.md
View File
| @ -0,0 +1,35 @@ | |||
| ## Digitizer | |||
| The digitizer HID interface allows setting the mouse cursor position at absolute coordinates, unlike the Pointing Device feature that applies relative displacements. | |||
| To enable the digitizer interface, add the following line to your rules.mk: | |||
| ```makefile | |||
| DIGITIZER_ENABLE = yes | |||
| ``` | |||
| In order to change the mouse cursor position from your keymap.c file, include the digitizer header : | |||
| ```c | |||
| #include "digitizer.h" | |||
| ``` | |||
| This gives you access to the `digitizer` structure which members allow you to change the cursor position. | |||
| The coordinates are normalized, meaning there value must be set between 0 and 1. For the `x` coordinate, the value `0` is the leftmost position, whereas the value `1` is the rightmost position. | |||
| For the `y` coordinate, `0` is at the top and `1` at the bottom. | |||
| Here is an example setting the cursor in the middle of the screen: | |||
| ```c | |||
| digitizer_t digitizer; | |||
| digitizer.x = 0.5; | |||
| digitizer.y = 0.5; | |||
| digitizer.tipswitch = 0; | |||
| digitizer.inrange = 1; | |||
| digitizer_set_report(digitizer); | |||
| ``` | |||
| The `tipswitch` member triggers what equates to a click when set to `1`. The `inrange` member is required for the change in coordinates to be taken. It can then be set to `0` in a new report to signal the end of the digitizer interaction, but it is not strictly required. | |||
| Once all members are set to the desired value, the `status` member needs its bitmask `DZ_UPDATED` to be set so the report is sent during the next main loop iteration. | |||
+ 12
- 7
feature_dip_switch.md
View File
+ 6
- 0
feature_encoders.md
View File
+ 25
- 1
feature_haptic_feedback.md
View File
+ 229
- 0
feature_key_overrides.md
View File
| @ -0,0 +1,229 @@ | |||
| # Key Overrides | |||
| Key overrides allow you to override modifier-key combinations to send a different modifier-key combination or perform completely custom actions. Don't want `shift` + `1` to type `!` on your computer? Use a key override to make your keyboard type something different when you press `shift` + `1`. The general behavior is like this: If `modifiers w` + `key x` are pressed, replace these keys with `modifiers y` + `key z` in the keyboard report. | |||
| You can use key overrides in a similar way to momentary layer/fn keys to activate custom keycodes/shortcuts, with a number of benefits: You completely keep the original use of the modifier keys, while being able to save space by removing fn keys from your keyboard. You can also easily configure _combinations of modifiers_ to trigger different actions than individual modifiers, and much more. The possibilities are quite vast and this documentation contains a few examples for inspiration throughout. | |||
| ##### A few more examples to get started: You could use key overrides to... | |||
| - Send `brightness up/down` when pressing `ctrl` + `volume up/down`. | |||
| - Send `delete` when pressing `shift` + `backspace`. | |||
| - Create custom shortcuts or change existing ones: E.g. Send `ctrl`+`shift`+`z` when `ctrl`+`y` is pressed. | |||
| - Run custom code when `ctrl` + `alt` + `esc` is pressed. | |||
| ## Setup | |||
| To enable this feature, you need to add `KEY_OVERRIDE_ENABLE = yes` to your `rules.mk`. | |||
| Then, in your `keymap.c` file, you'll need to define the array `key_overrides`, which defines all key overrides to be used. Each override is a value of type `key_override_t`. The array `key_overrides` is `NULL`-terminated and contains pointers to `key_override_t` values (`const key_override_t **`). | |||
| ## Creating Key Overrides | |||
| The `key_override_t` struct has many options that allow you to precisely tune your overrides. The full reference is shown below. Instead of manually creating a `key_override_t` value, it is recommended to use these dedicated initializers: | |||
| #### `ko_make_basic(modifiers, key, replacement)` | |||
| Returns a `key_override_t`, which sends `replacement` (can be a key-modifer combination), when `key` and `modifiers` are all pressed down. This override still activates if any additional modifiers not specified in `modifiers` are also pressed down. See `ko_make_with_layers_and_negmods` to customize this behavior. | |||
| #### `ko_make_with_layers(modifiers, key, replacement, layers)` | |||
| Additionally takes a bitmask `layers` that defines on which layers the override is used. | |||
| #### `ko_make_with_layers_and_negmods(modifiers, key, replacement, layers, negative_mods)` | |||
| Additionally takes a bitmask `negative_mods` that defines which modifiers may not be pressed for this override to activate. | |||
| #### `ko_make_with_layers_negmods_and_options(modifiers, key, replacement, layers, negative_mods, options)` | |||
| Additionally takes a bitmask `options` that specifies additional options. See `ko_option_t` for available options. | |||
| For more customization possibilities, you may directly create a `key_override_t`, which allows you to customize even more behavior. Read further below for details and examples. | |||
| ## Simple Example | |||
| This shows how the mentioned example of sending `delete` when `shift` + `backspace` are pressed is realized: | |||
| ```c | |||
| const key_override_t delete_key_override = ko_make_basic(MOD_MASK_SHIFT, KC_BSPACE, KC_DELETE); | |||
| // This globally defines all key overrides to be used | |||
| const key_override_t **key_overrides = (const key_override_t *[]){ | |||
| &delete_key_override, | |||
| NULL // Null terminate the array of overrides! | |||
| }; | |||
| ``` | |||
| ## Intermediate Difficulty Examples | |||
| ### Media Controls & Screen Brightness | |||
| In this example a single key is configured to control media, volume and screen brightness by using key overrides. | |||
| - The key is set to send `play/pause` in the keymap. | |||
| The following key overrides will be configured: | |||
| - `Ctrl` + `play/pause` will send `next track`. | |||
| - `Ctrl` + `Shift` + `play/pause` will send `previous track`. | |||
| - `Alt` + `play/pause` will send `volume up`. | |||
| - `Alt` + `Shift` + `play/pause` will send `volume down`. | |||
| - `Ctrl` + `Alt` + `play/pause` will send `brightness up`. | |||
| - `Ctrl` + `Alt` + `Shift` + `play/pause` will send `brightness down`. | |||
| ```c | |||
| const key_override_t next_track_override = | |||
| ko_make_with_layers_negmods_and_options( | |||
| MOD_MASK_CTRL, // Trigger modifiers: ctrl | |||
| KC_MPLY, // Trigger key: play/pause | |||
| KC_MNXT, // Replacement key | |||
| ~0, // Activate on all layers | |||
| MOD_MASK_SA, // Do not activate when shift or alt are pressed | |||
| ko_option_no_reregister_trigger); // Specifies that the play key is not registered again after lifting ctrl | |||
| const key_override_t prev_track_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CS, KC_MPLY, | |||
| KC_MPRV, ~0, MOD_MASK_ALT, ko_option_no_reregister_trigger); | |||
| const key_override_t vol_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_ALT, KC_MPLY, | |||
| KC_VOLU, ~0, MOD_MASK_CS, ko_option_no_reregister_trigger); | |||
| const key_override_t vol_down_override = ko_make_with_layers_negmods_and_options(MOD_MASK_SA, KC_MPLY, | |||
| KC_VOLD, ~0, MOD_MASK_CTRL, ko_option_no_reregister_trigger); | |||
| const key_override_t brightness_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CA, KC_MPLY, | |||
| KC_BRIU, ~0, MOD_MASK_SHIFT, ko_option_no_reregister_trigger); | |||
| const key_override_t brightness_down_override = ko_make_basic(MOD_MASK_CSA, KC_MPLY, KC_BRID); | |||
| // This globally defines all key overrides to be used | |||
| const key_override_t **key_overrides = (const key_override_t *[]){ | |||
| &next_track_override, | |||
| &prev_track_override, | |||
| &vol_up_override, | |||
| &vol_down_override, | |||
| &brightness_up_override, | |||
| &brightness_down_override, | |||
| NULL | |||
| }; | |||
| ``` | |||
| ### Flexible macOS-friendly Grave Escape | |||
| The [Grave Escape feature](https://docs.qmk.fm/using-qmk/advanced-keycodes/feature_grave_esc) is limited in its configurability and has [bugs when used on macOS](https://docs.qmk.fm/using-qmk/advanced-keycodes/feature_grave_esc#caveats). Key overrides can be used to achieve a similar functionality as Grave Escape, but with more customization and without bugs on macOS. | |||
| ```c | |||
| // Shift + esc = ~ | |||
| const key_override_t tilde_esc_override = ko_make_basic(MOD_MASK_SHIFT, KC_ESC, S(KC_GRAVE)); | |||
| // GUI + esc = ` | |||
| const key_override_t grave_esc_override = ko_make_basic(MOD_MASK_GUI, KC_ESC, KC_GRAVE); | |||
| const key_override_t **key_overrides = (const key_override_t *[]){ | |||
| &tilde_esc_override, | |||
| &grave_esc_override, | |||
| NULL | |||
| }; | |||
| ``` | |||
| In addition to not encountering unexpected bugs on macOS, you can also change the behavior as you wish. Instead setting `GUI` + `ESC` = `` ` `` you may change it to an arbitrary other modifier, for example `Ctrl` + `ESC` = `` ` ``. | |||
| ## Advanced Examples | |||
| ### Modifiers as Layer Keys | |||
| Do you really need a dedicated key to toggle your fn layer? With key overrides, perhaps not. This example shows how you can configure to use `rGUI` + `rAlt` (right GUI and right alt) to access a momentary layer like an fn layer. With this you completely eliminate the need to use a dedicated layer key. Of course the choice of modifier keys can be changed as needed, `rGUI` + `rAlt` is just an example here. | |||
| ```c | |||
| // This is called when the override activates and deactivates. Enable the fn layer on activation and disable on deactivation | |||
| bool momentary_layer(bool key_down, void *layer) { | |||
| if (key_down) { | |||
| layer_on((uint8_t)(uintptr_t)layer); | |||
| } else { | |||
| layer_off((uint8_t)(uintptr_t)layer); | |||
| } | |||
| return false; | |||
| } | |||
| const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), // | |||
| .layers = ~(1 << LAYER_FN), // | |||
| .suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL), // | |||
| .options = ko_option_no_unregister_on_other_key_down, // | |||
| .negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL)), // | |||
| .custom_action = momentary_layer, // | |||
| .context = (void *)LAYER_FN, // | |||
| .trigger = KC_NO, // | |||
| .replacement = KC_NO, // | |||
| .enabled = NULL}; | |||
| ``` | |||
| ## Keycodes | |||
| You can enable, disable and toggle all key overrides on the fly. | |||
| |Keycode |Description |Function Equivalent| | |||
| |----------|---------------------------------|--------| | |||
| |`KEY_OVERRIDE_ON` |Turns on Key Override feature | `key_override_on(void)`| | |||
| |`KEY_OVERRIDE_OFF` |Turns off Key Override feature |`key_override_off(void)`| | |||
| |`KEY_OVERRIDE_TOGGLE` |Toggles Key Override feature on and off |`key_override_toggle(void)`| | |||
| ## Reference for `key_override_t` | |||
| Advanced users may need more customization than what is offered by the simple `ko_make` initializers. For this, directly create a `key_override_t` value and set all members. Below is a reference for all members of `key_override_t`. | |||
| | Member | Description | | |||
| |--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| | `uint16_t trigger` | The non-modifier keycode that triggers the override. This keycode, and the necessary modifiers (`trigger_mods`) must be pressed to activate this override. Set this to the keycode of the key that should activate the override. Set to `KC_NO` to require only the necessary modifiers to be pressed and no non-modifier. | | |||
| | `uint8_t trigger_mods` | Which mods need to be down for activation. If both sides of a modifier are set (e.g. left ctrl and right ctrl) then only one is required to be pressed (e.g. left ctrl suffices). Use the `MOD_MASK_XXX` and `MOD_BIT()` macros for this. | | |||
| | `layer_state_t layers` | This is a BITMASK (!), defining which layers this override applies to. To use this override on layer i set the ith bit `(1 << i)`. | | |||
| | `uint8_t negative_mod_mask` | Which modifiers cannot be down. It must hold that `(active_modifiers & negative_mod_mask) == 0`, otherwise the key override will not be activated. An active override will be deactivated once this is no longer true. | | |||
| | `uint8_t suppressed_mods` | Modifiers to 'suppress' while the override is active. To suppress a modifier means that even though the modifier key is held down, the host OS sees the modifier as not pressed. Can be used to suppress the trigger modifiers, as a trivial example. | | |||
| | `uint16_t replacement` | The complex keycode to send as replacement when this override is triggered. This can be a simple keycode, a key-modifier combination (e.g. `C(KC_A)`), or `KC_NO` (to register no replacement keycode). Use in combination with suppressed_mods to get the correct modifiers to be sent. | | |||
| | `ko_option_t options` | Options controlling the behavior of the override, such as what actions are allowed to activate the override. | | |||
| | `bool (*custom_action)(bool activated, void *context)` | If not NULL, this function will be called right before the replacement key is registered, along with the provided context and a flag indicating whether the override was activated or deactivated. This function allows you to run some custom actions for specific key overrides. If you return `false`, the replacement key is not registered/unregistered as it would normally. Return `true` to register and unregister the override normally. | | |||
| | `void *context` | A context that will be passed to the custom action function. | | |||
| | `bool *enabled` | If this points to false this override will not be used. Set to NULL to always have this override enabled. | | |||
| ### Reference for `ko_option_t` | |||
| Bitfield with various options controlling the behavior of a key override. | |||
| | Value | Description | | |||
| |------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| | `ko_option_activation_trigger_down` | Allow activating when the trigger key is pressed down. | | |||
| | `ko_option_activation_required_mod_down` | Allow activating when a necessary modifier is pressed down. | | |||
| | `ko_option_activation_negative_mod_up` | Allow activating when a negative modifier is released. | | |||
| | `ko_option_one_mod` | If set, any of the modifiers in `trigger_mods` will be enough to activate the override (logical OR of modifiers). If not set, all the modifiers in `trigger_mods` have to be pressed (logical AND of modifiers). | | |||
| | `ko_option_no_unregister_on_other_key_down` | If set, the override will not deactivate when another key is pressed down. Use only if you really know you need this. | | |||
| | `ko_option_no_reregister_trigger` | If set, the trigger key will never be registered again after the override is deactivated. | | |||
| | `ko_options_default` | The default options used by the `ko_make_xxx` functions | | |||
| ## For Advanced Users: Inner Workings | |||
| This section explains how a key override works in detail, explaining where each member of `key_override_t` comes into play. Understanding this is essential to be able to take full advantage of all the options offered by key overrides. | |||
| #### Activation | |||
| When the necessary keys are pressed (`trigger_mods` + `trigger`), the override is 'activated' and the replacement key is registered in the keyboard report (`replacement`), while the `trigger` key is removed from the keyboard report. The trigger modifiers may also be removed from the keyboard report upon activation of an override (`suppressed_mods`). The override will not activate if any of the `negative_modifiers` are pressed. | |||
| Overrides can activate in three different cases: | |||
| 1. The trigger key is pressed down and necessary modifiers are already down. | |||
| 2. A necessary modifier is pressed down, while the trigger key and other necessary modifiers are already down. | |||
| 3. A negative modifier is released, while all necessary modifiers and the trigger key are already down. | |||
| Use the `option` member to customize which of these events are allowed to activate your overrides (default: all three). | |||
| In any case, a key override can only activate if the `trigger` key is the _last_ non-modifier key that was pressed down. This emulates the behavior of how standard OSes (macOS, Windows, Linux) handle normal key input (to understand: Hold down `a`, then also hold down `b`, then hold down `shift`; `B` will be typed but not `A`). | |||
| #### Deactivation | |||
| An override is 'deactivated' when one of the trigger keys (`trigger_mods`, `trigger`) is lifted, another non-modifier key is pressed down, or one of the `negative_modifiers` is pressed down. When an override deactivates, the `replacement` key is removed from the keyboard report, while the `suppressed_mods` that are still held down are re-added to the keyboard report. By default, the `trigger` key is re-added to the keyboard report if it is still held down and no other non-modifier key has been pressed since. This again emulates the behavior of how standard OSes handle normal key input (To understand: hold down `a`, then also hold down `b`, then also `shift`, then release `b`; `A` will not be typed even though you are holding the `a` and `shift` keys). Use the `option` field `ko_option_no_reregister_trigger` to prevent re-registering the trigger key in all cases. | |||
| #### Key Repeat Delay | |||
| A third way in which standard OS-handling of modifier-key input is emulated in key overrides is with a ['key repeat delay'](https://www.dummies.com/computers/pcs/set-your-keyboards-repeat-delay-and-repeat-rate/). To explain what this is, let's look at how normal keyboard input is handled by mainstream OSes again: If you hold down `a`, followed by `shift`, you will see the letter `a` is first typed, then for a short moment nothing is typed and then repeating `A`s are typed. Take note that, although shift is pressed down just after `a` is pressed, it takes a moment until `A` is typed. This is caused by the aforementioned key repeat delay, and it is a feature that prevents unwanted repeated characters from being typed. | |||
| This applies equally to releasing a modifier: When you hold `shift`, then press `a`, the letter `A` is typed. Now if you release `shift` first, followed by `a` shortly after, you will not see the letter `a` being typed, even though for a short moment of time you were just holding down the key `a`. This is because no modified characters are typed until the key repeat delay has passed. | |||
| This exact behavior is implemented in key overrides as well: If a key override for `shift` + `a` = `b` exists, and `a` is pressed and held, followed by `shift`, you will not immediately see the letter `b` being typed. Instead, this event is deferred for a short moment, until the key repeat delay has passed, measured from the moment when the trigger key (`a`) was pressed down. | |||
| The duration of the key repeat delay is controlled with the `KEY_OVERRIDE_REPEAT_DELAY` macro. Define this value in your `config.h` file to change it. It is 500ms by default. | |||
| ## Difference to Combos | |||
| Note that key overrides are very different from [combos](https://docs.qmk.fm/#/feature_combo). Combos require that you press down several keys almost _at the same time_ and can work with any combination of non-modifier keys. Key overrides work like keyboard shortcuts (e.g. `ctrl` + `z`): They take combinations of _multiple_ modifiers and _one_ non-modifier key to then perform some custom action. Key overrides are implemented with much care to behave just like normal keyboard shortcuts would in regards to the order of pressed keys, timing, and interacton with other pressed keys. There are a number of optional settings that can be used to really fine-tune the behavior of each key override as well. Using key overrides also does not delay key input for regular key presses, which inherently happens in combos and may be undesirable. | |||
+ 23
- 50
feature_led_matrix.md
View File
+ 17
- 3
feature_oled_driver.md
View File
+ 36
- 2
feature_ps2_mouse.md
View File
+ 187
- 90
feature_rgb_matrix.md
View File
+ 28
- 23
feature_rgblight.md
View File
+ 139
- 11
feature_split_keyboard.md
View File
+ 274
- 0
feature_st7565.md
View File
| @ -0,0 +1,274 @@ | |||
| # ST7565 LCD Driver | |||
| ## Supported Hardware | |||
| LCD modules using ST7565 driver IC, communicating over SPI. | |||
| |Module |IC |Size |Notes | | |||
| |------------------------------|-------|------|----------------------------------------------------------| | |||
| |Newhaven Display NHD-C12832A1Z|ST7565R|128x32|Used by Ergodox Infinity; primary consumer of this feature| | |||
| |Zolentech ZLE12864B |ST7565P|128x64|Requires contrast adjustment | | |||
| ## Usage | |||
| To enable the feature, there are three steps. First, when compiling your keyboard, you'll need to add the following to your `rules.mk`: | |||
| ```make | |||
| ST7565_ENABLE = yes | |||
| ``` | |||
| Then in your `keymap.c` file, implement the ST7565 task call. This example assumes your keymap has three layers named `_QWERTY`, `_FN` and `_ADJ`: | |||
| ```c | |||
| #ifdef ST7565_ENABLE | |||
| void st7565_task_user(void) { | |||
| // Host Keyboard Layer Status | |||
| st7565_write_P(PSTR("Layer: "), false); | |||
| switch (get_highest_layer(layer_state)) { | |||
| case _QWERTY: | |||
| st7565_write_P(PSTR("Default\n"), false); | |||
| break; | |||
| case _FN: | |||
| st7565_write_P(PSTR("FN\n"), false); | |||
| break; | |||
| case _ADJ: | |||
| st7565_write_P(PSTR("ADJ\n"), false); | |||
| break; | |||
| default: | |||
| // Or use the write_ln shortcut over adding '\n' to the end of your string | |||
| st7565_write_ln_P(PSTR("Undefined"), false); | |||
| } | |||
| // Host Keyboard LED Status | |||
| led_t led_state = host_keyboard_led_state(); | |||
| st7565_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR(" "), false); | |||
| st7565_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR(" "), false); | |||
| st7565_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR(" "), false); | |||
| } | |||
| #endif | |||
| ``` | |||
| ## Logo Example | |||
| In the default font, certain ranges of characters are reserved for a QMK logo. To render this logo to the screen, use the following code example: | |||
| ```c | |||
| static void render_logo(void) { | |||
| static const char PROGMEM qmk_logo[] = { | |||
| 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90, 0x91, 0x92, 0x93, 0x94, | |||
| 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0, 0xB1, 0xB2, 0xB3, 0xB4, | |||
| 0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF, 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0x00 | |||
| }; | |||
| st7565_write_P(qmk_logo, false); | |||
| } | |||
| ``` | |||
| ## Buffer Read Example | |||
| For some purposes, you may need to read the current state of the display buffer. The `st7565_read_raw` function can be used to safely read bytes from the buffer. | |||
| In this example, calling `fade_display` in the `st7565_task_user` function will slowly fade away whatever is on the screen by turning random pixels off over time. | |||
| ```c | |||
| //Setup some mask which can be or'd with bytes to turn off pixels | |||
| const uint8_t single_bit_masks[8] = {127, 191, 223, 239, 247, 251, 253, 254}; | |||
| static void fade_display(void) { | |||
| //Define the reader structure | |||
| display_buffer_reader_t reader; | |||
| uint8_t buff_char; | |||
| if (random() % 30 == 0) { | |||
| srand(timer_read()); | |||
| // Fetch a pointer for the buffer byte at index 0. The return structure | |||
| // will have the pointer and the number of bytes remaining from this | |||
| // index position if we want to perform a sequential read by | |||
| // incrementing the buffer pointer | |||
| reader = st7565_read_raw(0); | |||
| //Loop over the remaining buffer and erase pixels as we go | |||
| for (uint16_t i = 0; i < reader.remaining_element_count; i++) { | |||
| //Get the actual byte in the buffer by dereferencing the pointer | |||
| buff_char = *reader.current_element; | |||
| if (buff_char != 0) { | |||
| st7565_write_raw_byte(buff_char & single_bit_masks[rand() % 8], i); | |||
| } | |||
| //increment the pointer to fetch a new byte during the next loop | |||
| reader.current_element++; | |||
| } | |||
| } | |||
| } | |||
| ``` | |||
| ## Other Examples | |||
| In split keyboards, it is very common to have two displays that each render different content and are oriented or flipped differently. You can do this by switching which content to render by using the return value from `is_keyboard_master()` or `is_keyboard_left()` found in `split_util.h`, e.g: | |||
| ```c | |||
| #ifdef ST7565_ENABLE | |||
| display_rotation_t st7565_init_user(display_rotation_t rotation) { | |||
| if (!is_keyboard_master()) { | |||
| return DISPLAY_ROTATION_180; // flips the display 180 degrees if offhand | |||
| } | |||
| return rotation; | |||
| } | |||
| void st7565_task_user(void) { | |||
| if (is_keyboard_master()) { | |||
| render_status(); // Renders the current keyboard state (layer, lock, caps, scroll, etc) | |||
| } else { | |||
| render_logo(); // Renders a static logo | |||
| } | |||
| } | |||
| #endif | |||
| ``` | |||
| ## Basic Configuration | |||
| |Define |Default |Description | | |||
| |------------------------|--------------|-----------------------------------------------------------------------------------------------------| | |||
| |`ST7565_A0_PIN` |*Not defined* |(Required) The GPIO connected to the display's A0 (data/command) pin | | |||
| |`ST7565_RST_PIN` |*Not defined* |(Required) The GPIO connected to the display's reset pin | | |||
| |`ST7565_SS_PIN` |*Not defined* |(Required) The GPIO connected to the display's slave select pin | | |||
| |`ST7565_SPI_CLK_DIVISOR`|`4` |The SPI clock divisor to use | | |||
| |`ST7565_FONT_H` |`"glcdfont.c"`|The font code file to use for custom fonts | | |||
| |`ST7565_FONT_START` |`0` |The starting character index for custom fonts | | |||
| |`ST7565_FONT_END` |`223` |The ending character index for custom fonts | | |||
| |`ST7565_FONT_WIDTH` |`6` |The font width | | |||
| |`ST7565_FONT_HEIGHT` |`8` |The font height (untested) | | |||
| |`ST7565_TIMEOUT` |`60000` |Turns off the screen after 60000ms of keyboard inactivity. Helps reduce burn-in. Set to 0 to disable.| | |||
| |`ST7565_COLUMN_OFFSET` |`0` |Shift output to the right this many pixels. | | |||
| |`ST7565_CONTRAST` |`32` |The default contrast level of the display, from 0 to 255. | | |||
| |`ST7565_UPDATE_INTERVAL`|`0` |Set the time interval for updating the display in ms. This will improve the matrix scan rate. | | |||
| ## Custom sized displays | |||
| The default display size for this feature is 128x32 and all necessary defines are precalculated with that in mind. | |||
| |Define |Default |Description | | |||
| |-----------------------|----------|-----------------------------------------------------------------------------------------------------------| | |||
| |`ST7565_DISPLAY_WIDTH` |`128` |The width of the display. | | |||
| |`ST7565_DISPLAY_HEIGHT`|`32` |The height of the display. | | |||
| |`ST7565_MATRIX_SIZE` |`512` |The local buffer size to allocate.<br>`(ST7565_DISPLAY_HEIGHT / 8 * ST7565_DISPLAY_WIDTH)`. | | |||
| |`ST7565_BLOCK_TYPE` |`uint16_t`|The unsigned integer type to use for dirty rendering. | | |||
| |`ST7565_BLOCK_COUNT` |`16` |The number of blocks the display is divided into for dirty rendering.<br>`(sizeof(ST7565_BLOCK_TYPE) * 8)`.| | |||
| |`ST7565_BLOCK_SIZE` |`32` |The size of each block for dirty rendering<br>`(ST7565_MATRIX_SIZE / ST7565_BLOCK_COUNT)`. | | |||
| ## API | |||
| ```c | |||
| // Rotation enum values are flags | |||
| typedef enum { | |||
| DISPLAY_ROTATION_0, | |||
| DISPLAY_ROTATION_180 | |||
| } display_rotation_t; | |||
| // Initialize the display, rotating the rendered output based on the define passed in. | |||
| // Returns true if the was initialized successfully | |||
| bool st7565_init(display_rotation_t rotation); | |||
| // Called at the start of st7565_init, weak function overridable by the user | |||
| // rotation - the value passed into st7565_init | |||
| // Return new display_rotation_t if you want to override default rotation | |||
| display_rotation_t st7565_init_user(display_rotation_t rotation); | |||
| // Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering | |||
| void st7565_clear(void); | |||
| // Renders the dirty chunks of the buffer to display | |||
| void st7565_render(void); | |||
| // Moves cursor to character position indicated by column and line, wraps if out of bounds | |||
| // Max column denoted by 'st7565_max_chars()' and max lines by 'st7565_max_lines()' functions | |||
| void st7565_set_cursor(uint8_t col, uint8_t line); | |||
| // Advances the cursor to the next page, writing ' ' if true | |||
| // Wraps to the begining when out of bounds | |||
| void st7565_advance_page(bool clearPageRemainder); | |||
| // Moves the cursor forward 1 character length | |||
| // Advance page if there is not enough room for the next character | |||
| // Wraps to the begining when out of bounds | |||
| void st7565_advance_char(void); | |||
| // Writes a single character to the buffer at current cursor position | |||
| // Advances the cursor while writing, inverts the pixels if true | |||
| // Main handler that writes character data to the display buffer | |||
| void st7565_write_char(const char data, bool invert); | |||
| // Writes a string to the buffer at current cursor position | |||
| // Advances the cursor while writing, inverts the pixels if true | |||
| void st7565_write(const char *data, bool invert); | |||
| // Writes a string to the buffer at current cursor position | |||
| // Advances the cursor while writing, inverts the pixels if true | |||
| // Advances the cursor to the next page, wiring ' ' to the remainder of the current page | |||
| void st7565_write_ln(const char *data, bool invert); | |||
| // Pans the buffer to the right (or left by passing true) by moving contents of the buffer | |||
| // Useful for moving the screen in preparation for new drawing | |||
| void st7565_pan(bool left); | |||
| // Returns a pointer to the requested start index in the buffer plus remaining | |||
| // buffer length as struct | |||
| display_buffer_reader_t st7565_read_raw(uint16_t start_index); | |||
| // Writes a string to the buffer at current cursor position | |||
| void st7565_write_raw(const char *data, uint16_t size); | |||
| // Writes a single byte into the buffer at the specified index | |||
| void st7565_write_raw_byte(const char data, uint16_t index); | |||
| // Sets a specific pixel on or off | |||
| // Coordinates start at top-left and go right and down for positive x and y | |||
| void st7565_write_pixel(uint8_t x, uint8_t y, bool on); | |||
| // Writes a PROGMEM string to the buffer at current cursor position | |||
| // Advances the cursor while writing, inverts the pixels if true | |||
| // Remapped to call 'void st7565_write(const char *data, bool invert);' on ARM | |||
| void st7565_write_P(const char *data, bool invert); | |||
| // Writes a PROGMEM string to the buffer at current cursor position | |||
| // Advances the cursor while writing, inverts the pixels if true | |||
| // Advances the cursor to the next page, wiring ' ' to the remainder of the current page | |||
| // Remapped to call 'void st7565_write_ln(const char *data, bool invert);' on ARM | |||
| void st7565_write_ln_P(const char *data, bool invert); | |||
| // Writes a PROGMEM string to the buffer at current cursor position | |||
| void st7565_write_raw_P(const char *data, uint16_t size); | |||
| // Can be used to manually turn on the screen if it is off | |||
| // Returns true if the screen was on or turns on | |||
| bool st7565_on(void); | |||
| // Called when st7565_on() turns on the screen, weak function overridable by the user | |||
| // Not called if the screen is already on | |||
| void st7565_on_user(void); | |||
| // Can be used to manually turn off the screen if it is on | |||
| // Returns true if the screen was off or turns off | |||
| bool st7565_off(void); | |||
| // Called when st7565_off() turns off the screen, weak function overridable by the user | |||
| // Not called if the screen is already off | |||
| void st7565_off_user(void); | |||
| // Returns true if the screen is currently on, false if it is | |||
| // not | |||
| bool st7565_is_on(void); | |||
| // Basically it's st7565_render, but with timeout management and st7565_task_user calling! | |||
| void st7565_task(void); | |||
| // Called at the start of st7565_task, weak function overridable by the user | |||
| void st7565_task_user(void); | |||
| // Inverts the display | |||
| // Returns true if the screen was or is inverted | |||
| bool st7565_invert(bool invert); | |||
| // Returns the maximum number of characters that will fit on a line | |||
| uint8_t st7565_max_chars(void); | |||
| // Returns the maximum number of lines that will fit on the display | |||
| uint8_t st7565_max_lines(void); | |||
| ``` | |||
+ 15
- 0
feature_stenography.md
View File
+ 1
- 1
feature_tap_dance.md
View File
+ 48
- 2
flashing.md
View File
+ 4
- 4
fr-fr/cli.md
View File
+ 20
- 18
hardware_avr.md
View File
+ 2
- 2
hardware_keyboard_guidelines.md
View File
+ 0
- 27
internals_pfleury_lcd.md
View File
| @ -1,27 +0,0 @@ | |||
| # group `pfleury_lcd` {#group__pfleury__lcd} | |||
| Basic routines for interfacing a HD44780U-based character LCD display. | |||
| ```cpp | |||
| #include <lcd.h> | |||
| ``` | |||
| LCD character displays can be found in many devices, like espresso machines, laser printers. The Hitachi HD44780 controller and its compatible controllers like Samsung KS0066U have become an industry standard for these types of displays. | |||
| This library allows easy interfacing with a HD44780 compatible display and can be operated in memory mapped mode (LCD_IO_MODE defined as 0 in the include file lcd.h.) or in 4-bit IO port mode (LCD_IO_MODE defined as 1). 8-bit IO port mode is not supported. | |||
| Memory mapped mode is compatible with old Kanda STK200 starter kit, but also supports generation of R/W signal through A8 address line. | |||
| **See also**: The chapter [Interfacing a HD44780 Based LCD to an AVR]( http://homepage.hispeed.ch/peterfleury/avr-lcd44780.html) on my home page, which shows example circuits how to connect an LCD to an AVR controller. | |||
| Peter Fleury [pfleury@gmx.ch](mailto:pfleury@gmx.ch)[http://tinyurl.com/peterfleury](http://tinyurl.com/peterfleury) | |||
| 2.0 | |||
| (C) 2015 Peter Fleury, GNU General Public License Version 3 | |||
| ## Summary | |||
| Members | Descriptions | |||
| --------------------------------|--------------------------------------------- | |||
+ 7
- 7
internals_udi_hid_group.md
View File
| @ -1,27 +1,27 @@ | |||
| # group `udi_hid_group` {#group__udi__hid__group} | |||
| Common library for all Human Interface Device ([HID](.build/docs/internals_undefined.md#class_h_i_d)) implementation. | |||
| Common library for all Human Interface Device (HID) implementation. | |||
| ## Summary | |||
| Members | Descriptions | |||
| --------------------------------|--------------------------------------------- | |||
| `public bool `[`udi_hid_setup`](#group__udi__hid__group_1ga9594c21fbb713dabebed1c970664680b)`(uint8_t * rate,uint8_t * protocol,uint8_t * report_desc,bool(*)(void) setup_report)` | Decode [HID](.build/docs/internals_undefined.md#class_h_i_d) setup request. | |||
| `public bool `[`udi_hid_setup`](#group__udi__hid__group_1ga9594c21fbb713dabebed1c970664680b)`(uint8_t * rate,uint8_t * protocol,uint8_t * report_desc,bool(*)(void) setup_report)` | Decode HID setup request. | |||
| ## Members | |||
| #### `public bool `[`udi_hid_setup`](#group__udi__hid__group_1ga9594c21fbb713dabebed1c970664680b)`(uint8_t * rate,uint8_t * protocol,uint8_t * report_desc,bool(*)(void) setup_report)` {#group__udi__hid__group_1ga9594c21fbb713dabebed1c970664680b} | |||
| Decode [HID](.build/docs/internals_undefined.md#class_h_i_d) setup request. | |||
| Decode HID setup request. | |||
| #### Parameters | |||
| * `rate` Pointer on rate of current [HID](.build/docs/internals_undefined.md#class_h_i_d) interface | |||
| * `rate` Pointer on rate of current HID interface | |||
| * `protocol` Pointer on protocol of current [HID](.build/docs/internals_undefined.md#class_h_i_d) interface | |||
| * `protocol` Pointer on protocol of current HID interface | |||
| * `report_desc` Pointer on report descriptor of current [HID](.build/docs/internals_undefined.md#class_h_i_d) interface | |||
| * `report_desc` Pointer on report descriptor of current HID interface | |||
| * `set_report` Pointer on set_report callback of current [HID](.build/docs/internals_undefined.md#class_h_i_d) interface | |||
| * `set_report` Pointer on set_report callback of current HID interface | |||
| #### Returns | |||
| `1` if function was successfully done, otherwise `0`. | |||
+ 6
- 6
internals_udi_hid_group_internal.md
View File
+ 1
- 1
internals_udi_hid_keyboard_group_single_desc.md
View File
+ 1
- 1
internals_usb_device_group.md
View File
+ 15
- 15
internals_usb_hid_protocol.md
View File
+ 7
- 7
ja/cli_commands.md
View File
+ 2
- 2
ja/cli_development.md
View File
+ 3
- 0
ja/compatible_microcontrollers.md
View File
+ 1
- 1
ja/feature_bootmagic.md
View File
+ 0
- 17
ja/feature_debounce_type.md
View File
+ 12
- 6
ja/feature_dip_switch.md
View File
+ 7
- 3
ja/feature_encoders.md
View File
+ 2
- 2
ja/feature_led_matrix.md
View File
+ 1
- 1
ja/feature_tap_dance.md
View File
+ 20
- 18
ja/hardware_avr.md
View File
+ 0
- 2
ja/reference_configurator_support.md
View File
+ 0
- 4
ja/reference_info_json.md
View File
+ 36
- 36
keycodes.md
View File
+ 36
- 0
keycodes_magic.md
View File
| @ -0,0 +1,36 @@ | |||
| # Magic Keycodes :id=magic-keycodes | |||
| **Magic Keycodes** are prefixed with `MAGIC_`, and allow you to access the functionality of the deprecated Bootmagic feature *after* your keyboard has initialized. To use the keycodes, assign them to your keymap as you would any other keycode. | |||
| |Key |Aliases |Description | | |||
| |----------------------------------|---------|--------------------------------------------------------------------------| | |||
| |`MAGIC_SWAP_CONTROL_CAPSLOCK` |`CL_SWAP`|Swap Caps Lock and Left Control | | |||
| |`MAGIC_UNSWAP_CONTROL_CAPSLOCK` |`CL_NORM`|Unswap Caps Lock and Left Control | | |||
| |`MAGIC_CAPSLOCK_TO_CONTROL` |`CL_CTRL`|Treat Caps Lock as Control | | |||
| |`MAGIC_UNCAPSLOCK_TO_CONTROL` |`CL_CAPS`|Stop treating Caps Lock as Control | | |||
| |`MAGIC_SWAP_LCTL_LGUI` |`LCG_SWP`|Swap Left Control and GUI | | |||
| |`MAGIC_UNSWAP_LCTL_LGUI` |`LCG_NRM`|Unswap Left Control and GUI | | |||
| |`MAGIC_SWAP_RCTL_RGUI` |`RCG_SWP`|Swap Right Control and GUI | | |||
| |`MAGIC_UNSWAP_RCTL_RGUI` |`RCG_NRM`|Unswap Right Control and GUI | | |||
| |`MAGIC_SWAP_CTL_GUI` |`CG_SWAP`|Swap Control and GUI on both sides | | |||
| |`MAGIC_UNSWAP_CTL_GUI` |`CG_NORM`|Unswap Control and GUI on both sides | | |||
| |`MAGIC_TOGGLE_CTL_GUI` |`CG_TOGG`|Toggle Control and GUI swap on both sides | | |||
| |`MAGIC_SWAP_LALT_LGUI` |`LAG_SWP`|Swap Left Alt and GUI | | |||
| |`MAGIC_UNSWAP_LALT_LGUI` |`LAG_NRM`|Unswap Left Alt and GUI | | |||
| |`MAGIC_SWAP_RALT_RGUI` |`RAG_SWP`|Swap Right Alt and GUI | | |||
| |`MAGIC_UNSWAP_RALT_RGUI` |`RAG_NRM`|Unswap Right Alt and GUI | | |||
| |`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides | | |||
| |`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Alt and GUI on both sides | | |||
| |`MAGIC_TOGGLE_ALT_GUI` |`AG_TOGG`|Toggle Alt and GUI swap on both sides | | |||
| |`MAGIC_NO_GUI` |`GUI_OFF`|Disable the GUI keys | | |||
| |`MAGIC_UNNO_GUI` |`GUI_ON` |Enable the GUI keys | | |||
| |`MAGIC_TOGGLE_GUI` |`GUI_TOG`|Toggles the status of the GUI keys | | |||
| |`MAGIC_SWAP_GRAVE_ESC` |`GE_SWAP`|Swap <code>`</code> and Escape | | |||
| |`MAGIC_UNSWAP_GRAVE_ESC` |`GE_NORM`|Unswap <code>`</code> and Escape | | |||
| |`MAGIC_SWAP_BACKSLASH_BACKSPACE` |`BS_SWAP`|Swap `\` and Backspace | | |||
| |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|`BS_NORM`|Unswap `\` and Backspace | | |||
| |`MAGIC_HOST_NKRO` |`NK_ON` |Enable N-key rollover | | |||
| |`MAGIC_UNHOST_NKRO` |`NK_OFF` |Disable N-key rollover | | |||
| |`MAGIC_TOGGLE_NKRO` |`NK_TOGG`|Toggle N-key rollover | | |||
| |`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | | |||
| |`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| | |||