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): Implement Device ID for BT Classic (IDFGH-14564) #15323

Closed
wants to merge 2 commits into from

Conversation

mitchellcairns
Copy link
Contributor

Right now, the VID/PID/VID Source are unused for BT Classic HID. This resolves that particular issue. This also Implements VID Source for BLE.

- DID (device identification) has not worked for Bluetooth Classic.
- This implements the HID PID/VID and other information relevant to create the DID when using the esp_hid component.
Copy link

github-actions bot commented Feb 3, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Implement DID SDP Record for esp_hid component":
    • body's lines must not be longer than 100 characters
    • summary looks empty
    • type/action looks empty
  • the commit message "Update VID Source":
    • 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).

👋 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 d78e73f

@mitchellcairns mitchellcairns changed the title fix(esp_hid): Fix Device ID for BT Classic fix(esp_hid): Implement Device ID for BT Classic Feb 3, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Feb 3, 2025
@github-actions github-actions bot changed the title fix(esp_hid): Implement Device ID for BT Classic fix(esp_hid): Implement Device ID for BT Classic (IDFGH-14564) Feb 3, 2025
@boblane1
Copy link
Collaborator

boblane1 commented Feb 5, 2025

Hi @mitchellcairns,

Thank you for submitting the PR. Would you mind making a slight modification to the code? Instead of directly calling BTA_DmSetLocalDiRecord, could you create the DIP record by invoking esp_sdp_create_record? This way, there would be no need to change esp_hidd_app_param_t. esp-idf/examples/bluetooth/esp_hid_device/main/esp_hid_device_main.c has shown how the function esp_sdp_create_record works.

@mitchellcairns
Copy link
Contributor Author

@boblane1 Are you proposing implementing a SDP callback within the esp_hid component? I want to make sure I understand what you're getting at. I think this would complicate this a bit as what would then happen later if the user wants to use SDP callbacks for other behavior?

@boblane1
Copy link
Collaborator

boblane1 commented Feb 5, 2025

I think this would complicate this a bit as what would then happen later if the user wants to use SDP callbacks for other behavior

This does seem to be a problem!

However, the primary DIP record created by the user using the SDP API may also overwrite the DIP Record already created in the HID. What's your opinion about the following suggestion?

  • Create a non-primary DIP record in HID
  • Create a primary DIP record in HID but try not to change the esp_hidd_api.h.
  • Just let users manage DIP themselves

If you decide to create a DIP record in HID, please care about the resource release.

@mitchellcairns
Copy link
Contributor Author

Just let users manage DIP themselves

In the end I think this is probably the more wise solution. I think I have a better understanding of the situation. Thank you for reviewing!

@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: Done Issue is done internally and removed Status: Opened Issue is new labels Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: Done Issue is done internally Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants