Ethernet Component

Edit this page on GitHub

Ethernet Component

This ESPHome component enables wired Ethernet connections for ESP32s.

Ethernet for ESP8266 is not supported.

This component and the Wi-Fi component may not be used simultaneously, even if both are physically available.

# Example configuration entry for RMII chips
ethernet:
  type: LAN8720
  mdc_pin: GPIOXX
  mdio_pin: GPIOXX
  clk:
    pin: GPIOXX
    mode: CLK_EXT_IN
  phy_addr: 0

  # Optional manual IP
  manual_ip:
    static_ip: 10.0.0.42
    gateway: 10.0.0.1
    subnet: 255.255.255.0
# Example configuration entry for SPI chips
ethernet:
  type: W5500
  clk_pin: GPIOXX
  mosi_pin: GPIOXX
  miso_pin: GPIOXX
  cs_pin: GPIOXX
  interrupt_pin: GPIOXX
  reset_pin: GPIOXX

Configuration variables

  • type (Required, string): The type of LAN chipset/phy.

    Supported chipsets are:

    • LAN8720 (RMII)
    • RTL8201 (RMII)
    • DP83848 (RMII)
    • IP101 (RMII)
    • JL1101 (RMII)
    • KSZ8081 (RMII)
    • KSZ8081RNA (RMII)
    • W5500 (SPI)
    • OPENETH (QEMU, ESP-IDF only)
    • DM9051 (SPI, ESP-IDF only)

RMII configuration variables

  • mdc_pin (Required, Pin): The MDC pin of the board. Usually this is GPIO23.

  • mdio_pin (Required, Pin): The MDIO pin of the board. Usually this is GPIO18.

  • clk (Required, mapping):

    • pin (Required, Pin): The RMII clock pin.

    • mode (Required, string): The clock mode of the data lines. See your board’s datasheet for more details. Must be one of the following values:

      • CLK_EXT_IN - External clock
      • CLK_OUT - Internal clock

  • phy_addr (Optional, int): The PHY addr type of the Ethernet controller. Defaults to 0.

  • phy_registers (Optional, mapping): Arbitrary PHY register values to set after Ethernet initialization.

    • address (Required, hex): The register address as a hex number (e.g. 0x10 for address 16)
    • value (Required, hex): The value of the register to set as a hex number (e.g. 0x1FFA )
    • page_id (Optional, hex): (RTL8201 only) Register page number to select before writing (e.g. 0x07 for page 7)

  • power_pin (Optional, Pin Schema): The pin controlling the power/reset status of the Ethernet controller. Leave unspecified for no power pin (default).

SPI configuration variables

  • clk_pin (Required, Pin): The SPI clock pin.

  • mosi_pin (Required, Pin): The SPI MOSI pin.

  • miso_pin (Required, Pin): The SPI MISO pin.

  • cs_pin (Required, Pin): The SPI chip select pin.

  • interrupt_pin (Optional, Pin): The interrupt pin. This variable is required for older frameworks. See below.

  • reset_pin (Optional, Pin): The reset pin.

  • clock_speed (Optional, float): The SPI clock speed. Any frequency between 8MHz and 80MHz is allowed, but the nearest integer division of 80MHz is used, i.e. 16MHz (80MHz / 5) is used when 15MHz is configured. Default: 26.67MHz.

  • polling_interval (Optional, Time): If interrupt_pin is not set, set the time interval for periodic polling. Minimum is 1ms, Defaults to 10ms. Older frameworks may not support this variable. See below for details.

If you are using a framework with the latest version, ESPHome provides an SPI-based Ethernet module without interrupt pin. Support for SPI polling mode (no interrupt pin) is provided by the following frameworks:

  • ESP-IDF 5.3 or later
  • ESP-IDF 5.2.1 and later 5.2.x versions
  • ESP-IDF 5.1.4
  • Arduino-ESP32 3.0.0 or later (Caution: PlatformIO does not support these Arduino-ESP32 versions)

When building with frameworks that support SPI polling mode, either interrupt_pin or polling_interval can be set. If you set both, ESPHome will throw an error.

If you are using a framework that does not support SPI-based ethernet modules without interrupt pin, interrupt_pin is required and you cannot set polling_interval.

