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

Comments in BLEAdvertising are wrong/misleading #10511

Closed
1 task done
thomasw-mitutoyo-ctl opened this issue Oct 23, 2024 · 1 comment · Fixed by #10512
Closed
1 task done

Comments in BLEAdvertising are wrong/misleading #10511

thomasw-mitutoyo-ctl opened this issue Oct 23, 2024 · 1 comment · Fixed by #10512
Assignees
Labels
Status: Awaiting triage Issue is waiting for triage

Comments

@thomasw-mitutoyo-ctl
Copy link
Contributor

thomasw-mitutoyo-ctl commented Oct 23, 2024

Board

not board related

Device Description

not board related

Hardware Configuration

not board related

Version

latest master (checkout manually)

IDE Name

none

Operating System

none

Flash frequency

none

PSRAM enabled

yes

Upload speed

none

Description

I was reading the code of BLEAdvertising() in order to understand the inner details and adapt my project to it.
I noticed that the code has different comments which do not match the implementation.

Several advertising types are different in the comments compared to the implementation. The implementation seems to be correct but the comment was probably copy/pasted and not adapted afterwards.

Example:

// [Len] [0x02] [LL] [HH]

The comment says 0x02, but later it uses 0x03:

cdata[1] = ESP_BLE_AD_TYPE_16SRV_CMPL; // 0x03

Sketch

none

Debug Message

none

Other Steps to Reproduce

none

I have checked existing issues, online documentation and the Troubleshooting Guide

  • I confirm I have checked existing issues, online documentation and Troubleshooting guide.
@SuGlider
Copy link
Collaborator

Thanks @thomasw-mitutoyo-ctl for the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting triage Issue is waiting for triage
Projects
None yet
2 participants