Skip to content

change(ESP_NOW_Serial): No teardown on retry limit. #10291

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

Closed
wants to merge 1 commit into from

Conversation

ClockeNessMnstr
Copy link
Contributor

After max retries is met once the ESP_NOW_Serial_Class performs "end()" which removes the peer from ESP_NOW.
Further messages to and from ESP_NOW_Serial are not received or sent.
Peer should stay in ESP_NOW to re-establish connection even with data loss.
This change will "retry and drop" the data piece by piece instead of aborting the connection.


Description of Change

ESP_NOW_Serial "Peer" will not remove itself from ESP_NOW_Peer list when data sent is not received by a peer.
ESP_NOW_Serial::end() is still called when ESP_NOW::send() fails

Tests scenarios

Tested on a pair of M5Stack Stamp ESP32-C3.
Confirmed that transmission is able to continue after disconnecting the Receiving module from power, Attempting to send data, and then restoring power to Receiving module.

Previously, transmission halted as the cleanup/teardown in ESP_NOW_Serial::end() stops ESP_NOW_Serial::write() and removes peer from ESP_NOW::_esp_now_peers, which stops ESP_NOW from calling any onRecieve

Related links

I did not create an issue for this.
Issue was that the NowSerial had to be re-initialized essentially for every byte without knowing if the peer was present/restored.

Existing workaround was to use broadcast address for TX and a separate ESP_NOW_Serial peer with MAC address for RX.

After max retries is met once the ESP_NOW_Serial_Class performs "end()" which removes the peer from ESP_NOW. 

Further messages to and from ESP_NOW_Serial are discarded or ignored. 

Peer should stay in ESP_NOW to re-establish connection even with data loss. 

This change will retry and drop the data piece by piece instead of aborting the connection. 

physically
@CLAassistant
Copy link

CLAassistant commented Sep 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Sep 4, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Do not teardown for missed message to peer. ":
    • body's lines must not be longer than 100 characters
    • 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 ClockeNessMnstr, 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.
- 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 76d7cac

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants