Add docs for IP101 support (#2250)

This commit is contained in:
Keith Burzinski 2022-08-30 20:45:35 -05:00 committed by GitHub
parent c588816013
commit 3907214daf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 14 deletions

View File

@ -6,9 +6,11 @@ Ethernet Component
:image: ethernet.svg :image: ethernet.svg
:keywords: Ethernet, ESP32 :keywords: Ethernet, ESP32
This core ESPHome component sets up ethernet connections for ESP32s. This ESPHome component enables *wired* Ethernet connections for ESP32s.
Ethernet for ESP8266 is not supported. Ethernet for ESP8266 is not supported.
This component can't be used in same time than Wifi one, even if your ESP32 has both wired.
This component and the Wi-Fi component may **not** be used simultaneously, even if both are physically available.
.. code-block:: yaml .. code-block:: yaml
@ -29,24 +31,23 @@ This component can't be used in same time than Wifi one, even if your ESP32 has
Configuration variables: Configuration variables:
------------------------ ------------------------
- **type** (**Required**, string): The type of LAN chipset. Must be one of - **type** (**Required**, string): The type of LAN chipset/phy. Must be one of
``LAN8720`` or ``TLK110`` (see datasheet for more details). ``LAN8720``, ``TLK110`` or ``IP101`` (see datasheet for more details).
- **mdc_pin** (**Required**, :ref:`config-pin`): The MDC pin of the board. - **mdc_pin** (**Required**, :ref:`config-pin`): The MDC pin of the board.
Usually this is ``GPIO23``. Usually this is ``GPIO23``.
- **mdio_pin** (**Required**, :ref:`config-pin`): The MDIO pin of the board. - **mdio_pin** (**Required**, :ref:`config-pin`): The MDIO pin of the board.
Usually this is ``GPIO18``. Usually this is ``GPIO18``.
- **clk_mode** (*Optional*, string): The clock mode of the data lines, this must be one - **clk_mode** (*Optional*, string): The clock mode of the data lines. See your board's
of these values: (see datasheet of your board for more details) datasheet for more details. Must be one of the following values:
- ``GPIO0_IN`` (Default) - External clock - ``GPIO0_IN`` (Default) - External clock
- ``GPIO0_OUT`` - Internal clock - ``GPIO0_OUT`` - Internal clock
- ``GPIO16_OUT`` - Internal clock - ``GPIO16_OUT`` - Internal clock
- ``GPIO17_OUT`` - Internal clock - ``GPIO17_OUT`` - Internal clock
- **phy_addr** (*Optional*, int): The PHY addr type of the ethernet controller. Defaults to 0. - **phy_addr** (*Optional*, int): The PHY addr type of the Ethernet controller. Defaults to 0.
- **power_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin with which - **power_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin controlling the
to control the power of the board. Leave unspecified for no power pin (default) power/reset status of the Ethernet controller. Leave unspecified for no power pin (default).
- **manual_ip** (*Optional*): Manually configure the static IP of the node. - **manual_ip** (*Optional*): Manually configure the static IP of the node.
- **static_ip** (**Required**, IPv4 address): The static IP of your node. - **static_ip** (**Required**, IPv4 address): The static IP of your node.
@ -66,9 +67,10 @@ Configuration variables:
.. note:: .. note::
If your ethernet board is not designed with an ESP32 built in, chances are that you are going 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 to the ESP32. This is to use flying leads, dupont wires, etc. to connect the Ethernet controller to the ESP32.
probably to fail as the ethernet interface uses a high frequency clock signal. For more 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. information and wiring details refer to the link in the *See also* section.
Configuration for Olimex ESP32-POE Configuration for Olimex ESP32-POE
@ -151,7 +153,7 @@ Configuration for OpenHacks LAN8720
program properly. program properly.
Configuration for wESP32 board (up to rev.6) Configuration for wESP32 board (up to rev.6)
------------------------------------------------- --------------------------------------------
.. code-block:: yaml .. code-block:: yaml
@ -167,6 +169,19 @@ Configuration for wESP32 board (up to rev.6)
Revision 7 and upwards of the wESP32 board does not have a LAN8720 chip. Until support for the Revision 7 and upwards of the wESP32 board does not have a LAN8720 chip. Until support for the
replacement RTL8201 is included in ESPHome, the wESP board rev.7 will not work with the above configuration. replacement RTL8201 is included in ESPHome, the wESP board rev.7 will not work with the above configuration.
Configuration for ESP32-Ethernet-Kit board
------------------------------------------
.. code-block:: yaml
ethernet:
type: IP101
mdc_pin: GPIO23
mdio_pin: GPIO18
clk_mode: GPIO0_IN
phy_addr: 1
power_pin: GPIO5
See Also See Also
-------- --------