CST328 Touchscreen #5188
CST328 Touchscreen #5188
Conversation
![esphome[bot]](https://avatars.githubusercontent.com/in/247347?s=60&v=4){kind=small}
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the ESPHome documentation from version 2025.7.4 to 2025.8.0-dev. The changes include several new component additions, documentation improvements, and version updates across multiple files.
- Addition of CST328 touchscreen controller documentation for Waveshare ESP32-S3 Touch LCD 2.8 board
- Introduction of new components including NRF52 platform support, runtime statistics, factory reset, and packet transport sensor/binary sensor
- Enhanced documentation for existing components with new features like MIPI DSI displays, ESP32 variant configuration, and LWIP optimization options
Reviewed Changes
Copilot reviewed 31 out of 36 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| components/touchscreen/cst328.rst | Complete documentation for new CST328 touchscreen controller |
| components/nrf52.rst | New platform documentation for NRF52 microcontrollers |
| components/runtime_stats.rst | New debugging component for performance analysis |
| components/factory_reset.rst | New component for device factory reset functionality |
| components/display/mipi_dsi.rst | New display driver documentation for MIPI DSI displays |
| guides/troubleshooting.rst | Added performance troubleshooting section with runtime_stats reference |
| components/esp32.rst | Enhanced documentation with variant-first configuration and LWIP options |
| components/sensor/index.rst | Added throttle_with_priority filter documentation |
| conf.py | Version bump to 2025.8.0-dev |
| multiple files | Various documentation improvements and version updates |
components/display/mipi_dsi.rst
Outdated
| - platform: mipi_dsi | ||
| model: WAVESHARE-P4-NANO-10.1 |
There was a problem hiding this comment.
The YAML example uses a list syntax for display configuration, but based on the context this should be a single display component, not a list. Remove the dash to make it a single component configuration.
| - platform: mipi_dsi | |
| model: WAVESHARE-P4-NANO-10.1 | |
| platform: mipi_dsi | |
| model: WAVESHARE-P4-NANO-10.1 |
Copilot uses AI. Check for mistakes.
components/esp32.rst
Outdated
| At least one of ``board`` or ``variant`` must be specified. If ``variant`` alone is specified (the recommended practice), | ||
| the board configuration will be automatically filled using a standard Espressif devkit board | ||
| suitable for that variant. Both may be specified (for backwards compatibility) but they must define the same variant. |
There was a problem hiding this comment.
[nitpick] The note explains that 'at least one of board or variant must be specified' but the documentation structure suggests variant is now the primary/recommended approach. Consider clarifying that variant is the preferred method and board is maintained for backwards compatibility.
| At least one of ``board`` or ``variant`` must be specified. If ``variant`` alone is specified (the recommended practice), | |
| the board configuration will be automatically filled using a standard Espressif devkit board | |
| suitable for that variant. Both may be specified (for backwards compatibility) but they must define the same variant. | |
| At least one of ``board`` or ``variant`` must be specified. ``variant`` is the preferred method for specifying the ESP32 configuration, | |
| as it provides a more streamlined and modern approach. If ``variant`` alone is specified (the recommended practice), | |
| the board configuration will be automatically filled using a standard Espressif devkit board suitable for that variant. | |
| ``board`` is maintained for backward compatibility and may be specified alongside ``variant`` if needed, but they must define the same variant. |
Copilot uses AI. Check for mistakes.
esphome
bot
dismissed
their stale review
Base branch has been corrected - dismissing previous review.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedFailed to post review comments. Configuration used: CodeRabbit UI ⛔ Files ignored due to path filters (5)
📒 Files selected for processing (31)
💤 Files with no reviewable changes (1)
🧰 Additional context used📓 Path-based instructions (1)**⚙️ CodeRabbit Configuration File
Files:
🧠 Learnings (5)📓 Common learningscomponents/esp32.rst (1)Learnt from: jesserockz guides/installing_esphome.rst (5)Learnt from: clydebarrow Learnt from: jesserockz Learnt from: jesserockz Learnt from: clydebarrow Learnt from: trip5 Makefile (3)Learnt from: jesserockz Learnt from: clydebarrow Learnt from: clydebarrow components/index.rst (1)Learnt from: jesserockz 🔇 Additional comments (28)
WalkthroughThis update introduces documentation and configuration support for the CST328 touchscreen controller, specifically targeting the Waveshare ESP32-S3 Touch LCD 2.8 board. A new documentation file for the CST328 is added, and the component index is updated to reflect this addition. No code or API changes are present. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Possibly related PRs
Suggested labels
Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Description:
Related issue (if applicable): fixes esphome/feature-requests#2895
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.