Skip to content

Conversation

@lucasssvaz
Copy link
Member

@lucasssvaz lucasssvaz commented Dec 10, 2025

Description of Change

This pull request introduces improvements to resource management and reliability in the ESP I2S library and its related validation tests. The most important changes focus on preventing recursive calls and ensuring proper initialization and teardown of hardware interfaces, as well as refining test logic for I2C and GPIO peripherals.

I2S resource management improvements:

  • Added _mode initialization to I2SClass to indicate when I2S is not started, and updated i2sDetachBus to only call end() if I2S was initialized, preventing unnecessary resource cleanup. [1] [2]
  • Updated the end() method in I2SClass to prevent recursion by checking if already ended and resetting _mode before deinitializing pins, using the saved mode for cleanup logic. [1] [2]

Validation test reliability:

  • In periman.ino, ensured Serial1 is always properly initialized and its callback set during both setup and teardown, even if previous tests terminated the interface. [1] [2]
  • In gpio.ino, removed debounce logic and related variables from interrupt service routines and test setup, simplifying the interrupt handling for validation. [1] [2] [3]

I2C clock test enhancements:

  • Modified DS1307 RTC test logic to set the halt bit when writing seconds, and added a 5-second run/stop sequence to verify clock operation and time change. [1] [2]

General improvements:

  • Added missing #include <Arduino.h> in periman.ino for consistency and compatibility.

Test Scenarios

Locally

@lucasssvaz lucasssvaz self-assigned this Dec 10, 2025
@lucasssvaz lucasssvaz added the Type: CI & Testing Related to continuous integration, automated testing, or test infrastructure. label Dec 10, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello lucasssvaz, 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.
- 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 4551b70

@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2025

Test Results

 83 files   83 suites   25m 31s ⏱️
 55 tests  55 ✅ 0 💤 0 ❌
598 runs  598 ✅ 0 💤 0 ❌

Results for commit 4551b70.

♻️ This comment has been updated with latest results.

@lucasssvaz lucasssvaz changed the title ci(i2c): Make i2c test more reliable fix(tests): Fix GPIO and PeriMan tests Dec 10, 2025
@github-actions
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
ESP32C50⚠️ +260.00⚠️ +0.01000.000.00
ESP32P40⚠️ +360.00⚠️ +0.01000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C30⚠️ +260.00⚠️ +0.01000.000.00
ESP32C60⚠️ +260.00⚠️ +0.01000.000.00
ESP32H20⚠️ +260.00⚠️ +0.01000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32C5ESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP_I2S/examples/ES8388_loopback⚠️ +260⚠️ +260--00⚠️ +260⚠️ +260⚠️ +26000
libraries/ESP_I2S/examples/Simple_tone⚠️ +260⚠️ +260--00⚠️ +260⚠️ +260⚠️ +26000
tests/validation/gpio----------------
tests/validation/i2c_master----------------
tests/validation/periman----------------
libraries/ESP_I2S/examples/Record_to_WAV--⚠️ +260----------00
libraries/ESP_SR/examples/Basic--⚠️ +360------------

@lucasssvaz lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Dec 10, 2025
@lucasssvaz lucasssvaz merged commit b859bdf into espressif:master Dec 10, 2025
88 checks passed
@lucasssvaz lucasssvaz deleted the fix/i2c_test branch December 10, 2025 22:50
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: CI & Testing Related to continuous integration, automated testing, or test infrastructure.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants