Programmable Button API refactor and improve docs #18641
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This feature is very spammy as the reports are sent in
keyboard_task()
regardless of whether there are any changes. I've removed this and added two new functions,programmable_button_un/register()
which call_add/remove()
and then_flush()
to send the report. This way you can still leverage the API to programmatically modify multiple button states in a single report, but the keycodes will send a report immediately.The documentation has also been cleaned up, and particularly I have added a note regarding support for this feature on Windows and macOS.
Types of Changes
Issues Fixed or Closed by This PR
Checklist