Skip to content

Conversation

tanakamasayuki
Copy link

Avoid compiler warnings(--warnings all)

Description

This PR adds explicit initialization of the user_filter_ctx member in TOUCH_SENSOR_DEFAULT_FILTER_CONFIG.

typedef

typedef struct {
uint32_t interval_ms; /*!< The software filter interval in milliseconds.
* The software filter will trigger periodically based on esp_timer
*/
touch_sw_filter_t data_filter_fn; /*!< The data filter function pointer.
* You can specify your own filter algorithm, or set NULL to use default software filter
*/
void *user_filter_ctx; /*!< User customized filter context pointer.
* This pointer will be passed to the second parameter of `touch_sw_filter_t` .
* So that users can access their customized filter context in the software filter function.
*/
} touch_sensor_filter_config_t;

Testing

code

#include <driver/touch_sens.h>

void setup()
{
    touch_sensor_filter_config_t filter_cfg = TOUCH_SENSOR_DEFAULT_FILTER_CONFIG();
}

void loop()
{
}

Sorry. It's Arduino.

Before modification

C:\Users\tanaka\AppData\Local\Arduino15\internal\esp32_esp32-arduino-libs_idf-release_v5.5-129cd0d2-v4_e318b1efcc\esp32/include/esp_driver_touch_sens/hw_ver1/include/driver/touch_version_types.h:58:1: warning: missing initializer for member 'touch_sensor_filter_config_t::user_filter_ctx' [-Wmissing-field-initializers]
   58 | }
      | ^
C:\tmp\vstest\touch_test\touch_test.ino:5:47: note: in expansion of macro 'TOUCH_SENSOR_DEFAULT_FILTER_CONFIG'
    5 |     touch_sensor_filter_config_t filter_cfg = TOUCH_SENSOR_DEFAULT_FILTER_CONFIG();
      |                                               ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
C:\tmp\vstest\touch_test\touch_test.ino:5:34: warning: unused variable 'filter_cfg' [-Wunused-variable]
    5 |     touch_sensor_filter_config_t filter_cfg = TOUCH_SENSOR_DEFAULT_FILTER_CONFIG();
      |                                  ^~~~~~~~~~

After modification

C:\tmp\vstest\touch_test\touch_test.ino:5:34: warning: unused variable 'filter_cfg' [-Wunused-variable]
    5 |     touch_sensor_filter_config_t filter_cfg = TOUCH_SENSOR_DEFAULT_FILTER_CONFIG();
      |                                  ^~~~~~~~~~

Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@CLAassistant
Copy link

CLAassistant commented Sep 25, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update default filter config macro for touch sensor":
    • 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 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).

👋 Hello tanakamasayuki, 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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 8b77615

@github-actions github-actions bot changed the title fix(touch_sens): Initialize user_filter_ctx in TOUCH_SENSOR_DEFAULT_FILTER_CONFIG to avoid compiler warning fix(touch_sens): Initialize user_filter_ctx in TOUCH_SENSOR_DEFAULT_FILTER_CONFIG to avoid compiler warning (IDFGH-16531) Sep 25, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Sep 25, 2025
@suda-morris suda-morris requested a review from L-KAYA September 25, 2025 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Opened Issue is new

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants