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

change(esp_now_serial): No teardown on retry limit #10293

Merged
merged 3 commits into from
Sep 17, 2024

Conversation

ClockeNessMnstr
Copy link
Contributor

Description of Change

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.

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.
Restoring power to Receiving module.

Previously, transmission halts as the cleanup/teardown in ESP_NOW_Serial::end() is triggered.

Related links

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

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()". 
This 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.
Copy link
Contributor

github-actions bot commented Sep 4, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "change(ESP_NOW_Serial): No teardown on retry limit":
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .

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 3 commits (simplifying branch history).

👋 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.
- 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 0ee66a8

@ClockeNessMnstr ClockeNessMnstr changed the title change(ESP_NOW_Serial): No teardown on retry limit change(esp_now_serial): No teardown on retry limit Sep 4, 2024
@ClockeNessMnstr
Copy link
Contributor Author

This seems to stop ESP_NOW_Serial::write from returning 0 although it returns "1" for the first attempt anyway.
Going to make a couple issues instead.

@ClockeNessMnstr
Copy link
Contributor Author

Actually it returns "1" until it does the "teardown" even though it did not succeed in sending the first byte(s).

This is not due to my change.

@VojtechBartoska VojtechBartoska added the Status: Review needed Issue or PR is awaiting review label Sep 5, 2024
@me-no-dev
Copy link
Member

The idea makes sense, @P-R-O-C-H-Y please make sure it's implemented in the best way.

Copy link
Contributor

github-actions bot commented Sep 17, 2024

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S30⚠️ +160.000.00000.000.00
ESP32S20⚠️ +120.000.00000.000.00
ESP32C30⚠️ +180.000.00000.000.00
ESP32C60⚠️ +180.000.00000.000.00
ESP320⚠️ +200.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
ESP_NOW/examples/ESP_NOW_Broadcast_Master0000000000
ESP_NOW/examples/ESP_NOW_Broadcast_Slave0000000000
ESP_NOW/examples/ESP_NOW_Network0000000000
ESP_NOW/examples/ESP_NOW_Serial⚠️ +160⚠️ +120⚠️ +180⚠️ +180⚠️ +200

Copy link
Contributor

github-actions bot commented Sep 17, 2024

Test Results

 56 files   56 suites   4m 14s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
135 runs  135 ✅ 0 💤 0 ❌

Results for commit 0ee66a8.

♻️ This comment has been updated with latest results.

@P-R-O-C-H-Y
Copy link
Member

P-R-O-C-H-Y commented Sep 17, 2024

@ClockeNessMnstr Hi, I did a small change to your PR so we have backward compatibility if someone want to remove the peer on fail. So we have it as optional. By default the peer won't be removed. Can you please test if it's ok for you? Thanks

@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 Sep 17, 2024
@me-no-dev me-no-dev merged commit c55f5aa into espressif:master Sep 17, 2024
70 of 72 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants