Skip to content

Commit 193c591

Browse files
committed
doc: modbus: remove extra level in the docs
We had one extra level in the docs, reduce and show modbus details directly instead of the extra step. Signed-off-by: Anas Nashif <[email protected]>
1 parent e616a54 commit 193c591

File tree

2 files changed

+37
-46
lines changed

2 files changed

+37
-46
lines changed

doc/reference/modbus/index.rst

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,41 @@
33
MODBUS
44
######
55

6-
.. toctree::
7-
:maxdepth: 2
6+
Modbus is an industrial messaging protocol. The protocol is specified
7+
for different types of networks or buses. Zephyr OS implementation
8+
supports communication over serial line and may be used
9+
with different physical interfaces, like RS485 or RS232.
10+
TCP support is not implemented directly, but there are helper functions
11+
to realize TCP support according to the application's needs.
812

9-
modbus.rst
13+
Modbus communication is based on client/server model.
14+
Only one client may be present on the bus. Client can communicate with several
15+
server devices. Server devices themselves are passive and must not send
16+
requests or unsolicited responses.
17+
Services requested by the client are specified by function codes (FCxx),
18+
and can be found in the specification or documentation of the API below.
19+
20+
Zephyr RTOS implementation supports both client and server roles.
21+
22+
More information about Modbus and Modbus RTU can be found on the website
23+
`MODBUS Protocol Specifications`_.
24+
25+
Samples
26+
*******
27+
28+
`modbus-rtu-server-sample` and `modbus-rtu-client-sample` give
29+
the possibility to try out RTU server and RTU client implementation with
30+
an evaluation board.
31+
32+
`modbus-tcp-server-sample` is a simple Modbus TCP server.
33+
34+
`modbus-gateway-sample` is an example how to build a TCP to serial line
35+
gateway with Zephyr OS.
36+
37+
API Reference
38+
*************
39+
40+
.. doxygengroup:: modbus
41+
:project: Zephyr
42+
43+
.. _`MODBUS Protocol Specifications`: https://www.modbus.org/specs.php

doc/reference/modbus/modbus.rst

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)