alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 04:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update application examples for modbus.rst, mqtt.rst and lwip.rst

Browse Source
This commit is contained in:
Linda
2024-09-20 12:17:36 +08:00
committed by BOT
parent 93de26537c
commit 4d7436f861
10 changed files with 101 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -109,10 +109,10 @@ Get Runtime Statistics
As the example code above, you can call ``esp_ping_get_profile`` to get different runtime statistics of ping session in the callback function.
Application Example
-------------------
Application Examples
--------------------
ICMP echo example: :example:`protocols/icmp_echo`
- :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.
API Reference
-------------

17
docs/en/api-reference/protocols/modbus.rst
View File

@@ -14,15 +14,18 @@ The documentation can be found through the link below:
* `ESP-Modbus documentation (English) <https://docs.espressif.com/projects/esp-modbus>`__
Application Example
-------------------
Application Examples
--------------------
The examples below demonstrate the ESP-Modbus library of serial and TCP ports for both slave and master implementations respectively.
- :example:`protocols/modbus/serial/mb_slave`
- :example:`protocols/modbus/serial/mb_master`
- :example:`protocols/modbus/tcp/mb_tcp_slave`
- :example:`protocols/modbus/tcp/mb_tcp_master`
- :example:`protocols/modbus/serial/mb_slave` demonstrates how to use {IDF_TARGET_NAME} as a Modbus serial slave device with the esp-modbus stack, enabling an external Modbus host to read and write device parameters using the Modbus protocol.
- :example:`protocols/modbus/serial/mb_master` demonstrates how to use the esp-modbus stack port on {IDF_TARGET_NAME} as a Modbus serial master device, capable of reading and writing values from slave devices in a Modbus segment.
- :example:`protocols/modbus/tcp/mb_tcp_slave` demonstrates the esp-modbus TCP slave stack port, allowing an external Modbus host to read and write device parameters via the Modbus protocol.
- :example:`protocols/modbus/tcp/mb_tcp_master` demonstrates how to use the esp-modbus stack port on {IDF_TARGET_NAME} as a Modbus TCP master device, capable of reading and writing values from slave devices in a Modbus network.
Please refer to the ``README.md`` documents of each specific example for details.
@@ -30,5 +33,3 @@ Protocol References
-------------------
- For the detailed protocol specifications, see `The Modbus Organization <https://modbus.org/specs.php>`_.

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

@@ -19,16 +19,25 @@ Features
Application Examples
---------------------
--------------------
* :example:`protocols/mqtt/tcp`: MQTT over TCP, default port 1883
* :example:`protocols/mqtt/ssl`: MQTT over TLS, default port 8883
* :example:`protocols/mqtt/ssl_ds`: MQTT over TLS using digital signature peripheral for authentication, default port 8883
* :example:`protocols/mqtt/ssl_mutual_auth`: MQTT over TLS using certificates for authentication, default port 8883
* :example:`protocols/mqtt/ssl_psk`: MQTT over TLS using pre-shared keys for authentication, default port 8883
* :example:`protocols/mqtt/ws`: MQTT over WebSocket, default port 80
* :example:`protocols/mqtt/wss`: MQTT over WebSocket Secure, default port 443
* :example:`protocols/mqtt5`: Uses ESP-MQTT library to connect to broker with MQTT v5.0
- :example:`protocols/mqtt/tcp` demonstrates how to implement MQTT communication over TCP (default port 1883).
- :example:`protocols/mqtt/ssl` demonstrates how to use SSL transport to implement MQTT communication over TLS (default port 8883).
- :example:`protocols/mqtt/ssl_ds` demonstrates how to use digital signature peripheral for authentication to implement MQTT communication over TLS (default port 8883).
- :example:`protocols/mqtt/ssl_mutual_auth` demonstrates how to use certificates for authentication to implement MQTT communication (default port 8883).
- :example:`protocols/mqtt/ssl_psk` demonstrates how to use pre-shared keys for authentication to implement MQTT communication over TLS (default port 8883).
- :example:`protocols/mqtt/ws` demonstrates how to implement MQTT communication over WebSocket (default port 80).
- :example:`protocols/mqtt/wss` demonstrates how to implement MQTT communication over WebSocket Secure (default port 443).
- :example:`protocols/mqtt5` demonstrates how to use ESP-MQTT library to connect to broker with MQTT v5.0.
- :example:`protocols/mqtt/custom_outbox` demonstrates how to customize the outbox in the ESP-MQTT library.
MQTT Message Retransmission
---------------------------