esphome-docs/components/network.rst
Götz Görisch b5d475d1af
doc: describe the IPv6 address generation (#3704)
* doc: describe the IPv6 address generation

* fixes https://github.com/esphome/issues/issues/5618

* Update network.rst

---------

Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
2024-03-21 20:24:15 +01:00

37 lines
1.5 KiB
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.
.. note::
The `lwIP <https://savannah.nongnu.org/projects/lwip/>`_ library used for the network component currently only implements IPv6 SLAAC according to `RFC4862 <https://datatracker.ietf.org/doc/rfc4862/>`_. The interface identifier (IID) is directly generated from the device MAC address.
This has various security and privacy implications decribed in `RFC7721 <https://datatracker.ietf.org/doc/rfc7721/>`_, as this might leak outside of the smart home network and makes the device uniquely identifiable.
Therefore, the address generation does not comply to `RFC7217 <https://datatracker.ietf.org/doc/rfc7217/>`_.
See Also
--------
- :doc:`/components/wifi`
- :doc:`/components/ethernet`
- :ghedit:`Edit`