Skip to content

Add UART versions of main S3 builds #3173

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 1 commit into from
May 28, 2025
Merged

Add UART versions of main S3 builds #3173

merged 1 commit into from
May 28, 2025

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented May 28, 2025

Description

There are a number of new S3 development boards that only have a connection via a USB to serial chip. The current firmware is configured to work via the native USB connection which will not work for these boards.

This PR adds the following new targets:

ESP32_S3_BLE_UART
ESP32_S3_ALL_UART

Readme.md and Readme.zh_cn.md updated with new targets.

azure nightly updated to include new builds.

Motivation and Context

Discussed on discord

How Has This Been Tested?

Build tested locally but unable to test run as no S3 test board available with UART connection
Will be tested by users

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
    • Added support for two new ESP32_S3 board variants with UART connectivity: "ESP32_S3_BLE_UART" and "ESP32_S3_ALL_UART".
  • Documentation
    • Updated both English and Chinese README files to include the new board variants, along with version badges and links.
  • Chores
    • Enhanced build configuration to support the new ESP32_S3 UART board variants in automated pipelines.

Copy link

coderabbitai bot commented May 28, 2025

Walkthrough

Two new ESP32_S3 board variants, "ESP32_S3_BLE_UART" and "ESP32_S3_ALL_UART," were introduced. Updates include documentation in both English and Chinese READMEs, build matrix additions in the Azure Pipelines configuration, and new CMake configure/build presets for these targets. No other features or code changes were made.

Changes

File(s) Change Summary
README.md, README.zh-cn.md Added "ESP32_S3_BLE_UART" and "ESP32_S3_ALL_UART" to the ESP32_S3 boards table and version badges.
azure-pipelines-nightly.yml Added new build matrix entries for "ESP32_S3_BLE_UART" and "ESP32_S3_ALL_UART".
targets/ESP32/CMakePresets.json Added configure/build presets for "ESP32_S3_BLE_UART" and "ESP32_S3_ALL_UART".

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant CI Pipeline
    participant CMake
    participant Documentation

    Developer->>Documentation: Add ESP32_S3_BLE_UART/ALL_UART entries
    Developer->>CMake: Add new presets for BLE_UART/ALL_UART
    Developer->>CI Pipeline: Update build matrix with new targets
    CI Pipeline->>CMake: Build using new presets
    CI Pipeline->>Documentation: Publish new version badges
Loading

Possibly related PRs

  • Add generic screen to ESP32_S3 target #3054: The main PR adds new ESP32_S3 UART variants to the build matrix, README, and CMake presets, while the retrieved PR enhances existing ESP32_S3 presets with generic screen and graphics support; they modify overlapping files but focus on different target variants and features.

Suggested labels

Platform: ESP32, Series: ESP32S3


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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 (3)
README.md (2)

75-75: Fix table cell formatting

Add a space before the pipe to ensure proper Markdown column separation.

- | ESP32_S3_BLE_UART | Display, BLE, Quad spiram support, connection via UART| [![Latest Version @ Cloudsmith]
+ | ESP32_S3_BLE_UART | Display, BLE, Quad spiram support, connection via UART | [![Latest Version @ Cloudsmith]

77-77: Normalize table indentation

Use a single space before “Display” for consistency with other rows.

- | ESP32_S3_ALL_UART |  Display, BLE, Octal spiram support, connection via UART | [![Latest Version @ Cloudsmith]
+ | ESP32_S3_ALL_UART | Display, BLE, Octal spiram support, connection via UART | [![Latest Version @ Cloudsmith]
targets/ESP32/CMakePresets.json (1)

377-402: Configure presets correctly added

The ESP32_S3_BLE_UART configure preset inherits the common S3 settings and omits the USB CDC flag as intended. For clarity and to prevent default behavior, consider explicitly disabling USB CDC.

 "cacheVariables": {
     "TARGET_NAME": "${presetName}",
     "SDK_CONFIG_FILE": "sdkconfig.default_ble.esp32s3",
     "NF_BUILD_RTM": "OFF",
     "NF_FEATURE_DEBUGGER": "ON",
     "NF_FEATURE_RTC": "ON",
     "NF_FEATURE_HAS_SDCARD": "ON",
+    "ESP32_USB_CDC": "OFF",
     "API_nanoFramework.Device.OneWire": "ON",
     "API_nanoFramework.Device.Bluetooth": "ON",
     // ...
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 383659a and cb72798.

📒 Files selected for processing (4)
  • README.md (1 hunks)
  • README.zh-cn.md (1 hunks)
  • azure-pipelines-nightly.yml (1 hunks)
  • targets/ESP32/CMakePresets.json (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_ETHERNET_KIT_1.2)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_S3_ALL)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_H2_THREAD)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_C6_THREAD)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_C3)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_BLE_REV0)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_PSRAM_REV0)
  • GitHub Check: nf-interpreter (Check_Code_Style)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)
🔇 Additional comments (3)
README.zh-cn.md (1)

52-53: Entries correctly added for UART variants

The two new targets ESP32_S3_BLE_UART and ESP32_S3_ALL_UART have been appended to the Chinese README table, matching the English version and CI configuration.

azure-pipelines-nightly.yml (1)

535-543: New UART targets integrated into ESP32 build matrix

The ESP32_S3_BLE_UART and ESP32_S3_ALL_UART entries are correctly added to the nightly pipeline matrix, mirroring the existing BLE and ALL presets. Indentation, key names, and field ordering align with the surrounding ESP32 entries.

Also applies to: 544-552

targets/ESP32/CMakePresets.json (1)

1005-1010: Build presets added

The ESP32_S3_BLE_UART and ESP32_S3_ALL_UART build presets correctly inherit from base-user and reference the new configure presets. The naming and ordering are consistent with the existing build presets.

Also applies to: 1017-1022

@AdrianSoundy AdrianSoundy merged commit 1ff25da into main May 28, 2025
16 checks passed
@AdrianSoundy AdrianSoundy deleted the S3_ADD_WP_UART branch May 28, 2025 09:05
@josesimoes josesimoes added Platform: ESP32 Everything related specifically with ESP32 platform Series: ESP32S3 and removed Type: enhancement labels Jun 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants