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

HardwareSerial:begin() changes RTS and CTS pins preventing detaching those pins #9353

Merged
merged 1 commit into from
Mar 11, 2024

Conversation

SuGlider
Copy link
Collaborator

@SuGlider SuGlider commented Mar 8, 2024

Description of Change

Begin() may "undo" a setpins() that has set RTS and/or CTS pin.
As consequence, RTS and CTS won't be detached with end().
This pins are only changed by using setPins() passing RTS and CTS.

setpins() can be called after or before begin()
when called before, begin() shall not change those pins.

This PR fixes it.

Tests scenarios

Tested with ESP32 just checking logs.

void setup() {
  Serial.setPins(3, 1, 25, 26); // ESP32 RX, TX, CTS, RTS
  Serial.begin(115200);
  Serial.end();  // only detaches RX and TX. CTS and RTS will be -1 after begin() and won't be detached!
}
void loop() {}

Related links

This changes has been backported to 2.0.15 by #9176

Begin() may undo a setpins() that has set RTS and/or CTS pin.
This pins are only changed with RTS and CTS.
setpins() can be called after or before begin()
when called before, begin() shall not change those pins.
@SuGlider SuGlider added this to the 3.0.0-RC1 milestone Mar 8, 2024
@SuGlider SuGlider self-assigned this Mar 8, 2024
Copy link
Contributor

github-actions bot commented Mar 8, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix: begin cts rts":
    • summary looks too short

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).

⚠️

The source branch "SuGlider-patch-1" incorrect format:

  • contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS).
    Please rename your branch.

👋 Hello SuGlider, 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 a488384

@SuGlider SuGlider changed the title HardwareSerial:begin() may undo a setpins() for RTS and CTS HardwareSerial:begin() change RTS and CTS pins preventing their detaching with end() Mar 8, 2024
@SuGlider SuGlider changed the title HardwareSerial:begin() change RTS and CTS pins preventing their detaching with end() HardwareSerial:begin() changes RTS and CTS pins preventing their detaching with end() Mar 8, 2024
@SuGlider SuGlider changed the title HardwareSerial:begin() changes RTS and CTS pins preventing their detaching with end() HardwareSerial:begin() changes RTS and CTS pins preventing detaching those pins Mar 8, 2024
@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Mar 8, 2024
@me-no-dev me-no-dev merged commit b92ad55 into master Mar 11, 2024
57 of 60 checks passed
@me-no-dev me-no-dev deleted the SuGlider-patch-1 branch March 11, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Peripheral: UART Status: Pending Merge Pull Request is ready to be merged
Projects
Development

Successfully merging this pull request may close these issues.

4 participants