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

fix(esp_hid): Enable notifications/Indications for HID Devices (IDFGH-14581) #15337

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mitchellcairns
Copy link

When HID devices reconnect to a host such as a WIndows device, Windows will not subscribe to notifications/indications, resulting in a state where no reports may be sent.

Open to another fix, but this ought to be looked into and resolved. It results in HID devices only being able to report on initial pairing, and not again with reconnections thereafter.

NOTE: This does not always happen on Windows devices due to some caching behavior apparently. But, where it does occur, it is consistent behavior.

When HID devices reconnect to a host such as a WIndows device, Windows will not subscribe to notifications/indications, resulting in a state where no reports may be sent.

Open to another fix, but this ought to be looked into and resolved. It results in HID devices only being able to report on initial pairing, and not again with reconnections thereafter.

NOTE: This does not always happen on Windows devices due to some caching behavior apparently. But, where it does occur, it is consistent behavior.
Copy link

github-actions bot commented Feb 5, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix(esp_hid): Enable notifications/Indications for HID Devices":
    • body's lines must not be longer than 100 characters

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).

👋 Hello mitchellcairns, 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.
- 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 7520829

@espressif-bot espressif-bot added the Status: Opened Issue is new label Feb 5, 2025
@github-actions github-actions bot changed the title fix(esp_hid): Enable notifications/Indications for HID Devices fix(esp_hid): Enable notifications/Indications for HID Devices (IDFGH-14581) Feb 5, 2025
@esp-zhp
Copy link
Collaborator

esp-zhp commented Feb 7, 2025

Hello,

Thank you for your feedback!

The root cause of this issue is that after the ESP device powers off, the CCC (Client Characteristic Configuration) information used by the esp_ble_hidd_dev_input_set function is not restored. Additionally, the peer device (such as a smartphone acting as an HID host) does not rewrite the CCC value, resulting in an undefined CCC state.

Different smartphones exhibit different behaviors: some will attempt to set the CCC upon reconnection, while others will not, leading to compatibility issues. The best approach to resolving this issue is to restore the CCC information from NVS, rather than modifying the implementation in the way you suggested.

Please allow me some time to work on this.

@mitchellcairns
Copy link
Author

Hello,

Thank you for your feedback!

The root cause of this issue is that after the ESP device powers off, the CCC (Client Characteristic Configuration) information used by the esp_ble_hidd_dev_input_set function is not restored. Additionally, the peer device (such as a smartphone acting as an HID host) does not rewrite the CCC value, resulting in an undefined CCC state.

Different smartphones exhibit different behaviors: some will attempt to set the CCC upon reconnection, while others will not, leading to compatibility issues. The best approach to resolving this issue is to restore the CCC information from NVS, rather than modifying the implementation in the way you suggested.

Please allow me some time to work on this.

Thank you. Looking forward to a fix.

@esp-zhp
Copy link
Collaborator

esp-zhp commented Feb 14, 2025

Does this issue also occur when using the NimBLE host?

@mitchellcairns
Copy link
Author

Does this issue also occur when using the NimBLE host?

I have not tested NimBLE as it's out of my project scope for the time being. I have to switch back and forth between BLE and BR/EDR

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.

3 participants