Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Programmable Button API refactor and improve docs #18641

Merged
merged 2 commits into from
Oct 15, 2022

Conversation

fauxpark
Copy link
Member

@fauxpark fauxpark commented Oct 7, 2022

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

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@drashna drashna requested a review from a team October 8, 2022 00:25
@fauxpark fauxpark merged commit f0b2bfd into qmk:develop Oct 15, 2022
@fauxpark fauxpark deleted the programmable-button-refactor branch October 15, 2022 03:33
ramonimbao pushed a commit to ramonimbao/qmk_firmware that referenced this pull request Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants