Skip to content

Commit be5e48b

Browse files
alisitsynalisitsyn
committed
Merge branch 'feature/modbus_remove_examples' into 'master'
remove(modbus): remove modbus examples in IDF v6.0 Closes IDF-13491 See merge request espressif/esp-idf!40477
2 parents 8096a2a + 50e724a commit be5e48b

File tree

46 files changed

+106
-2884
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+106
-2884
lines changed

‎docs/docs_not_updated/esp32c61.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ api-reference/error-codes.rst
5656
api-reference/index.rst
5757
api-reference/protocols/icmp_echo.rst
5858
api-reference/protocols/mqtt.rst
59-
api-reference/protocols/modbus.rst
6059
api-reference/protocols/mdns.rst
6160
api-reference/protocols/index.rst
6261
api-reference/protocols/asio.rst

‎docs/docs_not_updated/esp32h21.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ api-reference/protocols/esp_crt_bundle.rst
8383
api-reference/protocols/mdns.rst
8484
api-reference/protocols/asio.rst
8585
api-reference/protocols/mbedtls.rst
86-
api-reference/protocols/modbus.rst
8786
api-reference/protocols/icmp_echo.rst
8887
api-reference/protocols/esp_https_server.rst
8988
api-reference/protocols/esp_local_ctrl.rst

‎docs/docs_not_updated/esp32h4.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ api-reference/protocols/esp_crt_bundle.rst
8383
api-reference/protocols/mdns.rst
8484
api-reference/protocols/asio.rst
8585
api-reference/protocols/mbedtls.rst
86-
api-reference/protocols/modbus.rst
8786
api-reference/protocols/icmp_echo.rst
8887
api-reference/protocols/esp_https_server.rst
8988
api-reference/protocols/esp_local_ctrl.rst

‎docs/en/api-reference/protocols/modbus.rst‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,25 @@ ESP-Modbus
44
:link_to_translation:`zh_CN:[中文]`
55

66
The Espressif ESP-Modbus Library (esp-modbus) supports Modbus communication in the networks based on RS485, Wi-Fi, and Ethernet interfaces.
7-
Since ESP-IDF version v5.0, the component ``freemodbus`` has been moved from ESP-IDF to a separate repository:
7+
The component ``esp-modbus v2 (v2.x.x)`` is the current supported component version:
88

9-
* `ESP-Modbus component on GitHub <https://github.com/espressif/esp-modbus>`__
9+
* `ESP-Modbus component on GitHub <https://github.com/espressif/esp-modbus/tree/main>`__
10+
* `ESP-Modbus component in component manager <https://components.espressif.com/components/espressif/esp-modbus>`__
1011

1112
Hosted Documentation
1213
--------------------
1314

1415
The documentation can be found through the link below:
1516

16-
* `ESP-Modbus documentation (English) <https://docs.espressif.com/projects/esp-modbus>`__
17+
* `ESP-Modbus V2 documentation (English) <https://docs.espressif.com/projects/esp-modbus/en/stable>`__
1718

18-
Application Examples
19-
--------------------
20-
21-
The examples below demonstrate the ESP-Modbus library of serial and TCP ports for both slave and master implementations respectively.
22-
23-
- :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.
24-
25-
- :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.
19+
Discussions
20+
~~~~~~~~~~~
2621

27-
- :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.
28-
29-
- :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.
30-
31-
Please refer to the ``README.md`` documents of each specific example for details.
22+
* `Discussions for version v2 <https://github.com/espressif/esp-modbus/discussions>`__
3223

3324
Protocol References
3425
-------------------
3526

3627
- For the detailed protocol specifications, see `The Modbus Organization <https://modbus.org/specs.php>`_.
28+

‎docs/en/migration-guides/release-6.x/6.0/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Migration from 5.5 to 6.0
99
build-system
1010
peripherals
1111
provisioning
12+
protocols
1213
security
1314
tools
1415
system

