The old custom matrix code for Preonic rev3 was relying on the
`matrix_col_t` type, because the code actually reads the row pins and
assembles the state for whole columns, and then transposes the matrix in
the custom debouncing code. Restore that type (which is no longer
defined by the core QMK code) to make the custom matrix code work
properly (when `matrix_row_t` was used instead of `matrix_col_t`, the
state of two electrical rows was lost, and those electrical rows
corresponded to the bottom physical row, which did not work).
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Peter Park <peter@Peters-MacBook-Air.local>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ash <ash@splitpixel.co.uk>
* Fix issues with user split transport code
* Improve OLED (More font stuff, improved keylogger, etc)
* Add `KEYLOCK` macro to disable USB, borrowed from command feature.
* Convert Kyria fully to proton C (no more AVR kyria)
* Add Work Louder Work Board keymap
* GPIO functions are no longer in quantum.h
* Update docs/internals_gpio_control.md
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Apparently the default keymaps for `contra` and `fractal` were derived
from some `planck` keymap which contained code to control the status LED
in the implementation of the `BACKLIT` custom keycode. Unfortunately,
the code to control the LED manipulated the `E6` pin directly, and it
was copied without changes, but the `contra` and `fractal` boards use
the `E6` pin in the matrix, therefore pressing the key mapped to
`BACKLIT` resulted in phantom keypresses for all keys in the
corresponding column.
* refactor keymaps for readability
- use QMK-native keycode aliases
- physically align keycodes
* rework layout macro
A discrepancy between the default and via keymaps prompted a deep dive into the keyboard's switch matrix, which led to the discovery that (1) the layout macro's arguments were not arranged physically, and (2) the keymaps didn't assign the keycodes to the same switches (the default keymap's keycodes were in the wrong sequence).
Additionally, the layout macro was built to support a split Backspace, but named as if it were for a 2u Backspace, which broke the enabled support for Community Layout keymaps.
This commit:
- arranges the layout macro arguments according to physical order
- corrects the keymaps
- renames the layout macro to specify the split Backspace
- disables Community Layout support
- updates the `info.json` data
* add LAYOUT_65_ansi_blocker
* enable Community Layout support
* update `info.json` metadata
- use full product listing URL
- use GitHub username for maintainer field
* update readme
- fix vendor link in lead paragraph
- update metadata list
- use GitHub username of keyboard maintainer
- correct Supported Hardware
- add Hardware Availability link
- add flashing and bootloader instructions
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Wolf Van Herreweghe <wolfvh@getupgamesofficial.com>
* add matrix diagram to keyboard header file
* friendly-format info.json
* correct layout data
* add legends to info.json key labels
* add LAYOUT_split_space_split_bs
Rename the `LAYOUT` tree in info.json to `LAYOUT_split_space_split_bs`, and add a corresponding layout macro.
* add LAYOUT_all data to info.json
* add LAYOUT_7u_space
* add LAYOUT_7u_space_split_bs
* add LAYOUT_split_space
* convert tabs to spaces in dyz40.h
* Updated Keychron Q1 user keymap
- Added Caps Lock indicator
- Mission Control and Launchpad custom keycodes are now defined using the VIA user keycodes range so they can be labeled properly in VIA
* Only use VIA keycode range if VIA is enabled
* Reformatted led_indexes enum to match layout
* Feature: When the Fn layer is active, RGB lighting turns off for keys that are not assigned
* Fixes
* Cleanup: Updated method signature of rgb_matrix_set_color_by_keycode to more closely match rgb_matrix_set_color
* Fixed int sizing for keycodes
* add Configurator data
* rename README.md to lowercase
API can't find this file unless the filename is lowercase (`readme.md`).
* readme touch-up
Correct typos and improve some grammar and Markdown.
* correct Configurator layout data
* rename LAYOUT to LAYOUT_60_ansi
* correct info.json maintainer field
Use the maintainer's GitHub username.
* correct the compiling/flashing instructions
Keyboard value is relative to `qmk_firmware/keyboards/`.
* Specify hex as the default FIRMWARE_FORMAT which is copied to qmk_firmware root folder
* Specify hex as the default FIRMWARE_FORMAT which is copied to qmk_firmware root folder
Co-authored-by: sadkins <sadkins@iMac-Pro.local>
* use XXX for KC_NO in hex4b.h
* add matrix diagram to hex4b.h
* rename LAYOUT to LAYOUT_all
* remove reference to KBFirmware JSON Parser
* info.json: add line breaks between rows
* rename LAYOUT_all to LAYOUT_split_bs
- LAYOUT alias for backward compatibility
- LAYOUT_all alias to signify support for every matrix position
* add LAYOUT_2u_bs
* add LAYOUT_tsangan_split_bs
* add LAYOUT_tsangan_2u_bs
* info.json: remove meta key
* use XXX for KC_NO in rev1.h
* add matrix diagram to rev1.h
* remove reference to KBFirmware JSON Parser from rev1.h
* use XXX for KC_NO in rev2.h
* add matrix diagram to rev2.h
* add LAYOUT_60_ansi and LAYOUT_60_iso
* enable Community Layout support
* update info.json metadata
- specify keyboard revision in keyboard_name
- use GitHub username in maintainer field
* remove reference to KBFirmware JSON Parser from main rules.mk
* add LAYOUT_numpad_6x4
* tidy-up info.json data
* use GitHub account name for maintainer field
* remove meta key
* add matrix diagram to delphine.h
* update Community Layout support
* add layout variants with 2.75u Right Shift
* move layout alias to info.json
* match info.json labels to matrix positions
Edits the label keys in info.json to match the matrix position identifiers in adelais.h.
* info.json: add line breaks between keyboard rows
* info.json: use GitHub username in maintainer field
* Initial compatibility with bm80
* move files to kprepublic directory, see #12159
* fix pin assignment
* Revert "fix pin assignment"
This reverts commit 5a53a74953a23bb5064c11d5d9e6daf007a54872.
* add testing setup (peepeetee keymap, will use for personal purposes later), fix LED assignment, add indicator LED, LED location, count, and flags are broken
* fixed flags( not sure, please check)
* fixed number of LEDs
* add comment about f11
* remove comment about f11, change capslock flag to be 1 rather than 1+8 as there is a standalone indicator LED
* readme.md
* add via keymap
* add info.json with help from noroadsleft's converter
* add suspended state implementation, I don't think it's working
* update to my testing setup
* restore erroneously included bm68rgb config
* Update keyboards/kprepublic/bm80/config.h
Co-authored-by: Drashna Jaelre <drashna@live.com>
* add reset instructions
* change reset instruction grammar
* remove not working sleep function, add comment for RGB flags
* add LED mapping comments
* change readme grammar
* replace rgb light paremeters with rgb matrix paremeters, enable framebuffer effects
* re-enable peepeetee/config.h, updating my disabled effect list
* updating my disabled effect list
* update LED struct documentation
* update readme with RGB matrix effect information
* Update keyboards/kprepublic/bm80/rules.mk
Co-authored-by: Drashna Jaelre <drashna@live.com>
* move files back to keyboard from keyboard/kprepublic, see 85b33d6 and qmk#12159
* Apply suggestions from code review
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
* cleanup peepeetee keymap
* update peepeetee keymap; rebase on current master
* moved to /kprepublic, see #12159
* Apply suggestions from code review
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* Genesis Hotswap: rename LAYOUT to LAYOUT_tkl_ansi
* Genesis Hotswap: delete blank layers from default keymap
Results in a smaller compiled firmware size.
* Genesis Hotswap: tidy-up via keymap
Fixes the visual alignment of keycodes.
* Genesis Hotswap: specify Hotswap in info.json
* Genesis Hotswap: enable Community Layout support
* Genesis Hotswap: remove KBFirmware Parser references
* Genesis Hotswap: specify Hotswap in config.h
* Genesis Solder: correct keyboard layout
* Genesis Solder: rename LAYOUT to LAYOUT_all
I don't actually know with certainty that this *is* LAYOUT_all, but in the absence of more concrete information, I'm going with this.
* Genesis Solder: delete blank layers from default keymap
Results in a smaller compiled firmware size.
* Genesis Solder: tidy-up via keymap
Fixes the visual alignment of keycodes.
* Genesis Solder: specify Hotswap in info.json
* Genesis Solder: add LAYOUT_tkl_ansi
* Genesis Solder: enable Community Layout support
* Genesis Solder: remove KBFirmware Parser references
* Genesis Solder: specify Solder in config.h
* update pr_checklist.md translation
* update file based on comments
* add id on feature_led_indicators.md and update text based on comments
* update file based on comments
* update file based on comment
* clean up amj96.h
- use #pragma once include guard
- remove extra comments
- update matrix position alignment (easier readability)
* info.json: apply human-friendly formatting
* rename LAYOUT to LAYOUT_all
* clean up rules.mk
Align to QMK's AVR template.
* clean up default keymap
- use four-space indent
- add RESET keycode (Fn+R)
- remove unnecessary functions
* clean up config.h
- use #pragma once include guard
- move lighting settings to the middle of the file (QMK template conformance)
- remove Magic and MIDI configuration blocks
* update readme.md file
- update keyboard info list
- add flashing instructions
- update Docs links
- remove trailing spaces
* remove "empty" config.h and readme.md from default keymap
* mammoth20x: edit size of RightEncode key in Configurator
* physically arrange layout macro
Arranges the keycodes to resemble the assembled board.
* rename LAYOUT_default to LAYOUT
Includes "layout_aliases" tree in info.json for backwards compatibility.
* rules.mk touch-up
* convert tabs to spaces
* add line break before ENCODER_ENABLE (not included in QMK's template)
* readme.md touch-up
* remove zero-width space characters
* markdown fix for info paragraph
* update link text
* clean up keyboard header files
* use #pragma once include guard
* convert tabs to spaces
* remove redundant #include statements
* update revision references to main header (`../meira.h` -> `meira.h`)
* refactor default keymap
* use LAYOUT as layout macro reference
* use enum statement for layer indexes; make layers contiguous
* use four-space indent
* update keycode grid alignment
* update layout macro aliases
* move layout macro aliases to info.json
* alias KEYMAP to LAYOUT_ortho_4x12 so the user keymaps don't have to be edited
* touch up meira.h
There's no Planck MIT layout reference here.
* add copyright headers
* workaround patch for grahampheath keymap
The `matrix_init_kb()` function in `meira.c` calls `backlight_set()`, but the grahampheath keymap disables Backlight to make space for Audio, causing the firmware to fail to compile.
This commit wraps the `backlight_set()` call in an ifdef statement, so the call is excluded if Backlight is disabled.
* clean up rules.mk inline comments
* re-order rules.mk settings
* clean up readme.md
* correct link to keyboard image
* change metadata section to unordered list
* spelling corrections
* update make instructions and Docs links
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Add initial implementation of 5 keyboards supported by the OverNumpad Controller.
* Apply suggestions from code review
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Apply changes similar to other code review suggestions.
* Apply suggestions from code review
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Apply changes similar to other code review suggestions.
* overnumpad controller info.jsons: update maintainer and url.
* classic_ultracl_pre_2013: added support for the default 'fullsize_ansi' layout
* classic_ultracl_pre_2013: moved the order of the iso enter key in the layout macro to be considered to be on the bottom row, like in the default fullsize_iso layout. Rename the iso layout to fullsize_iso, and enable it in rules.mk
* Removed QMKBEST and QMKURL
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
* Deleting empty files
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* Moved gergoplex to seperate PR
* vendor + cformat
* Update keyboards/gboards/k/gergoplex/matrix.c
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* lifiting keyboards up
* Update readme.md
* Update keyboards/gboards/gergoplex/config.h
Co-authored-by: Drashna Jaelre <drashna@live.com>
* remove English dicts
* cformatted
* Prettify keymap
* Remove via keymaps
Via doesn't support chords/combos, and this makes the keymap on such a
small keyboard quite uncomfortable and incomplete.
* Address QMK pull code review notes
* Cleanup (tabs, excessive comments)
* Fix keymap typos
* Use enum to define layers
* Multiple changes
- got rid of LAYOUT_kc in favour of LAYOUT_split_3x5_3
- fixed matrix custom C code to build with updated external dependencies (gcc)
- fixed used combo docs
keyboards/gboards/gergoplex/matrix.c:189:9: error: implicit declaration of function 'phex' [-Werror=implicit-function-declaration]
phex(row);
^~~~
keyboards/gboards/gergoplex/matrix.c:191:9: error: implicit declaration of function 'pbin_reverse16'; did you mean 'print_bin_reverse16'? [-Werror=implicit-function-declaration]
pbin_reverse16(matrix_get_row(row));
* Remove apparently redundant macros
* Replace direct pin control with IO functions
* config mouse enable and combo delay fix
The default delay is 200:
#define COMBO_TERM 200
how long for the Combo keys to be detected. Defaults to TAPPING_TERM if not defined.
tmk_core/common/action_tapping.h|22| 13:# define TAPPING_TERM 200
* Remove redundant defines
* Unambiguously refer to the Special layer
* Fix formatting
* gboards/gergoplex set IGNORE_MOD_TAP_INTERRUPT
This solves my issue was with KC_CTL_A working correctly and it was set in @germ's repo
39c86e080d/keyboards/gboards/k/gergoplex/config.h (L49)https://beta.docs.qmk.fm/using-qmk/software-features/tap_hold#ignore-mod-tap-interrupt
* Name change
See commit 581368596ed
* Wording change
* Update keyboards/gboards/gergoplex/keymaps/default/keymap.c
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Add copyright headers
* Fix debounce type
| avr-gcc: error: .build/obj_gboards_gergoplex_default/quantum/debounce/eager_pr.o: No such file or directory
* Implement colemak-dhm keymap
Co-authored-by: Germ <jeremythegeek@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Brian Tannous <Brian@BrianTannous.com>
* update grid alignment of keycodes
* update key assignments on via keymap
A seemingly-misplaced key assignment on Layers 1 through 3 of the via keymap led to keys being off by one in comparison to the default keymap.
* switch Backslash and Backspace on via keymap base layer
Matches the via keymap's key mapping to that of the default keymap.
* use QMK 3-character notation in oxalys80.h
* add matrix diagram; remove Planck reference
* add LAYOUT_tkl_ansi and LAYOUT_tkl_ansi_wkl layout macros
* add LAYOUT_tkl_ansi_tsangan macro
* add ISO layouts
Add LAYOUT_tkl_iso, LAYOUT_tkl_iso_tsangan, and LAYOUT_tkl_iso_wkl macros.
* enable Community Layouts support
* tidy up rules.mk
* readme tidy-up
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Wolf Van Herreweghe <wolfvh@getupgamesofficial.com>
changed line 21 from saying "three steps" to "two steps" as there are only two steps
Co-authored-by: feynmantf <46390109+feynmantf@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ash <ash@splitpixel.co.uk>
* Added new keymap for crkbd/rarick
* Delete flash.sh
Deleted rarick crkbd flashing script, as it will not be used by most users.
* Applied feedback, and fixed build error caused by builder updates
* Update keyboards/crkbd/keymaps/rarick/config.h
Removed USE_MATRIX_I2C, no longer used.
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
* grid-align keycodes; use short-form keycodes
No logic change.
* info.json: correct layout macro reference
* info.json: correct LAYOUT_64key data
Removes an extra key from the layout data.
* 64_ansi Community Layout support
* rename LAYOUT_64key to LAYOUT_64_ansi (with alias for backwards compatibility)
* add LAYOUTS = 64_ansi to rules.mk
* remove width and height keys from info.json
* 60_tsangan_hhkb Community Layout support
* rename LAYOUT to LAYOUT_60_tsangan_hhkb
* add LAYOUTS = 60_tsangan_hhkb to rules.mk
* correct maintainer field in info.json
* remove width and height keys from info.json
* fix GitHub account link on readme
* 65_ansi_blocker Community Layout support
* rename LAYOUT to LAYOUT_65_ansi_blocker (with alias for backwards compatibility)
* add LAYOUTS = 65_ansi_blocker to rules.mk
* remove width and height keys from info.json
* [Keyboard] Add some last minute tweaks to Work board
* Additional fixes
* Fix rgb pin
* Fix ws2812 hackery
* additional led tweaks
* Add indicator LEDs
* fix bootmagic settings
* Fix up RGB stuff
* Limit power draw for entire board
* fixup lights and such
* change LED order on loop
* Fix indicators if via is not enabled
* Enable Sleep for rgb matrix
* Even more LED tweaks
* Final tweaks?
* Tweak keycodes
* apply human-friendly formatting to info.json
* update key labels; correct maintainer field
* add LAYOUT_all data to info.json
* remove width and height keys from info.json (per fauxpark)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Without this build would fail, if a keyboard had haptic feedback enabled,
TAPPING_TOGGLE was not overridden in a config.h, and if NO_HAPTIC_MOD was
defined in config.h.
* Nix: Allow calls to `bin/qmk` even when the build was started by `qmk`
The `$PATH` modifications performed by the Nix wrapper for the `qmk`
executable prevent `bin/qmk` from working properly (the changed `$PATH`
contains a wrong `python3` executable which does not have the needed
Python modules in its module path). As a workaround, disable the
generation of that wrapper for the `qmk` Python package (there is yet
another wrapper generated while building the Python environment, which
would still set the Python module path properly when running `qmk`).
Although `bin/qmk` is officially deprecated, QMK CLI still invokes it in
some cases (at least `qmk doctor` and `qmk pytest`), therefore keeping
these invocations working is useful.
* Nix: Update `util/nix/pyproject.toml` to match `requirements*.txt`
Update the Python dependency information used by Poetry to match the
current state of the qmk_firmware code.
* Nix: Bump QMK CLI dependency to 1.0.0; bump other Python deps
Update Python dependencies for nix-shell to the most recent releases:
- dotty-dict: 1.3.0 -> no longer used
- milc: 1.4.2 -> 1.6.2
- pep8-naming: 0.11.1 -> 0.12.1
- pygments: 2.9.0 -> 2.10.0
- pyrsistent: 0.17.3 -> 0.18.0
- pyusb: 1.1.1 -> 1.2.1
- setuptools-scm: 6.0.1 -> no longer used
- qmk: 0.1.0 -> 1.0.0
- qmk-dotty-dict: not used -> 1.3.0.post1
- yapf: 0.30.0 -> 0.31.0
Note to self: The command to update Python dependencies changed to:
( cd util/nix && nix run 'nixpkgs#poetry' -- update --lock )
@ -75,7 +75,7 @@ As noted during last breaking changes cycle, QMK has decided to deprecate the fu
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.
Currently `lite` is the equivalent of `yes` in `rules.mk`. Next cycle the use of the`lite` keyword will be prevented in favour of `yes` -- any new submissions should now be using `yes` or `no` to minimise disruption.
* This needs to perform the low-level initialisation of all row and column pins. By default this will initialise the input/output state of each of the GPIO pins listed in `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no initialisation of pin state will occur within QMK itself, instead deferring to the keyboard's override.
* These three functions need to perform the low-level retrieval of matrix state of relevant input pins, based on the matrix type. Only one of the functions should be implemented, if needed. By default this will iterate through `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, configuring the inputs and outputs based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no manipulation of matrix GPIO pin state will occur within QMK itself, instead deferring to the keyboard's override.
@ -214,11 +214,11 @@ This is controlled by two functions: `suspend_power_down_*` and `suspend_wakeup_
```c
voidsuspend_power_down_user(void){
rgb_matrix_set_suspend_state(true);
// code will run multiple times while keyboard is suspended
@ -168,10 +168,16 @@ This mode sets continuous haptic feedback with the option to increase or decreas
The Haptic Exclusion is implemented as `__attribute__((weak)) bool get_haptic_enabled_key(uint16_t keycode, keyrecord_t *record)` in haptic.c. This allows a re-definition at the required level with the specific requirement / exclusion.
### NO_HAPTIC_MOD
With the entry of `#define NO_HAPTIC_MOD` in config.h, modifiers from Left Control to Right GUI will not trigger a feedback. This also includes modifiers in a Mod Tap configuration.
With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will not trigger feedback:
* Usual modifier keys such as Control/Shift/Alt/Gui (For example `KC_LCTRL`)
* `MO()` momentary keys. See also [Layers](feature_layers.md).
* `LT()` layer tap keys, when held to activate a layer. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered.
* `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered.
* `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md).
### NO_HAPTIC_FN
With the entry of `#define NO_HAPTIC_FN` in config.h, layer keys will not rigger a feedback.
With the entry of `#define NO_HAPTIC_FN` in config.h, deprecated `fn_actions` type function keys will not trigger a feedback.
### NO_HAPTIC_ALPHA
With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback.
The keyboard can be made to be recognized as a joystick HID device by the operating system.
This is enabled by adding `JOYSTICK_ENABLE` to `rules.mk`. You can set this value to `analog`, `digital`, or `no`.
!> Joystick support is not currently available on V-USB devices.
The joystick feature provides two services:
@ -18,7 +16,8 @@ or send gamepad reports based on values computed by the keyboard.
To use analog input you must first enable it in `rules.mk`:
```makefile
JOYSTICK_ENABLE=analog
JOYSTICK_ENABLE=yes
JOYSTICK_DRIVER= analog # or 'digital'
```
An analog device such as a potentiometer found on a gamepad's analog axes is based on a [voltage divider](https://en.wikipedia.org/wiki/Voltage_divider).
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.
The [Grave Escape feature](feature_grave_esc.md) is limited in its configurability and has [bugs when used on macOS](feature_grave_esc.md#caveats). Key overrides can be used to achieve a similar functionality as Grave Escape, but with more customization and without bugs on macOS.
?> Currently, this feature is not supported for splitkeyboards
?> This feature requires additional configuration to work on both halves of a split keyboard see [Data sync options](feature_split_keyboard.md#data-sync-options)
QMK provides methods to read 5 of the LEDs defined in the HID spec:
@ -219,47 +219,52 @@ One communication attempt will be allowed everytime this amount of time has pass
Set to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size.
### Data Sync Options
The following sync options add overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. These can be enabled by adding the chosen option(s) to your `config.h` file.
```c
#define SPLIT_TRANSPORT_MIRROR
```
This mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses).
```c
#define SPLIT_LAYER_STATE_ENABLE
```
This enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer.
```c
#define SPLIT_LED_STATE_ENABLE
```
This enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status.
```c
#define SPLIT_MODS_ENABLE
```
This enables transmitting modifier state (normal, weak and oneshot) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables transmitting modifier state (normal, weak and oneshot) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen).
```c
#define SPLIT_WPM_ENABLE
```
This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen).
```c
#define SPLIT_OLED_ENABLE
```
This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing.
```c
#define SPLIT_ST7565_ENABLE
```
This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled.
This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing.
### Custom data sync between sides :id=custom-data-sync
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.
