Document 14 bit LEDC restriction for ESP32-S2/S3/C2/C3#6634
Merged
Conversation
The ESP32-S2, ESP32-S3, ESP32-C2 and ESP32-C3 only support a 14 bit LEDC timer, while the other ESP32 variants supported by ESPHome feature a 20 bit LEDC timer. This leads to the 14 bit timer variants being missrepresented in the docs, as being more capable than they are. I've also included a hidden MDX note for the not yet supported ESP32-H21 and ESP32-H4, for future reference. References: https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32s2/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32s3/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c2/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c3/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c5/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c6/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c61/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32h2/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32p4/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h21/include/soc/soc_caps.h https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h4/include/soc/soc_caps.h
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis pull request updates the LEDC output component documentation for ESP32 devices. The recommended frequencies table now includes variant-specific annotations clarifying which hardware configurations support different bit-depth timers, with footnote text distinguishing 14-bit and 20-bit LEDC timer support across ESP32 variants. ChangesLEDC Frequency Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The ESP32-S2, ESP32-S3, ESP32-C2 and ESP32-C3 only support a 14 bit LEDC timer, while the other ESP32 variants supported by ESPHome feature a 20 bit LEDC timer. This leads to the 14 bit timer variants being missrepresented in the docs, as being more capable than they are.
I've also included a hidden MDX note for the not yet supported ESP32-H21 and ESP32-H4, for future reference.
References:
Details
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32s2/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32s3/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c2/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c3/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c5/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c6/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32c61/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32h2/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/v5.5.3/components/soc/esp32p4/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h21/include/soc/soc_caps.h
https://github.com/espressif/esp-idf/blob/master/components/soc/esp32h4/include/soc/soc_caps.h
Checklist
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.