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(esp32): Added a timeout option to the BLEClient's connect function #9005

Merged
merged 4 commits into from
Feb 7, 2024

Conversation

LiveSparks
Copy link
Contributor

Description of Change

The connect function used to wait for portMAX_DELAY at the last rc = m_semaphoreOpenEvt.wait("connect"); line.
I have modified it such that now a timeoutMs parameter can be passed.

Tests scenarios

Tested this on ESP32C3 boards running a complex BLE application involving Scanning, Server, and Client functionality.

Related links

Could not find a relevant issue in this repo but one issue was open in nkolban's repo: link

The same issue is also mentioned in this unsolved stackoverflow question.

Example Usage

This is a snippet from my application. Will not work without modification.

// Get the address of the node to connect to
BLEAddress DeviceAddress = node_to_connect_to.getAddress();
esp_ble_addr_type_t DeviceType = node_to_connect_to.getAddressType();

// Try to connect.
pClient = BLEDevice::createClient();
if(!pClient->connect(DeviceAddress, DeviceType, CONNECTION_TIMEOUT_MS)){
	pClient->disconnect();
	Serial.println("FAILED!");
	start_advertising();
	deviceState = SCANNING;
	return;
}
	
// No use of the timeout since connect() is blocking.
// uint32_t start_time = millis();
// while(!pClient->isConnected() && millis() - start_time < CONNECTION_TIMEOUT_MS){
// 	Serial.print(".");
// 	Serial.flush();
// 	delay(100);
// }

// Check if the connection was successful and change the device state accordingly.
if(pClient->isConnected()){
	Serial.println("SUCCESS!");
	deviceState = CONNECTED_TO_BLE_SERVER;
}
else{
	Serial.println("FAILED!");
	start_advertising();
	deviceState = SCANNING;
}

@CLAassistant
Copy link

CLAassistant commented Dec 15, 2023

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Dec 15, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update libraries/BLE/src/BLEClient.cpp":
    • 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 LiveSparks, we appreciate your contribution to 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.

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 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.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against bcdb49f

@VojtechBartoska
Copy link
Collaborator

Hello @LiveSparks, thanks for the PR. Please sign CLA and update the Pull Request name to follow Conventional commits style. Thanks!

@LiveSparks LiveSparks changed the title Added a timeout option to the BLEClient's connect function. fix(esp32): Added a timeout option to the BLEClient's connect function Dec 15, 2023
@LiveSparks
Copy link
Contributor Author

Hello @LiveSparks, thanks for the PR. Please sign CLA and update the Pull Request name to follow Conventional commits style. Thanks!

Done. Let me know if I have missed something or done anything wrong.

@VojtechBartoska VojtechBartoska added Area: BLE Issues related to BLE Status: Review needed Issue or PR is awaiting review labels Dec 15, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged Area: Peripherals API Relates to peripheral's APIs. and removed Area: BLE Issues related to BLE Status: Review needed Issue or PR is awaiting review labels Dec 15, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added this to the 2.0.15 milestone Dec 15, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Review needed Issue or PR is awaiting review Area: BLE Issues related to BLE and removed Area: Peripherals API Relates to peripheral's APIs. Status: Pending Merge Pull Request is ready to be merged labels Dec 15, 2023
Co-authored-by: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com>
@P-R-O-C-H-Y P-R-O-C-H-Y added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Feb 5, 2024
@me-no-dev me-no-dev merged commit e1a3525 into espressif:master Feb 7, 2024
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: BLE Issues related to BLE Status: Pending Merge Pull Request is ready to be merged
Projects
Development

Successfully merging this pull request may close these issues.

6 participants