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

feat(esp32/lcd/spi_lcd_touch):Adding driver for XPT2046 #15414

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

Conversation

qvd808
Copy link

@qvd808 qvd808 commented Feb 18, 2025

Description

  • Adding xpt2046 touch driver to lcd/spi_lcd_touch to support setting config for xpt2046 driver.
  • Modify Kconfig.projbuild to include options for LCD_TOUCH_CONTROLLER_XPT2046
  • Adding xpt2046 as dependency in idf_component.yml
  • Modify spi_lcd_touch_example_main.c to use XPT2046 driver if it is chosen

Related

Testing


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 Feb 18, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Feb 18, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update the version of idf_component.yml":
    • summary looks empty
    • type/action looks empty
  • the commit message "feat(esp32/lcd/spi_lcd_touch):Adding driver for XPT2046":
    • 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).

Messages
📖 You might consider squashing your 3 commits (simplifying branch history).

👋 Hello qvd808, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 963a50d

@espressif-bot espressif-bot added the Status: Opened Issue is new label Feb 18, 2025
@github-actions github-actions bot changed the title Adding driver for XPT2046 Adding driver for XPT2046 (IDFGH-14670) Feb 18, 2025
@qvd808 qvd808 changed the title Adding driver for XPT2046 (IDFGH-14670) feat(esp32/lcd/spi_lcd_touch):Adding driver for XPT2046 Feb 18, 2025
@suda-morris
Copy link
Collaborator

Hi @qvd808 Thanks for the contribution. Please fix the pre-commit errors: https://github.com/espressif/esp-idf/actions/runs/13386255248/job/37440111031?pr=15414

You can run the pre-commit locally: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/contribute/install-pre-commit-hook.html

@@ -125,8 +129,8 @@ static void example_lvgl_flush_cb(lv_display_t *disp, const lv_area_t *area, uin
esp_lcd_panel_draw_bitmap(panel_handle, offsetx1, offsety1, offsetx2 + 1, offsety2 + 1, px_map);
}

#if CONFIG_EXAMPLE_LCD_TOUCH_ENABLED
static void example_lvgl_touch_cb(lv_indev_t * indev, lv_indev_data_t * data)
#ifdef CONFIG_EXAMPLE_LCD_TOUCH_CONTROLLER_STMPE610

Choose a reason for hiding this comment

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

This condition check can be reverted as the two versions of example_lvgl_touch_cb are identical. The APIs are common so we can simplify the logic here.

@@ -145,6 +149,29 @@ static void example_lvgl_touch_cb(lv_indev_t * indev, lv_indev_data_t * data)
data->state = LV_INDEV_STATE_RELEASED;
}
}
#elif CONFIG_EXAMPLE_LCD_TOUCH_CONTROLLER_XPT2046

Choose a reason for hiding this comment

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

as noted above, this block can be dropped

.swap_xy = 0,
.mirror_x = 0,
.mirror_y = 0,
.mirror_y = 1,

Choose a reason for hiding this comment

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

is there a specific need to change this entry? Is it specific to XPT2046? If so, it likely would be best to move this (or other entries) into the Kconfig.projbuild and set them based on the selected touch controller

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.

5 participants