Skip to content

Fix(I2S example): make fix to the ESP32 I2S simple tone example #10954

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

greenyleaf
Copy link

@greenyleaf greenyleaf commented Feb 10, 2025

Fixed a problem in the I2S tone example.


Description of Change

Did some fix so that the tone example could play normally on ESP32 boards with an I2S decoder attached.

Tests scenarios

Tested the Pull Request on Arduino-esp32 core v3.1.0 with ESP32 and ESP32-S3 Boards with this scenario.

@CLAassistant
Copy link

CLAassistant commented Feb 10, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Feb 10, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "edit comment":
    • summary looks empty
    • type/action looks empty
  • the commit message "edit the I2S - simple tone example":
    • summary looks empty
    • type/action looks empty
  • the commit message "edit the I2S - simple tone example":
    • summary looks empty
    • type/action looks empty
  • the commit message "made some fix to the ESP32 I2S simple tone example":
    • summary looks empty
    • type/action looks empty
  • the commit message "some edit":
    • 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 10 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 greenyleaf, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for 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 d9f0be0

@me-no-dev me-no-dev added the Status: Test needed Issue needs testing label Feb 13, 2025
@greenyleaf
Copy link
Author

How to accomplish the requirement of the 'Test needed' tag?

@me-no-dev
Copy link
Member

@greenyleaf we will test it and comment. No worries

Copy link
Contributor

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
ESP32P40⚠️ +860.00⚠️ +0.02000.000.00
ESP32S30⚠️ +440.00⚠️ +0.01000.000.00
ESP32S20⚠️ +440.00⚠️ +0.02000.000.00
ESP32C30⚠️ +900.00⚠️ +0.03000.000.00
ESP32C60⚠️ +920.00⚠️ +0.03000.000.00
ESP32H20⚠️ +900.00⚠️ +0.03000.000.00
ESP320⚠️ +520.00⚠️ +0.02000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP_I2S/examples/Simple_tone⚠️ +860⚠️ +440⚠️ +440⚠️ +900⚠️ +920⚠️ +900⚠️ +520

@greenyleaf greenyleaf changed the title made fix to the ESP32 I2S simple tone example Fix(I2S sample): make fix to the ESP32 I2S simple tone example Apr 22, 2025
@greenyleaf greenyleaf changed the title Fix(I2S sample): make fix to the ESP32 I2S simple tone example Fix(I2S example): make fix to the ESP32 I2S simple tone example Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Test needed Issue needs testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants