mDNS component documentation (#1662)

Co-authored-by: webeling67 <61348455+webeling67@users.noreply.github.com>
This commit is contained in:
Oxan van Leeuwen 2021-11-25 20:59:02 +01:00 committed by GitHub
parent 3743d12c87
commit c263da4e86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 0 deletions

28
components/mdns.rst Normal file
View File

@ -0,0 +1,28 @@
mDNS Component
==============
.. seo::
:description: Instructions for setting up the mDNS configuration for your ESP node in ESPHome.
:image: mdns.svg
:keywords: WiFi, WLAN, ESP8266, ESP32, mDNS
The ``mdns`` component makes the node announce itself on the local network using the multicast DNS (mDNS) protocol.
Both Home Assistant and the ESPHome dashboard use mDNS to identify the IP address of all ESPHome nodes on the network.
If mDNS is disabled, they will no longer be able to automatically find your devices. It may be necessary to use a static
IP for all nodes and to enable the ping option in the Home Assistant add-on.
It is recommended to leave mDNS enabled.
.. code-block:: yaml
# Example configuration entry
mdns:
disabled: false
.. _mdns-configuration_variables:
Configuration variables:
------------------------
- **disabled** (*Optional*, boolean): Set to true to disable mDNS usage. Defaults to false.

1
images/radio-tower.svg Normal file
View File

@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M12,10A2,2 0 0,1 14,12C14,12.5 13.82,12.94 13.53,13.29L16.7,22H14.57L12,14.93L9.43,22H7.3L10.47,13.29C10.18,12.94 10,12.5 10,12A2,2 0 0,1 12,10M12,8A4,4 0 0,0 8,12C8,12.5 8.1,13 8.28,13.46L7.4,15.86C6.53,14.81 6,13.47 6,12A6,6 0 0,1 12,6A6,6 0 0,1 18,12C18,13.47 17.47,14.81 16.6,15.86L15.72,13.46C15.9,13 16,12.5 16,12A4,4 0 0,0 12,8M12,4A8,8 0 0,0 4,12C4,14.36 5,16.5 6.64,17.94L5.92,19.94C3.54,18.11 2,15.23 2,12A10,10 0 0,1 12,2A10,10 0 0,1 22,12C22,15.23 20.46,18.11 18.08,19.94L17.36,17.94C19,16.5 20,14.36 20,12A8,8 0 0,0 12,4Z" /></svg>

After

Width:  |  Height:  |  Size: 829 B

View File

@ -568,6 +568,7 @@ Misc Components
Remote Transmitter, components/remote_transmitter, remote.svg
Status LED, components/status_led, led-on.svg
HTTP Request, components/http_request, connection.svg
mDNS, components/mdns, radio-tower.svg
Time, components/time, clock-outline.svg
Sun, components/sun, weather-sunny.svg