Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-08-18 06:35:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'fix_docs_idf15383' into 'master'

Browse Source 
docs(networking): Adds examples references to documentation

Closes IDF-15383

See merge request espressif/esp-idf!47892
This commit is contained in:
Euripedes Rocha
2026-04-28 09:03:14 +02:00
parent b1d68624e1 2183c77afd
commit b5528ba3b3
6 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/protocols/icmp_echo.rst
View File

@@ -114,6 +114,8 @@ Application Examples
- :example:`protocols/icmp_echo` demonstrates how to implement a simple ping command line utility to test if a remote host is reachable on the IP network, using ICMP echo request packets.
- :example:`protocols/icmp/pmtu_probe` demonstrates how to probe path MTU with ICMP echo requests and apply the result to the active interface using :cpp:func:`esp_netif_set_mtu`.
API Reference
-------------

2
docs/en/api-reference/protocols/mbedtls.rst
View File

@@ -176,6 +176,8 @@ Refer to the examples :example:`protocols/https_server/simple` (simple HTTPS ser
If you plan to use the Mbed TLS API directly, refer to the example :example:`protocols/https_mbedtls`. This example demonstrates how to establish an HTTPS connection using Mbed TLS by setting up a secure socket with a certificate bundle for verification.
The example :example:`protocols/smtp_client` sends email (including attachments) over SMTP with STARTTLS using the Mbed TLS APIs.
Important Config Options
------------------------

4
docs/en/api-reference/protocols/mqtt.rst
View File

@@ -26,13 +26,13 @@ Application Examples
Two reference examples are available in ESP-IDF:
- MQTT over TLS (certificate bundle): ``examples/protocols/mqtt``
- MQTT over TLS (certificate bundle): :example:`protocols/mqtt`
- Validates the broker with ESP-IDF's certificate bundle (default).
- Default broker URI targets ``mqtts://test.mosquitto.org:8886`` (Let's Encrypt chain).
- Alternative configuration pins Mosquitto CA and uses ``mqtts://test.mosquitto.org:8883``.
- MQTT 5.0 over TLS (certificate bundle): ``examples/protocols/mqtt5``
- MQTT 5.0 over TLS (certificate bundle): :example:`protocols/mqtt5`
- Uses MQTT v5.0 with TLS and validation via the certificate bundle.
- Default broker URI targets ``mqtts://test.mosquitto.org:8886``.