esphome-docs/components/network.rst
Jimmy Hedman 3d2defde69
Document new parameter min_ipv6_addr_count and sub sensors for wifi_info and ethernet_info (#3234)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: ghsensdev <145111396+ghsensdev@users.noreply.github.com>
Co-authored-by: Daniel Baulig <me@danielbaulig.de>
2024-02-28 07:14:49 +13:00

31 lines
916 B
ReStructuredText

Network component
=================
.. seo::
:description:
:image: network-wifi.svg
:keywords: Network, WiFi, WLAN, Ethernet, ESP32
The network component is a global configuration for all types of
networks (WiFi, Ethernet).
.. code-block:: yaml
# Example configuration
network:
enable_ipv6: true
min_ipv6_addr_count: 2
Configuration variables:
------------------------
- **enable_ipv6** (*Optional*, boolean): Enables IPv6 support. Defaults to ``false``.
- **min_ipv6_addr_count** (*Optional*, integer): ESPHome considers the network to be connected when it has one IPv4 address and this number of IPv6 addresses. Defaults to ``0`` so as to not hang on boot with networks where IPv6 is not enabled. ``2`` is typically a reasonable value for configurations requiring IPv6.
See Also
--------
- :doc:`/components/wifi`
- :doc:`/components/ethernet`
- :ghedit:`Edit`