LEDC: Add documentation of valid channels and shared timers#6638
Conversation
|
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)
WalkthroughDocumentation update to the LEDC output component ChangesLEDC Channel Configuration Documentation
Sequence DiagramsequenceDiagram
participant Docs
participant Reader
Docs->>Reader: displays variant-specific channel ranges
Docs->>Reader: explains adjacent-channel timer sharing and frequency constraints
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
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)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/components/output/ledc.mdx`:
- Around line 37-41: Replace the plain-text "Note: Two adjacent channels share
the same hardware timer..." paragraph with a GitHub-flavored alert block using
the GFM alert syntax (use "> [!NOTE]" as the first line), preserving the
existing content and inline code examples (e.g., `0`/`1`, `2`/`3`) and line
breaks so the note renders as an alert box in the MDX file; locate the paragraph
that starts with "Note: Two adjacent channels share the same hardware timer."
and convert it to the alert block format.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 194dde8b-5624-4a8d-9a1a-467d8df1944c
📒 Files selected for processing (1)
src/content/docs/components/output/ledc.mdx
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
RubenKelevra
force-pushed
the
ledc_channel_ranges_docs
branch
from
0ca227e to
8709220
Compare
This comment was marked as resolved.
This comment was marked as resolved.
✅ Actions performedFull review triggered. |
Different ESP32 hardware variants have different amounts of LEDC channels: 16, 8 or 6. Added a table to clarify this to the users. All ESP32 hardware variants have in common, that the LEDC channel pairs use a shared timer, which still allows different duty cycles and different phase settings, but not different frequencies for those two channels. Improved documentation of this. Also add a hidden MDX note for ESP32-H21 and ESP32-H4, for future reference when they become ESPHome-supported variants. 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
RubenKelevra
force-pushed
the
ledc_channel_ranges_docs
branch
from
8709220 to
1ac7558
Compare
|
Minor correction: Moved the phase angle config options up, so it doesn't hang so weirdly below the additional info about the channels. |
2 participants
Description
Different ESP32 hardware variants have different amounts of LEDC channels: 16, 8 or 6. Added a table to clarify this to the users.
All ESP32 hardware variants have in common, that the LEDC channel pairs use a shared timer, which still allows different duty cycles and different phase settings, but not different frequencies for those two channels. Improved documentation of this.
Also add a hidden MDX note for ESP32-H21 and ESP32-H4, for future reference when they become ESPHome-supported variants.
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
Checklist
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.