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

Added example to demonstrate using HardwareSerial with RS485 interfaces #8941

Merged
merged 10 commits into from
Dec 20, 2023

Conversation

econeale
Copy link
Contributor

Description of Change

This PR adds an example to the set of Serial examples that demonstrates how to use the HardwareSerial interface to communicate using RS485 hardware. The demo simply echos data received on one interface to the other.

Tests scenarios

I have tested with Adafruit Huzzah32 (ESP32) and Adafruit QT Py ESP32-S3 using a MAX33046E translation chip.

Related links

Addendum to #8934
Potentially related to #8755

@CLAassistant
Copy link

CLAassistant commented Nov 29, 2023

CLA assistant check
All committers have signed the CLA.

@SuGlider SuGlider self-assigned this Nov 29, 2023
@VojtechBartoska VojtechBartoska added Type: Example Issue is related to specific example. Status: Review needed Issue or PR is awaiting review labels Dec 1, 2023
econeale and others added 3 commits December 1, 2023 09:05
…o.ino

Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br>
…o.ino

Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br>
…o.ino

Co-authored-by: Lucas Saavedra Vaz <lucassvaz@yahoo.com.br>
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also remove this as it is already included by default.

@lucasssvaz lucasssvaz added Resolution: Awaiting response Waiting for response of author and removed Status: Review needed Issue or PR is awaiting review labels Dec 1, 2023
@VojtechBartoska
Copy link
Contributor

Hi @econeale, can you please update your PR up to the reviews? Thanks a lot!

Copy link
Contributor

github-actions bot commented Dec 12, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Added Serial as RS485 interface demo":
    • summary looks empty
    • type/action looks empty
  • the commit message "Added more detail to initial comment":
    • summary looks empty
    • type/action looks empty
  • the commit message "Removed HardwareSerial.h include. Switched RTS pin to GPIO 4 for broader compatability.":
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty
  • the commit message "Switched to UART_MODE definitions from uart_types.h in order to accomodate some versions of Arduino core":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update libraries/ESP32/examples/Serial/RS485_Echo_Demo/RS485_Echo_Demo.ino":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update libraries/ESP32/examples/Serial/RS485_Echo_Demo/RS485_Echo_Demo.ino":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update libraries/ESP32/examples/Serial/RS485_Echo_Demo/RS485_Echo_Demo.ino":
    • summary looks empty
    • type/action looks empty
  • the commit message "using 115200 for UART0 - console":
    • 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
  • 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).

⚠️ Please consider squashing your 10 commits (simplifying branch history).

👋 Hello econeale, 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 327fbbc

@lucasssvaz lucasssvaz added Status: Pending Merge Pull Request is ready to be merged and removed Resolution: Awaiting response Waiting for response of author labels Dec 12, 2023
@SuGlider
Copy link
Collaborator

@me-no-dev - this PR can also be merged.

@SuGlider SuGlider requested a review from me-no-dev December 20, 2023 14:05
@SuGlider SuGlider added this to the 3.0.0-RC1 milestone Dec 20, 2023
@me-no-dev me-no-dev merged commit 812a59a into espressif:master Dec 20, 2023
38 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 Type: Example Issue is related to specific example.
Projects
Development

Successfully merging this pull request may close these issues.

7 participants