[esp32] Add per-variant reference sections to ESP32 platform docs#6301
[esp32] Add per-variant reference sections to ESP32 platform docs#6301
Conversation
Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… Ethernet to all variants Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
jesserockz
left a comment
There was a problem hiding this comment.
Lets move these new sections between config and framework
Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
Done in 1f86341. The Variants section now sits between Configuration variables and Framework. |
There was a problem hiding this comment.
Pull request overview
Adds a new Variants reference section to the ESP32 platform documentation to provide per-chip guidance beyond the existing comma-separated variant list.
Changes:
- Added a new “Variants” section with subsections for each supported ESP32 variant.
- Documented key differentiators and a feature/peripheral summary per variant.
- Clarified Ethernet support expectations per variant (built-in MAC vs. SPI-based controllers).
You can also share your feedback on Copilot code review. Take the survey.
| ESPHome supports the following ESP32 variants. Use the `variant` configuration option to select the correct one | ||
| for your hardware. | ||
|
|
| - **CPU:** Xtensa LX7 single-core, up to 240 MHz | ||
| - **Wi-Fi:** 802.11 b/g/n 2.4 GHz | ||
| - **Bluetooth:** None | ||
| - **USB:** Native USB OTG (CDC/TinyUSB) |
There was a problem hiding this comment.
The OTG USB doesn't use TinyUSB and isn't restricted to CDC
| - **USB:** Native USB OTG (CDC/TinyUSB) | |
| - **USB:** Native USB OTG host mode (Full Speed); CDC/TinyUSB peripheral mode. |
| - **CPU:** Xtensa LX7 dual-core, up to 240 MHz | ||
| - **Wi-Fi:** 802.11 b/g/n 2.4 GHz | ||
| - **Bluetooth:** BLE 5.0 | ||
| - **USB:** Native USB OTG (CDC/TinyUSB) + USB Serial/JTAG |
There was a problem hiding this comment.
| - **USB:** Native USB OTG (CDC/TinyUSB) + USB Serial/JTAG | |
| - **USB:** Native USB OTG host mode (Full Speed); USB Serial/JTAG peripheral mode |
| - **CPU:** RISC-V HP dual-core @ up to 400 MHz + LP core @ up to 40 MHz | ||
| - **Wi-Fi:** None (requires co-processor via ESP-Hosted) | ||
| - **Bluetooth:** None (requires co-processor via ESP-Hosted) | ||
| - **USB:** Hi-Speed USB OTG (CDC/TinyUSB) + USB Serial/JTAG |
There was a problem hiding this comment.
| - **USB:** Hi-Speed USB OTG (CDC/TinyUSB) + USB Serial/JTAG | |
| - **USB:** Native USB OTG host mode (Full Speed + High Speed); USB Serial/JTAG peripheral mode |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
…uggestions Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
All three USB description suggestions from @clydebarrow applied in 7a58a2b. |
The ESP32 platform page listed supported variants only as a comma-separated string in the
variantconfig option, with no description of what each chip offers.Adds a Variants section near the top of the ESP32 platform page with a subsection for each of the 10 supported variants. Each entry includes:
Ethernet is listed for every variant: ESP32 and ESP32-P4 have a built-in Ethernet MAC (requiring an external PHY); all other variants note that only SPI-based Ethernet controllers are supported.
Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.