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

Update HID Mouse example with scroll wheel status and middle mouse button click (IDFGH-11578) #12698

Closed
wants to merge 4 commits into from

Conversation

jbilander
Copy link

This also requires that byte 3 (the fourth byte) is added in the hid_usage_mouse.h struct

espressif/idf-extra-components@0c9d445

Updated Mouse with scroll wheel status and middle mouse button click status.
@CLAassistant
Copy link

CLAassistant commented Nov 30, 2023

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Nov 30, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add scroll wheel status and middle mouse button click":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update README.md":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello jbilander, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 16abaf0

@espressif-bot espressif-bot added the Status: Opened Issue is new label Nov 30, 2023
@github-actions github-actions bot changed the title Update HID Mouse example with scroll wheel status and middle mouse button click Update HID Mouse example with scroll wheel status and middle mouse button click (IDFGH-11578) Nov 30, 2023
@roma-jam roma-jam self-requested a review December 1, 2023 11:31
Copy link
Collaborator

@roma-jam roma-jam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jbilander ,
Thanks a lot for the contribution!

We are planning espressif/idf-extra-components#214 to add support not only for boot interface devices, but to the any other + make it possible to define handling manually (which means to work with report descriptor and with raw report data).

Regarding the display button3 status it seems that we can merge it right now and for the scrollwheel adding seems that it is better to return to that question after espressif/idf-extra-components#214 being merged.

Thanks.


// Calculate absolute position from displacement
x_pos += mouse_report->x_displacement;
y_pos += mouse_report->y_displacement;
wheel_pos += mouse_report->scrollwheel;
Copy link
Collaborator

@roma-jam roma-jam Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current version of HID Driver was made for devices which have a HID boot interface. In that case the mouse report is simple and always has the default structure. Structure definition can be found in Appendix B2 of Device Class Definition for Human Interface Devices (HID) Version 1.11.

That is why the the structure in the hid_usage_mouse.h file for hid_mouse_input_report_boot_t satisfy the specification.
Sure, the scroll data in report for different devices pretty much always on the same place in buffer, but to be sure about the correct way is to handle the report device descriptor and handle the report data according to structure from descriptor.

@jbilander jbilander closed this by deleting the head repository Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants