From 2585565483a3b282d02ed547d599031ab0f0a940 Mon Sep 17 00:00:00 2001 From: Suren Gabrielyan Date: Fri, 22 Mar 2024 11:57:24 +0400 Subject: [PATCH] fix(mdns): updated the document to clarify service advertisment prerequisite (IDFGH-6982) --- docs/mdns/en/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/mdns/en/index.rst b/docs/mdns/en/index.rst index 809bbaabd..d848d7cc0 100644 --- a/docs/mdns/en/index.rst +++ b/docs/mdns/en/index.rst @@ -39,7 +39,7 @@ Example method to start mDNS for the STA interface and set ``hostname`` and ``de mDNS Services ^^^^^^^^^^^^^ -mDNS can advertise information about network services that your device offers. Each service is defined by a few properties. (Please note Self-querying names is not supported in Espressif's mDNS library, a deliberate design choice to simplify implementation, preventing local network pollution and addressing WiFi multicast behavior) +mDNS can advertise information about network services that your device offers. Each service is defined by a few properties. * ``instance_name``: friendly name for your service, like ``Jhon's E{IDF_TARGET_NAME} Web Server``. If not defined, ``default_instance`` will be used. * ``service_type``: (required) service type, prepended with underscore. Some common types can be found `here `_. @@ -47,6 +47,10 @@ mDNS can advertise information about network services that your device offers. E * ``port``: (required) network port that the service runs on * ``txt``: ``{var, val}`` array of strings, used to define properties for your service +Please note: + 1. Self-querying names is not supported in Espressif's mDNS library, a deliberate design choice to simplify implementation, preventing local network pollution and addressing WiFi multicast behavior) + 2. Setting your own hostname is a prerequisite(mandatory) for advertising services or delegating other names. + Example method to add a few services and different properties:: void add_mdns_services()