Skip to content

[esp32] Add per-variant reference sections to ESP32 platform docs#6301

Draft
Copilot wants to merge 7 commits intocurrentfrom
copilot/add-esp32-variant-sections
Draft

[esp32] Add per-variant reference sections to ESP32 platform docs#6301
Copilot wants to merge 7 commits intocurrentfrom
copilot/add-esp32-variant-sections

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

The ESP32 platform page listed supported variants only as a comma-separated string in the variant config 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:

  • Short prose description (positioning, key differentiators)
  • Feature bullet list: CPU architecture/speed, Wi-Fi standard, Bluetooth/BLE version, 802.15.4 support, USB type, Ethernet support, GPIO count, peripheral counts (UART/I2C/SPI/I2S), ADC/DAC channels
  • Notable capabilities called out where relevant (built-in Ethernet MAC, AI vector instructions, MIPI DSI/CSI, capacitive touch, LP coprocessor)

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

This section details on the original issue you should resolve

<issue_title>Add sections for each ESP32 variant on the ESP32 documentation</issue_title>
<issue_description>Have a section on the ESP32 documentation with a small description and feature list for each supported variant.</issue_description>

<agent_instructions>Create a header for each variant on the esp32 platform page that has a short description of the variant, and a bullet list of the features it has, wifi, bluetooth, ble, usb cdc/tinyusb, number of spi, uart, i2c etc</agent_instructions>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
@netlify
Copy link

netlify bot commented Mar 18, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit eaf6626
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69bbce2652eaa200080044f9
😎 Deploy Preview https://deploy-preview-6301--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI changed the title [WIP] Add sections for each ESP32 variant on documentation [esp32] Add per-variant reference sections to ESP32 platform docs Mar 18, 2026
@esphome esphome bot added the current label Mar 18, 2026
Copilot AI requested a review from jesserockz March 18, 2026 19:00
… Ethernet to all variants

Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
Copilot AI requested a review from jesserockz March 18, 2026 19:14
Copy link
Member

@jesserockz jesserockz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets move these new sections between config and framework

Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 18, 2026

Lets move these new sections between config and framework

Done in 1f86341. The Variants section now sits between Configuration variables and Framework.

Copilot AI requested a review from jesserockz March 18, 2026 23:00
@jesserockz jesserockz marked this pull request as ready for review March 18, 2026 23:36
Copilot AI review requested due to automatic review settings March 18, 2026 23:36
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +44 to +46
ESPHome supports the following ESP32 variants. Use the `variant` configuration option to select the correct one
for your hardware.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
- **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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OTG USB doesn't use TinyUSB and isn't restricted to CDC

Suggested change
- **USB:** Native USB OTG (CDC/TinyUSB)
- **USB:** Native USB OTG host mode (Full Speed); CDC/TinyUSB peripheral mode.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied in 7a58a2b.

- **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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **USB:** Native USB OTG (CDC/TinyUSB) + USB Serial/JTAG
- **USB:** Native USB OTG host mode (Full Speed); USB Serial/JTAG peripheral mode

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied in 7a58a2b.

- **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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied in 7a58a2b.

Copy link
Member

@jesserockz jesserockz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the suggestions above

@esphome esphome bot marked this pull request as draft March 19, 2026 07:18
@esphome
Copy link

esphome bot commented Mar 19, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

…uggestions

Co-authored-by: jesserockz <3060199+jesserockz@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 19, 2026

See the suggestions above

All three USB description suggestions from @clydebarrow applied in 7a58a2b.

Copilot AI requested a review from jesserockz March 19, 2026 07:20
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.

Add sections for each ESP32 variant on the ESP32 documentation

6 participants