‎docs/en/migration-guides/release-6.x/6.0/protocols.rst‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
ESP-Modbus
2+
==========
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
The Espressif ESP-Modbus Library (esp-modbus) supports Modbus communication in the networks based on RS485, Wi-Fi, and Ethernet interfaces.
7+
8+
The component ``esp-modbus v2 (v2.x.x)`` is the current supported component version:
9+
10+
* `ESP-Modbus component on GitHub <https://github.com/espressif/esp-modbus/tree/main>`__
11+
12+
Documentation
13+
~~~~~~~~~~~~~
14+
15+
* `ESP-MODBUS stable documentation v2.x.x <https://docs.espressif.com/projects/esp-modbus/en/stable>`__
16+
* `Documentation for legacy version v1.x.x <https://docs.espressif.com/projects/esp-modbus/en/v1>`__
17+
18+
Application Examples
19+
~~~~~~~~~~~~~~~~~~~~
20+
21+
Since ESP-IDF version v6.0, the examples for component ``esp-modbus v1`` which is obsolete have been removed from ESP-IDF.
22+
23+
- `legacy esp-modbus v1.x.x examples (esp-idf v5.5) <https://github.com/espressif/esp-idf/tree/release/v5.5/examples/protocols/modbus>`__
24+
25+
The examples below demonstrate the ESP-Modbus library of serial and TCP ports for both slave and master implementations respectively.
26+
27+
- `mb_serial_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. <https://github.com/espressif/esp-modbus/tree/main/examples/serial/mb_serial_slave>`__
28+
29+
- `mb_serial_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. <https://github.com/espressif/esp-modbus/tree/main/examples/serial/mb_serial_master>`__
30+
31+
- `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. <https://github.com/espressif/esp-modbus/tree/main/examples/tcp/mb_tcp_slave>`__
32+
33+
- `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. <https://github.com/espressif/esp-modbus/tree/main/examples/tcp/mb_tcp_master>`__
34+
35+
Please refer to the ``README.md`` documents of each specific example for details.
36+
37+
Discussions
38+
~~~~~~~~~~~
39+
40+
* `Discussions for version v2 <https://github.com/espressif/esp-modbus/discussions>`__
41+
42+

‎docs/zh_CN/api-reference/protocols/modbus.rst‎

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,25 @@ ESP-Modbus
33

44
:link_to_translation:`en:[English]`
55

6-
乐鑫的 ESP-Modbus 库 (esp-modbus) 支持基于 RS485、Wi-Fi 和以太网接口的 Modbus 通信。
7-
自 ESP-IDF v5.0 版本以来， 组件 ``freemodbus`` 已被移动到单独的代码仓库中:
6+
乐鑫 ESP-Modbus 库 (esp-modbus) 支持基于 RS485、Wi-Fi 和以太网接口网络的 Modbus 通信。
7+
组件 esp-modbus v2 (v2.x.x) 是当前支持的组件版本：
88

9-
* `GitHub 上的 ESP-Modbus 组件 <https://github.com/espressif/esp-modbus>`__
9+
* `GitHub 上的 ESP-Modbus 组件 <https://github.com/espressif/esp-modbus/tree/main>`__
10+
* `组件管理器中的 ESP-Modbus 组件 <https://components.espressif.com/components/espressif/esp-modbus>`__
1011

1112
托管文档
12-
--------
13+
--------------------
1314

14-
相应文档请参阅：
15+
文档可通过以下链接找到：
1516

16-
* `ESP-Modbus 文档 <https://docs.espressif.com/projects/esp-modbus>`__
17+
* `ESP-Modbus V2 文档（英文） <https://docs.espressif.com/projects/esp-modbus/en/stable>`__
1718

18-
应用示例
19-
--------
19+
讨论
20+
~~~~
2021

21-
以下示例分别介绍了 ESP-Modbus 库的串行端口、TCP 端口的从机和主机实现。
22-
23-
- :example:`protocols/modbus/serial/mb_slave` 演示了如何使用 {IDF_TARGET_NAME} 作为 Modbus 串行从设备，通过 esp-modbus 栈，使外部 Modbus 主机能够使用 Modbus 协议读取和写入设备参数。
24-
25-
- :example:`protocols/modbus/serial/mb_master` 演示了如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 栈端口作为 Modbus 串行主设备，读取和写入 Modbus 网络中从设备的值。
26-
27-
- :example:`protocols/modbus/tcp/mb_tcp_slave` 演示了 esp-modbus TCP 从设备栈端口，允许外部 Modbus 主机通过 Modbus 协议读取和写入设备参数。
28-
29-
- :example:`protocols/modbus/tcp/mb_tcp_master` 演示了如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 栈端口作为 Modbus TCP 主设备，读取和写入 Modbus 网络中从设备的值。
30-
31-
详情请参阅具体示例的 ``README.md`` 。
22+
* `v2 版本的讨论 <https://github.com/espressif/esp-modbus/discussions>`__
3223

