Skip to content

Add generic screen to ESP32_S3 target #3054

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

Merged
merged 3 commits into from
Dec 19, 2024

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Dec 18, 2024

Description

Add generic screen to ESP32_S3 target

The ESP32_S3 target can be used for ESP32_S3 targets without any PSRAM. i.e M5STACK devices.

Motivation and Context

From discord discussion
https://discord.com/channels/478725473862549535/1318854127429881866

How Has This Been Tested?

Build tested locally

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features

    • Enhanced descriptions for ESP32_S3, ESP32_S3_BLE, and ESP32_S3_ALL boards in the documentation, highlighting improved graphical capabilities.
    • Added support for graphics-related features across multiple ESP32 presets.
  • Documentation

    • Updated README.md with more detailed descriptions of ESP32 boards and their functionalities.
  • Chores

    • Modified configuration presets to include new graphics-related cache variables for various ESP32 targets.

Copy link

coderabbitai bot commented Dec 18, 2024

Walkthrough

The pull request introduces updates to the README.md file and CMakePresets.json for ESP32 targets, focusing on enhancing the documentation and configuration for graphics capabilities. The changes primarily involve updating board descriptions in the README to reflect new display and spiram support, and adding graphics-related cache variables to multiple configuration presets across different ESP32 board configurations.

Changes

File Change Summary
README.md - Updated ESP32_S3 description to include "Display & Quad spiram support"
- Updated ESP32_S3_BLE description to include "Display, BLE, Quad spiram support"
- Updated ESP32_S3_ALL description to include "Display, BLE, Octal spiram support"
targets/ESP32/CMakePresets.json - Added API_nanoFramework.Graphics: "ON" to presets ESP32_PSRAM_REV3_IPV6, ESP32_S3, ESP32_S3_BLE, and ESP32_S3_ALL
- Added graphics-related cache variables (GRAPHICS_DISPLAY, TOUCHPANEL_DEVICE, GRAPHICS_DISPLAY_INTERFACE, TOUCHPANEL_INTERFACE) to the same presets

Possibly related PRs

  • Add Generic display to ESP32_S3_BLE #2946: Adds a generic display driver to the ESP32_S3_BLE, which is directly related to the enhancements in display capabilities mentioned in the main PR.
  • README improvements #2948: Includes improvements to the README.md for various ESP32 boards, aligning with the updates made in the main PR regarding the descriptions of these boards.

Suggested labels

Type: documentation


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ba9892 and c83ffc1.

📒 Files selected for processing (1)
  • targets/ESP32/CMakePresets.json (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • targets/ESP32/CMakePresets.json

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
targets/ESP32/CMakePresets.json (2)

341-346: Consider adding SPIRAM allocation for graphics support

While the graphics configuration is correct, consider adding ESP32_SPIRAM_FOR_IDF_ALLOCATION like other boards with display support to ensure sufficient memory for graphics operations.

 "ESP32_USB_CDC": "ON",
 "API_nanoFramework.Graphics": "ON",
 "GRAPHICS_DISPLAY": "Generic_SPI.cpp",
 "TOUCHPANEL_DEVICE": "XPT2046.cpp",
 "GRAPHICS_DISPLAY_INTERFACE": "Spi_To_Display.cpp",
-"TOUCHPANEL_INTERFACE": "Spi_To_TouchPanel.cpp"
+"TOUCHPANEL_INTERFACE": "Spi_To_TouchPanel.cpp",
+"ESP32_SPIRAM_FOR_IDF_ALLOCATION": "1024 * 1024"

341-346: LGTM: Consistent graphics configuration across ESP32_S3 variants

The graphics configuration is consistently applied across all ESP32_S3 variants (base, BLE, and ALL), with appropriate SPIRAM allocation in the BLE and ALL variants. This implementation aligns well with the PR objective of adding generic screen support for M5STACK devices.

The consistent use of Generic_SPI.cpp display driver across variants provides good flexibility for different screen types while maintaining a unified codebase.

Also applies to: 359-367, 385-393

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe7deac and 5ba9892.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • targets/ESP32/CMakePresets.json (2 hunks)
🔇 Additional comments (3)
README.md (1)

73-73: LGTM: Board descriptions accurately reflect display capabilities

The updated descriptions for ESP32_S3 boards clearly indicate the addition of display support while maintaining consistency with existing documentation style.

targets/ESP32/CMakePresets.json (2)

Line range hint 83-87: LGTM: Graphics configuration matches established patterns

The graphics configuration follows the same pattern used in other ESP32 boards with display support, using appropriate display and touchpanel drivers.


341-346: Verify display driver implementation

The configuration references Generic_SPI.cpp and XPT2046.cpp. Let's verify these files are available in the codebase.

✅ Verification successful

All required display and touchpanel driver files are present

The verification confirms that all referenced files exist in the codebase:

  • Display drivers:
    • src/nanoFramework.Graphics/Graphics/Displays/Generic_SPI.cpp
    • src/nanoFramework.Graphics/Graphics/Displays/Spi_To_Display.cpp
  • Touch panel drivers:
    • src/nanoFramework.Graphics/TouchPanel/Devices/XPT2046.cpp
    • targets/ESP32/ESP32/nanoCLR/nanoFramework.Graphics/Spi_To_TouchPanel.cpp (and variants for other ESP32 targets)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for display and touchpanel driver files
echo "Checking for display driver files..."
fd "Generic_SPI.cpp|XPT2046.cpp|Spi_To_Display.cpp|Spi_To_TouchPanel.cpp"

Length of output: 735

@AdrianSoundy AdrianSoundy merged commit 8bf7b95 into nanoframework:main Dec 19, 2024
18 checks passed
@AdrianSoundy AdrianSoundy deleted the Update_ESP32_S3 branch December 19, 2024 00:31
@coderabbitai coderabbitai bot mentioned this pull request Dec 19, 2024
13 tasks
@josesimoes josesimoes added Platform: ESP32 Everything related specifically with ESP32 platform Series: ESP32S3 and removed Type: enhancement labels Dec 19, 2024
@coderabbitai coderabbitai bot mentioned this pull request May 28, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Config-and-Build Platform: ESP32 Everything related specifically with ESP32 platform Series: ESP32S3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants