Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-26 22:21:38 +01:00
Code Issues Projects Releases Wiki Activity

Document new parameter min_ipv6_addr_count and sub sensors for wifi_info and ethernet_info (#3234)

Browse Source 
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>
This commit is contained in:
Jimmy Hedman 2024-02-27 19:14:49 +01:00 committed by GitHub
parent 23c23421aa
commit 3d2defde69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/network.rst
View File

@ -14,11 +14,13 @@ networks (WiFi, Ethernet).
# 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
--------

12
components/text_sensor/ethernet_info.rst
View File

@ -15,6 +15,16 @@ via text sensors.
- platform: ethernet_info
ip_address:
name: ESP IP Address
address_0:
name: ESP IP Address 0
address_1:
name: ESP IP Address 1
address_2:
name: ESP IP Address 2
address_3:
name: ESP IP Address 3
address_4:
name: ESP IP Address 4
Configuration variables:
@ -22,6 +32,8 @@ Configuration variables:
- **ip_address** (*Optional*): Expose the IP Address of the ESP as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **address_0-address_4** (*Optional*): With dual stack (IPv4 and IPv6) the device will have at least two IP addresses -- often more. To report all addresses the configuration may have up to five sub-sensors. All options from
:ref:`Text Sensor <config-text_sensor>`.
See Also
--------

12
components/text_sensor/wifi_info.rst
View File

@ -15,6 +15,16 @@ via text sensors.
- platform: wifi_info
ip_address:
name: ESP IP Address
address_0:
name: ESP IP Address 0
address_1:
name: ESP IP Address 1
address_2:
name: ESP IP Address 2
address_3:
name: ESP IP Address 3
address_4:
name: ESP IP Address 4
ssid:
name: ESP Connected SSID
bssid:
@ -31,6 +41,8 @@ Configuration variables:
- **ip_address** (*Optional*): Expose the IP Address of the ESP as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **address_0-address_4** (*Optional*): With dual stack (IPv4 and IPv6) the device will have at least two IP addresses -- often more. To report all addresses the configuration may have up to five sub-sensors. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **ssid** (*Optional*): Expose the SSID of the currently connected WiFi network as a text sensor. All options from
:ref:`Text Sensor <config-text_sensor>`.
- **bssid** (*Optional*): Expose the BSSID of the currently connected WiFi network as a text sensor. All options from