3324
协议参考
34-
--------
25+
-------------------
3526

36-
- Modbus 组织与规范协议请参阅 `The Modbus Organization <https://modbus.org/specs.php>`_。
27+
- 有关详细的协议规范，请参阅 `Modbus 组织 <https://modbus.org/specs.php>`_

‎docs/zh_CN/migration-guides/release-6.x/6.0/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
build-system
1010
peripherals
1111
provisioning
12+
protocols
1213
security
1314
tools
1415
system

‎docs/zh_CN/migration-guides/release-6.x/6.0/protocols.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
ESP-Modbus
2+
==========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
乐鑫ESP-Modbus 库 (esp-modbus) 支持基于 RS485、Wi-Fi 和以太网接口网络的 Modbus 通信。
7+
8+
``esp-modbus v2 (v2.x.x)`` 组件是当前支持的组件版本：
9+
10+
* `GitHub 上的 ESP-Modbus 组件 <https://github.com/espressif/esp-modbus/tree/main>`__
11+
12+
文档
13+
~~~~~~~~~~~~~
14+
15+
* `ESP-MODBUS 稳定版文档 v2.x.x <https://docs.espressif.com/projects/esp-modbus/en/stable>`__
16+
* `旧版本 v1.x.x 文档 <https://docs.espressif.com/projects/esp-modbus/en/v1>`__
17+
18+
应用示例
19+
~~~~~~~~~~~~~~~~~~~~
20+
21+
自 ESP-IDF v6.0 版本起，已从 ESP-IDF 中移除已废弃的 ``esp-modbus v1`` 组件示例。
22+
23+
- `旧版 esp-modbus v1.x.x 示例 (esp-idf v5.5) <https://github.com/espressif/esp-idf/tree/release/v5.5/examples/protocols/modbus>`__
24+
25+
以下示例分别演示了串行和 TCP 端口的 ESP-Modbus 库在从站和主站实现中的应用。
26+
27+
- `mb_serial_slave - 演示如何将 {IDF_TARGET_NAME} 用作 Modbus 串行从站设备，通过 esp-modbus 协议栈，使外部 Modbus 主机能够使用 Modbus 协议读写设备参数。 <https://github.com/espressif/esp-modbus/tree/main/examples/serial/mb_serial_slave>`__
28+
29+
- `mb_serial_master - 演示如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 协议栈端口作为 Modbus 串行主站设备，能够读写 Modbus 段中从站设备的值。 <https://github.com/espressif/esp-modbus/tree/main/examples/serial/mb_serial_master>`__
30+
31+
- `mb_tcp_slave - 演示 esp-modbus TCP 从站协议栈端口，允许外部 Modbus 主机通过 Modbus 协议读写设备参数。 <https://github.com/espressif/esp-modbus/tree/main/examples/tcp/mb_tcp_slave>`__
32+
33+
- `mb_tcp_master` - 演示如何在 {IDF_TARGET_NAME} 上使用 esp-modbus 协议栈端口作为 Modbus TCP 主站设备，能够读写 Modbus 网络中从站设备的值。 <https://github.com/espressif/esp-modbus/tree/main/examples/tcp/mb_tcp_master>`__
34+
35+
有关详细信息，请参阅每个具体示例的 ``README.md`` 文档。
36+
37+
讨论
38+
~~~~~~~~~~~
39+
40+
* `v2 版本讨论 <https://github.com/espressif/esp-modbus/discussions>`__

‎examples/peripherals/uart/uart_echo/main/Kconfig.projbuild‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ menu "Echo Example Configuration"
1717
range 1200 115200
1818
default 115200
1919
help
20-
UART communication speed for Modbus example.
20+
UART communication speed.
2121

2222
config EXAMPLE_UART_RXD
2323
int "UART RXD pin number"

0 commit comments

Comments
 (0)