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

Add initial docs for mdns extensions (#2553)

Browse Source
This commit is contained in:
Joakim Plate 2023-02-02 05:19:00 +01:00 committed by GitHub
parent 0446eacc14
commit 703aada7da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
components/mdns.rst
View File

@ -22,7 +22,33 @@ It is recommended to leave mDNS enabled.
.. _mdns-configuration_variables:
Services:
---------
Additional mdns services can be added as exposed by the esphome node.
.. code-block:: yaml
# Example configuration entry with additional service
mdns:
services:
- service: "_custom_service"
protocol: "_tcp"
port: 8080
txt:
txt_key_1: txt_value_1
.. _mdns-custom_services:
Configuration variables:
------------------------
- **disabled** (*Optional*, boolean): Set to true to disable mDNS usage. Defaults to false.
- **services** (*Optional*, list): List of additional services to expose.
- **service** (*Required*, string): Name of extra service
- **protocol** (*Required*, string): Protocol of service (_udp or _tcp)
- **port** (*Optional*, int): Port number of extra service
- **txt** (*Optional*, mapping): Additional text records to add to service