* Basic keymap parsing finally works
* Add 'keymap.json' creation to the qmk.keymap module
* Add tests and fix formatting
* Fix/exclude flake8 errors
* Convert keymap.c to valid keymap.json
* Fix some errors
* Add tests
* Finalize keymap.json creation, add json template
* Add docs
* Move pygments to the standard requirements
* Add support for nameless layers, fix tests
* Fix things after rebase
* Add missing 'keymap' value.
* Fix missing layer numbers from advanced keycodes
Buckwich noticed that if the advanced keycode / layer toggling key
contains a number, it goes missing.
Now we properly handle them.
Thx for noticing!
* Apply suggestions from code review
* fixup tests
Co-authored-by: Zach White <skullydazed@drpepper.org>
Co-authored-by: skullY <skullydazed@gmail.com>
* Improve LAYOUT macro searching
* Apply suggestions from code review
Co-authored-by: Zach White <skullydazed@users.noreply.github.com>
* Adjust signature
* Try to copy the makefile's handling of DEFAULT_FOLDER
* Move it further up, into `info_json()`
* Move it even further up so that keyboard_folder is correct
* Update lib/python/qmk/info.py
Co-authored-by: Zach White <skullydazed@drpepper.org>
* Update lib/python/qmk/info.py
Co-authored-by: Zach White <skullydazed@drpepper.org>
Co-authored-by: Zach White <skullydazed@users.noreply.github.com>
Co-authored-by: Zach White <skullydazed@drpepper.org>
* Move my custom functions and keymaps to userspace to be able to add the STM32F411 variant of my keyboard with mostly the same functionality
* Move keymaps to community layouts
* Remove keymaps from userspace readme.md
Co-authored-by: Janos Daniel Reibl <janos.daniel.reibl@protonmail.com>
* add support for ymd75 rev3
* Update keyboards/ymd75/rev3/rules.mk
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/ymd75/rev3/rules.mk
Co-authored-by: Ryan <fauxpark@gmail.com>
* remove DESCRIPTION
* only apply offset for rev3
Co-authored-by: Ryan <fauxpark@gmail.com>
* Created folder structure and blank files
* Update the yugo_m initial blank files
* Add yugo_m default keymap
* Update yugo_m info.json
* Fix yugo_m keymap.c
* keymap.c update
* Changed subfolder name
* File names
* Fixed lock LEDs problem
* Returned old subfolder name; LEDs fix
* Activated anti-ghosting feature in config.h
* Update readme.md
* Changed LAYOUT to LAYOUT_all
* Updated keymap.c
* corrected LAYOUT to LAYOUT_all in info.json
* Rewritten readme.md according to the template
* Removed backslashes from keymap.c
* Fixed readme.md
* Fixed readme.md again
* Tidying up readme.md
* Tidying up comments and readme.md
* Removed a line from rules.mk
* Update keyboards/yugo_m/model_m_101/model_m_101.h
Co-authored-by: Joel Challis <git@zvecr.com>
* Removed chconf, halconf, mcuconf
* Updated LED control
* Update keyboards/yugo_m/model_m_101/rules.mk
Co-authored-by: Joel Challis <git@zvecr.com>
* Update keyboards/yugo_m/model_m_101/config.h
Co-authored-by: Joel Challis <git@zvecr.com>
* Update keyboards/yugo_m/model_m_101/config.h
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* Update keyboards/yugo_m/model_m_101/config.h
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* Update keyboards/yugo_m/model_m_101/model_m_101.c
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* Update keyboards/yugo_m/readme.md
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* Updated readme.md, there was an outdated info
* Update keyboards/yugo_m/model_m_101/keymaps/default/keymap.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/yugo_m/model_m_101/keymaps/default/keymap.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/yugo_m/model_m_101/model_m_101.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/yugo_m/model_m_101/model_m_101.c
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Nidzo Tomic <tomicn8@hotmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* First pass at manuform layout.
* Updates from actual usage on my board. Fixed a couple of bugs, added a stormlight quote randomizer.
* Use a 32-bit timer that can actually hit 5 minutes.
* Some updates after a day of usage:
* Turn off WPM. It's too inaccurate and takes up a decent amount of space that can be devoted to quotes.
* Turn off the OLEDs after 5 minutes
* Move the keys around a bit.
* Add many more quotes.
* Adjust the quotes to make room for missing and misswritten WoT quote. Adjusted the keymap slightly. Adjust the mods display to include one_shots.
* Revert osm on lgui as it makes start menu search impossible to use.
* Use LTO_ENABLE flag.
* License all of my (333fred's) keymaps as MIT.
* Update users/333fred/rgb.c
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* Fix dirtying in oled_write_pixel()
Set the dirty bit for the block only if oled_write_pixel() actually
changed the buffer state. Without this check oled_write_pixel() could
not be used inside the oled_task_user() code using the “redraw always”
style, because the blocks touched by oled_write_pixel() would always
appear dirty, and oled_render() would not proceed beyond the first such
dirty block.
* Fix oled_write_pixel() with 90/270 degree rotation
Use oled_rotation_width instead of OLED_DISPLAY_WIDTH, so that a rotated
display would be handled correctly.
* Fix compilation with custom OLED_BLOCK_COUNT and OLED_BLOCK_SIZE
Some OLED sizes (e.g., 64×48) may require a nonstandard value of
OLED_BLOCK_COUNT. The documentation says that this value may be
redefined in config.h, but actually trying to redefine it caused a
compile error, because the macro was redefined in oled_driver.c.
Make the OLED_BLOCK_COUNT definition in oled_driver.c respect any
user override, and do the same for OLED_BLOCK_SIZE just in case.
* Fix handling of out-of-range bits in oled_dirty
If a custom OLED_BLOCK_COUNT value is specified, some bits in oled_dirty
may not correspond to existing blocks; however, if those bits are set
somewhere (e.g., by code with sets oled_dirty to ~0 or even -1),
oled_render() would try to handle them and could access memory beyond
oled_buffer and perform hardware operations with out of range values.
Prevent this by masking off unused bits in oled_render(), and also avoid
setting those bits in other functions.
* Fix potentially wrong dirtying in oled_write_char()
oled_write_char() tried to mark the position just beyond the written
character as dirty; use (OLED_FONT_WIDTH - 1) to dirty the last position
still belonging to the character instead.
* Fix `#define OLED_BLOCK_TYPE uint32_t` on AVR
Using uint32_t as OLED_BLOCK_TYPE did not work properly on AVR, because
some bit shifts were performed using 16-bit int. Add explicit casts to
OLED_BLOCK_TYPE to those shifts.
* Fix issue with data transfer of CS1_SW7 to CS18_SW7.
* Fix issue with handling of scaling register buffer's dirty flag.
* Remove unused extern declaration.
* Compaction of struct is31_led utilizing bit fields.
* Update reference_info_json.md
key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array.
* Updated Japanese documentation as well
* Initializing Boardwalk layout
* rules.mk newline
* config.h newline
* qwerty num toggle -> tap-toggle
* errant K, and _LOWER momentary toggles
* Lack of autosave sucks
* Converting to HHKB layout
* TT(_NUM) added to num layer
* Final updates for Boardwalk initialization
* Final refinements
* newline
* Removal of extra includes
* Update keyboards/boardwalk/keymaps/niclake/config.h
#pragma once
* Removing comment block from rules
* Updates to my layout
* WIP working on new keymap
* tweaking keymap
* updated keymap
* cleaned up a little bit
* New preonic keymap
* my preonic keymap
* added mac layout
* preonic map update
* cleaning up old repo
* cleaning up to match upstream
* more cleanup
* removing old keymaps
* Added BM60 Poker
* Apply suggestions from code review
* Added license
* updated license
* updated license
* Fixed remaining licenses and added layout to rules
* BM60RGB ISO: fix and extend default keymap
- correctly assigns the Non-US Backslash and Hash keys
- adds Function and Navigation keys
- use KC_GESC instead of KC_ESC to make Grave accent available
* Update layout macro
The layout is the ISO equivalent of QMK's `LAYOUT_60_ansi_arrow`.
* Add via configurator support
* Remove layers to fix via
* Re-add extra via layers since it seems to work now
* Replace tabs with spaces
* Update readme.md
* first pass at fixing the key labeling
* second pass of fixing key labeling
* third pass of this key naming
* another pass of changing key naming
* another pass
* another pass
* another pass
* renamed it all
* give a good vid and pid
* add via keymap
* add on to the comments
* update readme and comments
* one more small change
* Convert ErgoDox EZ to lite matrix
* Add initial config from Dactyl config
Based on ErinCall's work to generalize the mcp i/o expander matrix code
* formatting
* Fix number of pins
* Remove unused defines
* fixed keymap placement
- online configurator keys were in the wrong location and needed to be fixed
- fixed a key being to high on the y position
* Create rules.mk
* Create keymap.c
* Update rules.mk
added VIA support
* Changed wazowski via keymap to include skipped switch
* changed the vendor ID
* Update keyboards/keebzdotnet/wazowski/config.h
* Removed VIA enable from keyboard rules.mk
* Update keyboards/keebzdotnet/wazowski/rules.mk
* Fixed wazowski via keymap build errors
* Added multi-layer support for Wazowski via keymap
* Initial Commit for Ploopyco Trackball
This is a WIP at this point. Most of it compiles, but the SPI commands are non-functioning as they come from Arduino, so don't exist in LUFA
* Convert SPI commands from arduino to LUFA
But I have no idea if this is actually correct or not
* Update keyboard readme
* Clean up ploopyco trackball
* Update readme
* Update mouse key stuff
* last minutue cleanup
* Add caveat about scroll wheel
* Fixup to code
* Additional fixup
* Add movement multiplier
* Rename folders
* mid changes
* temp
* Got it working!!!!!
* Additional cleanup of code
* Make unused pin calls more compact
* Rotation info
* Add debouncing checks
* Make everything replaceable
* Add info.json
* Include ISP flashing info
* Better handling for user customization
* Reconfigure CPI stuff
* fix issues with debug printing
* Fix tiny scroll issue
* Add and update scroll code from ploopy mouse
* Update licensing
* Add PloopyCo Mouse
* Cleanup and layout stuff
* Move common files to main folder for reuse
* Increase polling rate
* Update image for mouse
* Apply changes from code review
* Add VIA support
* Consolidate udev rules into a single file
* Update rules in doctor.py
* Simplify doctor rule checking
* Fix errors
* Add TMK "FEED" VID to list of deprecated udev rules
* A comma would be nice
* Split rules back up into bootloaders
* Link to docs page in "missing" case
* Add Pololu VID
* Be more specific about Caterina devices, and add LilyPad PID
* Wording & formatting changes in Tapping Force Hold
The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".
* Removed all trailing whitespaces from tap hold doc
* "it's simply really:" → "it's simple really:"
* "This allows to keep the ability" → "This allows keeping the ability"
Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
* edit vid and pid
* add VIA keymap
* add my name to the readme
* Update keyboards/gray_studio/hb85/keymaps/via/config.h
* we have a third endpoint, no need to disable mousekeys
* Update keyboards/gray_studio/hb85/keymaps/via/keymap.c
* add license header
* Create keymap.c
* Add files via upload
* Added files for handwired 3d printed clueboard 660
* create via layout files
* added layout files for via
* updated product ID to fix id conflicts
* change product ID to fix ID conflicts.
* fixed capitalization error that was causing issues
* fixed capitalization issues.
* fix syntax errors
* Fixed syntax errors (stray punctuation)
* Compatibility fixes
* Compatibility fixes
* Compatibility fixes
* Compatibility fixes
* capitalization fixes
* Compatibility fixes
* Compatibility fixes
* Compatibility Fixes
* Compatibility fixes
* Compatibility fixes
* Compatibility changes
* upkeep, fixing typos
* Update keyboards/handwired/3dp660/config.h
Removed Description line
* Update keyboards/handwired/3dp660/rules.mk
correct bootloader
* Update keyboards/handwired/3dp660/3dp660.h
fix case sensitive typos
* Update keyboards/handwired/3dp660/keymaps/default/keymap.c
change tab indentation to space indentations.
* Update keyboards/handwired/3dp660/keymaps/via/keymap.c
change tab indentations to space indentations
* Delete 3dp660.json
This file was for VIA, and shouldn't be in this repo. I placed it here so I wouldn't misplace it in my filesystem. My apologies.
* Update info.json
change suggestions to other file said to lowercase "ansi", caused reference issues, changed all instances of "ANSI" to "ansi".
* Update keymap.c
change suggestions to other file said to lowercase "ansi", caused reference issues, changed all instances of "ANSI" to "ansi".
* Update keymap.c
more capitalization fixes
* Update keyboards/handwired/3dp660/readme.md
shortened imgur url
* Update keyboards/handwired/3dp660/rules.mk
remove extraneous comments
* Delete config.h
* Update keyboards/handwired/3dp660/rules.mk
* Update 3dp660.c
add license headers to all .c and .h files
* Update 3dp660.h
added license header to all .c and .h files.
* Update keymap.c
added license header to all .c and .h files.
* Update keymap.c
added license header to all .c and .h files.
* Update keyboards/handwired/3dp660/readme.md
Add maintainer URL
* Update keyboards/handwired/3dp660/keymaps/default/keymap.c
remove extraneous default keymap layers
* Update keyboards/handwired/3dp660/keymaps/default/rules.mk
* Update rules.mk
Moved LTO to keyboard level.
* Update rules.mk
Moved LTO to keyboard level.
* Delete rules.mk
Made obsolete by LTO move to keyboard level.
* Update keyboards/handwired/3dp660/rules.mk
capitalization errors.
* Apply suggestions from code review
Housekeeping, changing code for readability.
Adding my kbd67mkii keymap and some changes to kumo
Keymaps for kbdfans/kbd67/mkii_soldered and thevankeyboards/minivan
* Changes to minivan layout
* KBD67 keymap
* commiting my files
* add understanding_qmk.md translation
* update based on comment
* update based on comment
* update based on comment
* update based on comment
* update based on comment
* Squashing commits - adding preonic keymap
This adds a custom keymap, including numpad layer, emoji, and kamoji
key mappings.
* Removing unnecessary trailing backslash characters
* removing the unnecessary json keymap
* removing unnecessary trailing slashes from the default keymap
* switching to tap_code
* Apply suggestions from code review
This should enable a toggleable numpad
* adding license
* Stripping out FN keycodes in favor of a momentary layer
Fix configs to make the `handwired/onekey/blackpill_f401:backlight` and
`handwired/onekey/blackpill_f411:backlight` examples actually compile
and work:
- Use `PWMD5` instead of `PWMD2` for backlight, which matches the
default value of `BACKLIGHT_PAL_MODE` (AF02 for pin A0 is `TIM5_CH1`)
and does not conflict with the default value of `STM32_ST_USE_TIMER`.
- Enable `HAL_USE_PWM` in halconf.h and `STM32_PWM_USE_TIM5` in
mcuconf.h, so that `PWMD5` could be used.
* add miniMACRO5
add all nessecary files for the miniMACRO5
I have rewritten the readme, and changed the keymaps to be more simple. I have tested compiling, and everything works perfectly.
* update miniMACRO5 readme
add the make example into the readme file
* Update keyboards/minimacro5/config.h
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/minimacro5/keymaps/default/keymap.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/minimacro5/keymaps/media/keymap.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/minimacro5/keymaps/media/keymap.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/minimacro5/minimacro5.c
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/minimacro5/info.json
Co-authored-by: Ryan <fauxpark@gmail.com>
* Apply suggestions from code review
applied all suggestions.
Co-authored-by: Ryan <fauxpark@gmail.com>
* drashna suggestions - enum rather than define
committed enum update by drashna
Co-authored-by: Drashna Jaelre <drashna@live.com>
* update keymap.c
incorrect brackets
Co-authored-by: dezli <m@dez.li>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Adding preonic layout
* deleting unnecessary files
* Fixing spacing
* I need to not commit things while I'm not sober
* Update keyboards/preonic/keymaps/codecoffeecode/keymap.c
* Update keyboards/preonic/keymaps/codecoffeecode/keymap.c
* Update keyboards/preonic/keymaps/codecoffeecode/keymap.c
* Adding license header
The default keymaps don't make use of the global `keymap_config`
variable nor the `matrix_*_user()` functions. Therefore, remove them to
avoid confusion for future keymap authors.
* update "Hardware Availability"
* add a section of "How to build"
* update "Hardware Supported"
* add VIA keymaps
* add 2 layers to VIA keymaps
Co-authored-by: keyaki-namiki <28521374+keyaki-namiki@users.noreply.github.com>
* Add information to docs
- If layer z is not a higher layer than both x and y, the layer change code
does not function correctly.
* Update docs/ref_functions.md
* Update docs/ref_functions.md
* Update docs/ref_functions.md
There is no way to invoke the command feature while having just a single
physical key, and disabling that feature fixes build for keymaps like
`handwired/onekey/promicro:rgb` without resorting to LTO (the command
feature consumes more than 4900 bytes with avr-gcc 8.4.0).
* KBD67 MkII Soldered: Fix ISO blocker layout
Matrix data was wrong; KC_NUHS key did not work.
* KBD67 MkII Soldered: Add ISO blocker with Split Backspace layout
* Update config.h
adding vendor and product info so VIA will recognize it.
* Update keyboards/kingly_keys/romac_plus/config.h
thank you for this. commiting suggestion.
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* 6.25U bottom row ISO layout for Matrix Noah
* Personal map for Matrix Noah using new 6.25U bottom row ISO
* Switch to 65_iso_blocker and add that to info.json
* Switch to 65_iso_blocker for the new layout
* Fix whitespace issues
* Output an error message if LINK_TIME_OPTIMIZATION_ENABLE is set but LTO_ENABLE is not.
* Update common.mk
Specify that LINK_TIME_OPTIMZATION_ENABLE has been renamed, not deprecated.
* initial keymap commit
* Keymap for coppertop commit
* removed define for layers/kc_no/kc_trns
* Modified keymap to remove definitions and add layer enum
* initial keymap commit
* Keymap for coppertop commit
* removed define for layers/kc_no/kc_trns
* Modified keymap to remove definitions and add layer enum
* Changed KC_NO and KC_TRNS to 7X and 7_
* Fixed spacing on keymaps
* TMO50: use layer_state_set_kb at keyboard level (#10150)
* Change TMO to use layer_state_set_kb as is customary at the keyboard level.
This also factors out `process_indicator_led` to a separate method.
* [Keymap] update dz60:mrsendyyk (#10160)
Update DZ60 Personal readme.md and keymap.c
* Update readme.md
* Update keymap.c
* Update keymap.c
* Update readme.md
* Update readme.md
* Update readme.md
* Update keymap.c
* Update readme.md
* Update
* Update readme.md
* Update keymap.c
* Update readme.md
* [Keyboard] YMDK NP21 refactor (#10181)
* [Keyboard] 1upkeyboards/1up60rgb: fix broken Enter (#10188)
The recent change to unnest macros put the enter on the wrong matrix key. On the 1uprgb, the ANSI and ISO enters share the same cell as does the ANSI and ISO backslash.
* no idea what this is
* Update keyboards/dz60/keymaps/coppertop/keymap.c
* Update keyboards/dz60/keymaps/coppertop/keymap.c
* Update keyboards/dz60/keymaps/coppertop/keymap.c
* Update keyboards/dz60/keymaps/spotpuff/keymap.c
* Update keyboards/dz60/keymaps/spotpuff/keymap.c
* Update keyboards/dz60/keymaps/spotpuff/keymap.c
* Added Trns labels to keymap comments.
* Revert "no idea what this is"
This reverts commit dd950f9eb3.
* Reverted dd950f9eb3
* fix vusb submodule
* Update keyboards/dz60/keymaps/coppertop/rules.mk
* Update keyboards/dz60/keymaps/spotpuff/rules.mk
* Update users/spotpuff/rules.mk
* Added GNU copyright license text
* [Keyboard] Convert Corne Keyboard to Split Common
* Add VIA Support
* Makes sure that ol(e)d and new OLED implementation can't coexist
* Add licensing header to files
* Add changes based on feedback from foostan
* Fixes
* add via support for boardsource/5x12
* make product id for 5x12 unique (there is already an 0x0512) by setting it to 0x5012
* un-swap the readme's for 3x4 and 5x12
* Update keyboards/boardsource/5x12/config.h
update vendor id
* Update keyboards/boardsource/5x12/keymaps/via/keymap.c
use correct number of layers for VIA
* update product id to use same pattern as others
* Update keyboards/boardsource/5x12/keymaps/via/readme.md
* Update keyboards/boardsource/5x12/keymaps/via/readme.md
* setup keyboard
* fit v1 board setting
* remove unused def and add ergodox_pretty
* add user hooks
* add ergodox_pretty to info
* apply suggestions
* use default split usb timeout
* added via keymap
* replaced PRODUCT_ID 0x1157 with PRODUCT_ID 0x2157
replaced product id to distinguish rev2 from rev1.
bakingpy gave me permission through discord chat.
* Update keyboards/keebio/viterbi/keymaps/via/keymap.c
* Update keyboards/keebio/viterbi/keymaps/via/rules.mk
* made a simplier keymap.c for via folder
Based from the default keymap, removed unnecessary codes.
* Add via keymap for Plaid-Pad
- Add VIA support for the Plaid-Pad
- Changes Vendor ID and Product ID (to follow VIA's guidelines)
* Add extra encoder pads for rev1.1
* Change Product Id from pp to PP (hex value)
* improved readme
- detailed informations about rotary encoder, bootloader and firmware
* Improved encoder informations in via keymap
* Improved encoder infos and code in default keymap
* add revision folder for rev1 and rev1.1
* change encoder assignment for defaul a via keymap
* Update keyboards/keycapsss/plaid_pad/config.h
* change revision number
* Update keyboards/keycapsss/plaid_pad/rules.mk
* Update keyboards/keycapsss/plaid_pad/rules.mk
* Update keyboards/keycapsss/plaid_pad/rules.mk
* Update keyboards/keycapsss/plaid_pad/rules.mk
* Update keyboards/keycapsss/plaid_pad/readme.md
* add license to header of *.h and *.c files
* remove the list of alternate bootloaders
- due to the pr checklist
* Update keyboards/keycapsss/plaid_pad/rules.mk
* added SQUARE.X keyboard from the iNETT Studio
* split to two sub directories
* Apply suggestions from code review
* Update keyboards/inett_studio/sqx/universal/universal.h
* Apply suggestions from code review
* update the matrix control keycodes settings
* use the offical macro to the rgb matrix control
* fixed led position issue
* Apply suggestions from code review
* removed the redundant #endif
* update default keymap
* Apply suggestions from code review
* add license header
* Add VIA support for lazydesigners\bolt
Add VIA support for lazydesigners\bolt
* Update keyboards/lazydesigners/bolt/via/rules.mk
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* quantum/debounce: rename debouncing algorithms according to Issue 8763
This is the second attempt at implementation, with no ts_ and cy_ prefixes, since those will be implemented with macros.
* Debouncing documentation: Refactor, add some generic info, and merge into a single document
* chore: pulled the latest from master
Bring my redox layout from my latest redox branch
Bring my latest user stuff from my redox branch
* Update users/danielo515/config.h
Co-authored-by: Drashna Jaelre <drashna@live.com>
* chore: small cleanup
Co-authored-by: Drashna Jaelre <drashna@live.com>
* add reference_configurator_support.md translation
* update based on comment
* update based on comment
* update based on comment
* update based on comment
* fix link in docs/ja/feature_split_keyboard.md
* fix link in docs/ja/faq_build.md
* fix link in docs/ja/faq_general.md
* fix link in docs/ja/faq_keymap.md
* fix link in docs/ja/how_a_matrix_works.md
* fix link in docs/ja/reference_glossary.md
@ -13,65 +13,76 @@ An example of using `sudo`, when your controller is ATMega32u4:
or just:
$ sudo make <keyboard>:<keymap>:dfu
$ sudo make <keyboard>:<keymap>:flash
Note that running `make` with `sudo` is generally ***not*** a good idea, and you should use one of the former methods, if possible.
### Linux `udev` Rules
On Linux, you'll need proper privileges to access the MCU. You can either use
`sudo` when flashing firmware, or place these files in `/etc/udev/rules.d/`. Once added run the following:
```console
On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use `sudo` when flashing firmware, or place this file in `/etc/udev/rules.d/`:
These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
@ -26,7 +26,10 @@ A Bluefruit UART friend can be converted to an SPI friend, however this [require
<!-- FIXME: Document bluetooth support more completely. -->
## Bluetooth Rules.mk Options
Use only one of these
The currently supported Bluetooth chipsets do not support [N-Key Rollover (NKRO)](reference_glossary.md#n-key-rollover-nkro), so `rules.mk` must contain `NKRO_ENABLE = no`.
| Not defined | Use the default algorithm, currently sym_g | Nothing |
| Not defined | Use the default algorithm, currently sym_defer_g | Nothing |
| custom | Use your own debounce code | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions |
| anything_else | Use another algorithm from quantum/debounce/* | Nothing |
| Anything Else | Use another algorithm from quantum/debounce/* | Nothing |
**Regarding split keyboards**:
The debounce code is compatible with split keyboards.
# Use your own debouncing code
* Set ```DEBOUNCE_TYPE = custom```.
* Add ```SRC += debounce.c```
### Selecting an included debouncing method
Keyboards may select one of the already implemented debounce methods, by adding to ```rules.mk``` the following line:
```
DEBOUNCE_TYPE = <name of algorithm>
```
Where name of algorithm is one of:
* ```sym_defer_g``` - debouncing per keyboard. On any state change, a global timer is set. When ```DEBOUNCE``` milliseconds of no changes has occurred, all input changes are pushed.
* This is the current default algorithm. This is the highest performance algorithm with lowest memory usage, and it's also noise-resistant.
* ```sym_eager_pr``` - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE``` milliseconds of no further input for that row.
For use in keyboards where refreshing ```NUM_KEYS``` 8-bit counters is computationally expensive / low scan rate, and fingers usually only hit one row at a time. This could be
appropriate for the ErgoDox models; the matrix is rotated 90°, and hence its "rows" are really columns, and each finger only hits a single "row" at a time in normal use.
* ```sym_eager_pk``` - debouncing per key. On any state change, response is immediate, followed by ```DEBOUNCE``` milliseconds of no further input for that key
* ```sym_defer_pk``` - debouncing per key. On any state change, a per-key timer is set. When ```DEBOUNCE``` milliseconds of no changes have occurred on that key, the key status change is pushed.
### A couple algorithms that could be implemented in the future:
* ```sym_defer_pr```
* ```sym_eager_g```
* ```asym_eager_defer_pk```
### Use your own debouncing code
You have the option to implement you own debouncing algorithm. To do this:
* Set ```DEBOUNCE_TYPE = custom``` in ```rules.mk```.
* Add ```SRC += debounce.c``` in ```rules.mk```
* Add your own ```debounce.c```. Look at current implementations in ```quantum/debounce``` for examples.
* Debouncing occurs after every raw matrix scan.
* Use num_rows rather than MATRIX_ROWS, so that split keyboards are supported correctly.
* If the algorithm might be applicable to other keyboards, please consider adding it to ```quantum/debounce```
# Changing between included debouncing methods
You can either use your own code, by including your own debounce.c, or switch to another included one.
Included debounce methods are:
* eager_pr - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE``` milliseconds of no further input for that row.
For use in keyboards where refreshing ```NUM_KEYS``` 8-bit counters is computationally expensive / low scan rate, and fingers usually only hit one row at a time. This could be
appropriate for the ErgoDox models; the matrix is rotated 90°, and hence its "rows" are really columns, and each finger only hits a single "row" at a time in normal use.
* eager_pk - debouncing per key. On any state change, response is immediate, followed by ```DEBOUNCE``` milliseconds of no further input for that key
* sym_g - debouncing per keyboard. On any state change, a global timer is set. When ```DEBOUNCE``` milliseconds of no changes has occured, all input changes are pushed.
* sym_pk - debouncing per key. On any state change, a per-key timer is set. When ```DEBOUNCE``` milliseconds of no changes have occured on that key, the key status change is pushed.
### Old names
The following old names for existing algorithms will continue to be supported, however it is recommended to use the new names instead.
@ -129,7 +129,7 @@ Configure the hardware via your `config.h`:
From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:
@ -60,7 +61,7 @@ The 4 wires of the TRRS cable need to connect GND, VCC, and SCL and SDA (aka PD0
The pull-up resistors may be placed on either half. If you wish to use the halves independently, it is also possible to use 4 resistors and have the pull-ups in both halves.
@ -192,7 +192,7 @@ When developing your keyboard, keep in mind that all warnings will be treated as
## Copyright Blurb
If you're adapting your keyboard's setup from another project, but not using the same code, but sure to update the copyright header at the top of the files to show your name, in this format:
If you're adapting your keyboard's setup from another project, but not using the same code, be sure to update the copyright header at the top of the files to show your name, in this format:
このページは QMK API の使い方を説明します。もしあなたがアプリケーション開発者であれば、全ての [QMK](https://qmk.fm) キーボードのファームウェアをコンパイルするために、この API を使うことができます。
## 概要
このサービスは、カスタムキーマップをコンパイルするための非同期 API です。API に 何らかの JSON を POST し、定期的に状態をチェックし、ファームウェアのコンパイルが完了していれば、結果のファームウェアと(もし希望すれば)そのファームウェアのソースコードをダウンロードすることができます。
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.