Skip to content

Commit 1476388

Browse files
authored
Merge pull request #534 from gabsuren/mdns_docs
fix(mdns): updated the document to clarify service advertisment prerequisite (IDFGH-6982)
2 parents a5954dd + 2585565 commit 1476388

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/mdns/en/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,18 @@ Example method to start mDNS for the STA interface and set ``hostname`` and ``de
3939
mDNS Services
4040
^^^^^^^^^^^^^
4141

42-
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)
42+
mDNS can advertise information about network services that your device offers. Each service is defined by a few properties.
4343

4444
* ``instance_name``: friendly name for your service, like ``Jhon's E{IDF_TARGET_NAME} Web Server``. If not defined, ``default_instance`` will be used.
4545
* ``service_type``: (required) service type, prepended with underscore. Some common types can be found `here <http://www.dns-sd.org/serviceTypes.html>`_.
4646
* ``proto``: (required) protocol that the service runs on, prepended with underscore. Example: ``_tcp`` or ``_udp``
4747
* ``port``: (required) network port that the service runs on
4848
* ``txt``: ``{var, val}`` array of strings, used to define properties for your service
4949

50+
Please note:
51+
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)
52+
2. Setting your own hostname is a prerequisite(mandatory) for advertising services or delegating other names.
53+
5054
Example method to add a few services and different properties::
5155

5256
void add_mdns_services()

0 commit comments

Comments
 (0)