Advanced common configuration variables

  • manual_ip (Optional): Manually configure the static IP of the node.

    • static_ip (Required, IPv4 address): The static IP of your node.
    • gateway (Required, IPv4 address): The gateway of the local network.
    • subnet (Required, IPv4 address): The subnet of the local network.
    • dns1 (Optional, IPv4 address): The main DNS server to use.
    • dns2 (Optional, IPv4 address): The backup DNS server to use.

  • use_address (Optional, string): Manually override what address to use to connect to the ESP. Defaults to auto-generated value. For example, if you have changed your static IP and want to flash OTA to the previously configured IP address.

  • domain (Optional, string): Set the domain of the node hostname used for uploading. For example, if it’s set to .local, all uploads will be sent to <HOSTNAME>.local. Defaults to .local.

  • mac_address (Optional, MAC Address): Set the MAC address of the ethernet interface.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • lldp (Optional): Configure and enable the Link Layer Discovery Protocol (IEEE 802.1AB) transmitter. The simplest useful configuration is lldp: {}, which enables transmission with the default settings.

    • port (Optional, string): Override the Port-ID TLV value (default: ETH_DEF, 128 character maximum).
    • system_name (Optional, string): Override the System Name TLV (defaults to the value of esphome.name, 128 character maximum).
    • system_description (Optional, string): Override the System Description TLV (default is the combination of esphome.project.name and esphome.project.version if these are set, otherwise of the form ESPHome.io <esphome-version> <board-name>, 128 character maximum).
    • tx_fast_count (Optional, int): number of packets to burst upon startup or reconnect (1-8, default 4)
    • tx_interval (Optional, int): interval, in seconds, to transmit LLDP frames (1-3600, default 30)
    • tx_hold (Optional, int): message hold value, used to calculate the LLDP time-to-live (1-100, default 4)

    The tx_fast_count, tx_interval and tx_hold defaults are the recommended default values from the LLDP standard, and should only need to be modified for advanced use cases.

    The TTL value is calculated from (tx_interval * tx_hold) + 1, limited to the protocol maximum of 65535 seconds. The calculated TTL will be output as part of the ethernet component configuration dump.

ℹ️ Note

If your Ethernet board is not designed with an ESP32 built in, it’s common to attempt to use flying leads, dupont wires, etc. to connect the Ethernet controller to the ESP32. This approach is likely to fail, however, as the Ethernet interface uses a high frequency clock signal that will not travel reliably over these types of connections. For more information and wiring details refer to the link in the See also section.

ℹ️ Note

SPI based chips do not use SPI Bus. This means that SPI pins can’t be shared with other devices.

Configuration examples

Olimex ESP32-POE:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO17
    mode: CLK_OUT
  phy_addr: 0
  power_pin: GPIO12

ℹ️ Note

WROVER version of Olimex POE cards change CLK to pin GPIO0.

Olimex ESP32-EVB:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 0

Olimex ESP32-GATEWAY and LILYGO TTGO T-Internet-POE ESP32-WROOM LAN8270A:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO17
    mode: CLK_OUT
  phy_addr: 0

LILYGO TTGO T-Internet ESP32-WROVER-E LAN8270:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO0
    mode: CLK_OUT
  phy_addr: 0
  power_pin: GPIO04

Wireless Tag WT32-ETH01 and SMLIGHT SLZB-06 PoE Zigbee:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 1
  power_pin: GPIO16

M5Stack PoESP32 and ESP32-Ethernet-Kit:

ethernet:
  type: IP101
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 1
  power_pin: GPIO5

AiThinker ESP32-G Gateway:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO17
    mode: CLK_OUT
  phy_addr: 1
  power_pin: GPIO5

wESP32:

# for board up to rev.5
ethernet:
  type: LAN8720
  mdc_pin: GPIO16
  mdio_pin: GPIO17
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 0

# for board rev.7 and up
ethernet:
  type: RTL8201
  mdc_pin: GPIO16
  mdio_pin: GPIO17
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 0
  phy_registers:
    - address: 0x10
      value: 0x1FFA
      page_id: 0x07

ℹ️ Note

Revision 5 and below of the wESP32 board use the LAN8720 Ethernet PHY. Revision 7 and newer of it use the RTL8201 Ethernet PHY.

OpenHacks LAN8720:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  phy_addr: 1

ℹ️ Note

This board has an issue that might cause the ESP32 to boot in program mode. When testing, make sure you are monitoring the serial output and reboot the device several times to see if it boots into the program properly.

Esp32-Stick-Eth and Esp32-Stick-PoE-P and Esp32-Stick-PoE-A:

ethernet:
  type: LAN8720
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO17
    mode: CLK_OUT
  phy_addr: 1

LILYGO T-ETH-Lite ESP32:

ethernet:
  type: RTL8201
  mdc_pin: GPIO23
  mdio_pin: GPIO18
  clk:
    pin: GPIO0
    mode: CLK_EXT_IN
  phy_addr: 0
  power_pin: GPIO12

QEMU qemu-system-xtensa:

ethernet:
  type: OPENETH

QEMU qemu-system-xtensa with LLDP enabled:

LLDP transmission enabled with default settings.

ethernet:
  type: OPENETH
  lldp: {}

Waveshare ESP32-S3-ETH PoE:

ethernet:
  type: W5500
  clk_pin: GPIO13
  mosi_pin: GPIO11
  miso_pin: GPIO12
  cs_pin: GPIO14
  interrupt_pin: GPIO10
  reset_pin: GPIO9

ETH01-Evo:

ethernet:
  type: DM9051
  clk_pin: GPIO07
  mosi_pin: GPIO10
  miso_pin: GPIO03
  cs_pin: GPIO09
  interrupt_pin: GPIO08
  reset_pin: GPIO06
  clock_speed: 8MHz

ℹ️ Note

Using a higher clock_speed, including default, might cause rx errors and dropped packets.

See Also

Ethernet Component

Edit this page on GitHub