The PyPI package for the Python HID library used here is called `hid`
(https://pypi.org/project/hid/), but the docs called it "pyhidapi" while
linking to the `hid` package page. There is also a separate, unrelated,
unmaintained package literally named `pyhidapi` on PyPI, so a reader
following the doc text as written can end up installing the wrong package.
Update the library list and prose to say `hid`, and add a short tip
covering the install/import command and calling out the package to avoid.
Fixes#26047
* Enhance tap-hold docs.
* Minor edits.
* Move note on Quick Tap to a sub bullet for visibility.
Co-authored-by: Drashna Jaelre <drashna@live.com>
---------
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Document the effect of the acceleration key in default mode.
* Move description into TIPS
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
---------
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
* Explain how to use STORE_SETUPS and PRINT_SETUPS
I found the instructions a little terse, but managed.
This also adds a note about PRINT_SETUPS reporting random numbers if STORE_SETUPS hasn't been used.
* Remove line breaks
Existing docs seem to use a mix of hard line breaks at sentence
ends, or 80 chars-ish, versus no line breaks in paragraphs.
* Suggestion during review
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
---------
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
* QMK avoids raw line breaks within paragraphs in Markdown
Mentioned in passing during a few of my recent documentation pull requests, eg #26070.
* Suggestion during review
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
---------
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
* Show how to flip semicolon and colon
* Apply whitespace suggestions from code review
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Match line-wrapping
Co-authored-by: Joel Challis <git@zvecr.com>
---------
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
* Use less tap dance memory.
Use dynamically allocated sparse array for tap dance state, dynamically allocate tap dance state when needed and free it when the tap dance is done.
* new approach
* Use null, check for null
* Reformat with docker
* Use uint8 with idx rather than uint16 with keycode in state
* fix accidental change
* reformat
* Add null check
* add documentation tip suggested by tzarc
* Only allow tap dance state allocation on key down, not on key up
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* Only allow tap dance allocation on key down, not on key up
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* add user action required section
---------
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
* feat: adds a transmit and receive i2c method
* fix: address the i2c transmit and receive length on u16
* Add AVR/LUFA implementation
Didn't add a progmem version, since that would only apply to receive.
Figured it wasn't worth it, but can add.
* Rearrange order of functions
* Add docs
* Fix doc gen error
* Fix lint issues
* fix more lint issues
* Only perform key and mod remapping in keycode_config() and mod_config() when MAGIC_ENABLE is defined.
* If not set, these functions now return the original keycode or modifier unchanged.
* Reduces firmware size, and unnecessary code when MAGIC_ENABLE is not enabled.
* Removed space saving suggestion with magic functions from squeezing AVR documentation
* Indicate <keyboard>.h LAYOUT() deprecation in understanding_qmk.md
Initial documentation uses <keyboard>.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in <keyboard>.h - This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk), QMK MSYS will also throw an error if this is attempted.
* Update understanding_qmk.md
enclosed '<' using backtick
* style guideline, now builds correctly
prior version indicates directory, new indicates config. still the same idea.
