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

Add auto-detection feature to esp-println #1658

Merged
merged 4 commits into from
Jun 5, 2024

Conversation

bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Jun 5, 2024

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Description

Fixes #1576

Using the ROM function didn't work for me - buf_uart_no was always 0 for me but in general I think using SOF-interrupt-flag is a better way to do what we need here.

I also added a CHANGELOG.md for esp-println (but no CI checks for that in this PR)

Testing

Running the examples which use esp-println should print to UART or Serial-JTAG without reconfiguration (or re-compilation).

@bjoernQ bjoernQ added the skip-changelog No changelog modification needed label Jun 5, 2024
Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!
I left a very nitpick comment (sorry) I noticed while reading the docs. Feel free to ignore it.

esp-println/README.md Outdated Show resolved Hide resolved
Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

Thank you! I think checking the SoF interrupt is much nicer than the ROM function (I think the main reason I went with the ROM function in the stub is that eventually we will also have to detect USB OTG too).

Thanks for adding the changelog too. Would you mind adding esp-println to CI too? After that I think this is ready to go :).

Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

Thank you!

@MabezDev MabezDev enabled auto-merge June 5, 2024 10:36
@MabezDev MabezDev added this pull request to the merge queue Jun 5, 2024
Merged via the queue into esp-rs:main with commit f125c20 Jun 5, 2024
29 checks passed
@bjoernQ bjoernQ deleted the esp-println/autodetection branch November 26, 2024 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

esp-println: Add auto-detect feature
3 participants