Optimise ESP32_S2 targets #3053
Conversation
WalkthroughThis pull request introduces updates to the documentation and build configurations for the .NET nanoFramework ESP32-S2 series boards. The changes involve renaming and adding new board configurations for ESP32-S2 USB and UART-based boards, removing previous entries for FEATHER_S2 and KALUGA_1, and updating the corresponding README files in English and Chinese. The modifications extend to Azure Pipeline configurations and CMake presets to support the new board configurations. Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
AdrianSoundy
force-pushed
the
Optimise_S2_targets
branch
from
18ef5a4 to
5cc7585
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
azure-pipelines-nightly.yml (1)
384-400: LGTM! Build pipeline structure maintained.The new ESP32_S2 configurations are properly integrated into the existing build matrix without disrupting the pipeline structure or build conditions.
Consider adding a comment in the matrix strategy section to document the ESP32_S2 target consolidation strategy for future maintainers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.md(2 hunks)README.zh-cn.md(2 hunks)azure-pipelines-nightly.yml(1 hunks)azure-pipelines.yml(0 hunks)targets/ESP32/CMakePresets.json(4 hunks)
💤 Files with no reviewable changes (1)
- azure-pipelines.yml
🚧 Files skipped from review as they are similar to previous changes (3)
- README.md
- targets/ESP32/CMakePresets.json
- README.zh-cn.md
🔇 Additional comments (1)
azure-pipelines-nightly.yml (1)
384-400: LGTM! Configuration aligns with target consolidation strategy.
The new ESP32_S2 target configurations properly implement the consolidation strategy, replacing board-specific targets with generic USB and UART variants.
Let's verify the removal of old configurations and consistency of the new ones:
✅ Verification successful
Configuration changes for ESP32_S2 targets are properly implemented
The new ESP32_S2_UART and ESP32_S2_USB configurations are correctly defined with consistent properties and proper target specifications. The old board-specific references (FEATHER_S2, KALUGA_1) have been successfully removed from the pipeline configuration, with only a documentation reference remaining in README.md to maintain backward compatibility information.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for any remaining references to old board names
rg -i "FEATHER_S2|KALUGA_1"
# Verify ESP32_S2 related CMake presets
fd -e yaml -e cmake "CMakePresets" -x rg -l "ESP32_S2"
Length of output: 461
Script:
#!/bin/bash
# Let's check for any references to the old board names in pipeline configurations
fd -e yml -e yaml pipeline -x rg -l "FEATHER_S2|KALUGA_1" {}
# Check CMakePresets.json for the new target configurations
fd CMakePresets.json -x cat {}
# Verify if there are any other pipeline files that might need similar updates
fd -e yml -e yaml pipeline -x rg -l "ESP32_S2" {}
Length of output: 66266
Script:
#!/bin/bash
# Let's check the azure-pipelines-nightly.yml file specifically for ESP32_S2 configurations
rg -A 5 -B 5 "ESP32_S2" azure-pipelines-nightly.yml
# Check for any other pipeline files that might contain old board configurations
fd -e yml -e yaml pipeline -x rg -l "KALUGA|FEATHER" {}
Length of output: 883
|
Simple enough changes for S2 targets as discussed in issue. Will just merge |
| @@ -803,7 +803,7 @@ | |||
| } | |||
| }, | |||
| { | |||
| "name": "FEATHER_S2", | |||
There was a problem hiding this comment.
This was brought in partnership with the Feather creator and they are advertising it on their docs, therefore I would like to keep distributing a firmware with this name. I understand that this will be the same, still...
josesimoes
added
Platform: ESP32
Description
Optimize the ESP32_S2 targets.
Instead of having specific targets for Feather_S2 and another for Espressif Kaluga_1 this change generalizes S2 firmware for the 2 main types of VS connection
ESP32_S2_USB ( formally Feather_S2)
ESP32_S2_UART( Formally Kaluga_1 )
The Kaluga firmware also had a specifc screen type include.
Both new firmware targets now have the generic graphic drivers added which will also work for Kaluga board.
As the S2 is no longer a current product these have been moved to the nightly builds.
Motivation and Context
How Has This Been Tested?
Built both firmware locally.
Tested ESP32_S2_UART on kaluga board.
Types of changes
Checklist
Summary by CodeRabbit
New Features
ESP32_S2_USBandESP32_S2_UART.Bug Fixes
FEATHER_S2andKALUGA_1from documentation.Chores