Skip to content

feat(gpio): new functional interrupt lambda example #11589

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 7 commits into
base: master
Choose a base branch
from

Conversation

SuGlider
Copy link
Collaborator

Description:

This pull request introduces a comprehensive example for using lambda functions with FunctionalInterrupt in ESP32 GPIO interrupt handling. It includes both code and documentation updates to demonstrate advanced debouncing techniques, edge detection, and best practices for interrupt-safe lambda functions.

Code Enhancements:

  • Added a complete example in FunctionalInterruptLambda.ino showcasing two interrupt handling patterns:
    • CHANGE mode lambda for dual-edge detection with state-based debouncing and object method integration.
    • FALLING mode lambda with pointer captures, LED control, and hardware debouncing.

Documentation Updates:

  • Created a detailed README.md explaining:
    • The hardware setup and interrupt behavior on ESP32.
    • Lambda function patterns, debouncing strategies, and best practices for safe ISR handling.
    • Example outputs and expected behavior for the provided code.## Description of Change
      Please describe your proposed Pull Request and it's impact.

Tests scenarios

Tested using ESP32-S3 and the provided example

Related links

None

@SuGlider SuGlider added this to the 3.2.1 milestone Jul 12, 2025
@SuGlider SuGlider self-assigned this Jul 12, 2025
@SuGlider SuGlider requested a review from a team as a code owner July 12, 2025 21:06
@SuGlider SuGlider added Area: Peripherals API Relates to peripheral's APIs. Type: Example Issue is related to specific example. labels Jul 12, 2025
@SuGlider SuGlider moved this from Todo to In Progress in Arduino ESP32 Core Project Roadmap Jul 12, 2025
@SuGlider SuGlider requested a review from Copilot July 12, 2025 21:06
Copy link
Contributor

github-actions bot commented Jul 12, 2025

Messages
📖 🎉 Good Job! All checks are passing!

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

Copilot

This comment was marked as outdated.

@SuGlider SuGlider requested a review from Copilot July 12, 2025 21:33
Copilot

This comment was marked as outdated.

@SuGlider SuGlider requested a review from Copilot July 12, 2025 21:41
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a complete ESP32 GPIO interrupt example using lambda functions with the FunctionalInterrupt library, showcasing dual-edge and single-edge patterns with advanced debouncing.

  • Introduces a detailed README.md that explains hardware setup, lambda patterns, debouncing strategies, and best practices.
  • Adds FunctionalInterruptLambda.ino, demonstrating two interrupt handlers: a CHANGE-mode lambda with object method integration and a FALLING-mode lambda with pointer captures and LED control.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
libraries/ESP32/examples/GPIO/FunctionalInterruptLambda/README.md New example documentation detailing setup, patterns, and advice
libraries/ESP32/examples/GPIO/FunctionalInterruptLambda/FunctionalInterruptLambda.ino Arduino sketch with two lambda-based interrupt handlers and debouncing
Comments suppressed due to low confidence (3)

libraries/ESP32/examples/GPIO/FunctionalInterruptLambda/FunctionalInterruptLambda.ino:134

  • [nitpick] The variable name handlerPtr is generic—consider renaming it to buttonHandlerPtr or globalHandlerPtr to clarify that it references the button interrupt handler instance.
  InterruptHandler* handlerPtr = &globalHandler;

libraries/ESP32/examples/GPIO/FunctionalInterruptLambda/README.md:20

  • [nitpick] Consider adding a note that BOOT pin availability and pin number may vary between ESP32 board variants, and users should verify the correct pin definition (e.g., BOOT_PIN) for their board.
- Optionally connect a second button to BOOT pin for advanced examples

libraries/ESP32/examples/GPIO/FunctionalInterruptLambda/FunctionalInterruptLambda.ino:56

  • Using BOOT_PIN directly may cause a compilation error if BOOT_PIN is not defined for the target board. Consider adding a fallback definition, e.g., #ifndef BOOT_PIN / #define BOOT_PIN 0 / #endif, or document that BOOT_PIN must be defined.
#define BUTTON2_PIN     BOOT_PIN // BOOT BUTTON - change as needed

@SuGlider SuGlider moved this from In Progress to In Review in Arduino ESP32 Core Project Roadmap Jul 12, 2025
@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Jul 12, 2025
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
ESP32P4000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/ESP32/examples/GPIO/FunctionalInterruptLambda--------------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Peripherals API Relates to peripheral's APIs. Status: Review needed Issue or PR is awaiting review Type: Example Issue is related to specific example.
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

1 participant