Skip to content

Commit

Permalink
Added ESP32 C6 board info
Browse files Browse the repository at this point in the history
  • Loading branch information
paveldn committed Sep 19, 2024
1 parent 1d76ca8 commit 8a44840
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/workflows/examples.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- {main: esphome_climate_example.yaml, additional: "docs/examples/.base.yaml docs/examples/.uart.yaml"}
- {main: usb_s3.yaml, additional: ""}
- {main: usb_c3u.yaml, additional: ""}
- {main: usb_c6.yaml, additional: ""}
- {main: uart_sniffer.yaml, additional: ""}
steps:
- name: Checkout code
Expand Down
20 changes: 16 additions & 4 deletions docs/examples/usb_2_uart_boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ ESP32-S3 based boards

Currently, the following boards have native USB support and can communicate using UART protocol:

- `M5Stack AtomS3U <https://shop.m5stack.com/products/atoms3u>`_
- `Lilygo T-Dongle S3 <https://www.lilygo.cc/products/t-dongle-s3?variant=42455191519413>`_
- `M5Stamp ESP32S3 Module <https://shop.m5stack.com/products/m5stamp-esp32s3-module>`_ with USB-C to USB-A male adapter.
- `M5Stack AtomS3U <https://shop.m5stack.com/products/atoms3u>`_
- `Lilygo T-Dongle S3 <https://www.lilygo.cc/products/t-dongle-s3?variant=42455191519413>`_
- `M5Stamp ESP32S3 Module <https://shop.m5stack.com/products/m5stamp-esp32s3-module>`_ with USB-C to USB-A male adapter.

**Sample ESPHome Configuration that works for all this boards:**

Expand All @@ -22,8 +22,20 @@ ESP32-C3 based boards

Currently, only one board with ESP32-C3 confirmed that have native USB support and can communicate using UART protocol:

- `M5Stamp C3U (white color) <https://shop.m5stack.com/products/m5stamp-c3u-mate-with-pin-headers>`_ with USB-C to USB-A male adapter. **But be careful: M5Stamp C3 board (black color, without U at the end) have a dedicated chip for USB and can't be used for UART communication!**
- `M5Stamp C3U (white color) <https://shop.m5stack.com/products/m5stamp-c3u-mate-with-pin-headers>`_ with USB-C to USB-A male adapter. **But be careful: M5Stamp C3 board (black color, without U at the end) have a dedicated chip for USB and can't be used for UART communication!**

**Sample ESPHome Configuration that works for this board:**

.. example_yaml:: usb_c3u.yaml

ESP32-C6 based boards
---------------------

Curently ESP32-C6 based boards are not supported by platformio version that used by ESPHome. But it is posible to use it with custom platform and SDK version.
Curently, only confirmed board with ESP32-C6 that can be used for UART over USB communication:

- `M5Stack NanoC6 Dev Kit <https://shop.m5stack.com/products/m5stack-nanoc6-dev-kit>`_ with USB-C to USB-A male adapter.

**Sample ESPHome Configuration that works for this board:**

.. example_yaml:: usb_c6.yaml
30 changes: 30 additions & 0 deletions docs/examples/usb_c6.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
esphome:
name: haier

esp32:
board: esp32-c6-devkitc-1
variant: esp32c6
flash_size: 8MB
framework:
type: esp-idf
sdkconfig_options:
CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG: y
version: 5.3.1
platform_version: 6.8.1

wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password

uart:
baud_rate: 9600
tx_pin: 12
rx_pin: 13

logger:
level: WARN

climate:
- platform: haier
protocol: hon
name: Haier AC
52 changes: 48 additions & 4 deletions docs/usb_2_uart_boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ ESP32-S3 based boards

Currently, the following boards have native USB support and can communicate using UART protocol:

- `M5Stack AtomS3U <https://shop.m5stack.com/products/atoms3u>`_
- `Lilygo T-Dongle S3 <https://www.lilygo.cc/products/t-dongle-s3?variant=42455191519413>`_
- `M5Stamp ESP32S3 Module <https://shop.m5stack.com/products/m5stamp-esp32s3-module>`_ with USB-C to USB-A male adapter.
- `M5Stack AtomS3U <https://shop.m5stack.com/products/atoms3u>`_
- `Lilygo T-Dongle S3 <https://www.lilygo.cc/products/t-dongle-s3?variant=42455191519413>`_
- `M5Stamp ESP32S3 Module <https://shop.m5stack.com/products/m5stamp-esp32s3-module>`_ with USB-C to USB-A male adapter.

**Sample ESPHome Configuration that works for all this boards:**

Expand Down Expand Up @@ -53,7 +53,7 @@ ESP32-C3 based boards

Currently, only one board with ESP32-C3 confirmed that have native USB support and can communicate using UART protocol:

- `M5Stamp C3U (white color) <https://shop.m5stack.com/products/m5stamp-c3u-mate-with-pin-headers>`_ with USB-C to USB-A male adapter. **But be careful: M5Stamp C3 board (black color, without U at the end) have a dedicated chip for USB and can't be used for UART communication!**
- `M5Stamp C3U (white color) <https://shop.m5stack.com/products/m5stamp-c3u-mate-with-pin-headers>`_ with USB-C to USB-A male adapter. **But be careful: M5Stamp C3 board (black color, without U at the end) have a dedicated chip for USB and can't be used for UART communication!**

**Sample ESPHome Configuration that works for this board:**

Expand Down Expand Up @@ -85,3 +85,47 @@ Currently, only one board with ESP32-C3 confirmed that have native USB support a
- platform: haier
name: Haier AC
ESP32-C6 based boards
---------------------

Curently ESP32-C6 based boards are not supported by platformio version that used by ESPHome. But it is posible to use it with custom platform and SDK version.
Curently, only confirmed board with ESP32-C6 that can be used for UART over USB communication:

- `M5Stack NanoC6 Dev Kit <https://shop.m5stack.com/products/m5stack-nanoc6-dev-kit>`_ with USB-C to USB-A male adapter.

**Sample ESPHome Configuration that works for this board:**

.. code-block:: yaml
esphome:
name: haier
esp32:
board: esp32-c6-devkitc-1
variant: esp32c6
flash_size: 8MB
framework:
type: esp-idf
sdkconfig_options:
CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG: y
version: 5.3.1
platform_version: 6.8.1
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
uart:
baud_rate: 9600
tx_pin: 12
rx_pin: 13
logger:
level: WARN
climate:
- platform: haier
protocol: hon
name: Haier AC

0 comments on commit 8a44840

Please sign in to comment.