alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

freemodbus: add comments for limitation in current version of freemodbus

Browse Source
This commit is contained in:
aleks 2020-05-25 13:29:08 +02:00
parent c17d55eb9b
commit 4be2170250
5 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/freemodbus/README.rst Normal file
View File

@ -0,0 +1,6 @@
# Modbus assumptions, dependencies and constraints
1. Current implementation of Modbus has limitation: maximum frame size should be less than 120 bytes (default UART receive FIFO full threshold value).
This limitation is removed in ESP-IDF v4.2.
2. The only one instance of Modbus port can be initialized at the same time.

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

@ -109,3 +109,10 @@ The examples below use the FreeModbus library port for serial slave and master i
Please refer to the specific example README.md for details.
Modbus Readme File
------------------
.. include:: ../../../../components/freemodbus/README.rst

4
examples/protocols/modbus/serial/README.md
View File

@ -78,5 +78,7 @@ Kconfig value CONFIG_FMB_MASTER_TIMEOUT_MS_RESPOND (CONFIG_FMB_SERIAL_ASCII_TIME
ESP_ERR_NOT_SUPPORTED (0x106), ESP_ERR_INVALID_RESPONSE (0x108) - Modbus slave device does not support requested command or register and sent exeption response.
ESP_ERR_INVALID_STATE (0x103) - Modbus stack is not configured correctly or can't work correctly due to critical failure.
Note: Refer to file below for more information about current implementation of Modbus:
* `components/freemodbus/README.rst`

4
examples/protocols/modbus/serial/mb_master/README.md
View File

@ -148,3 +148,7 @@ I (10175) MASTER_TEST: Destroy master...
```
The example reads the characteristics from slave device(s), while alarm is not triggered in the slave device (See the "Example parameters definition"). The output line describes Timestamp, Cid of characteristic, Characteristic name (Units), Characteristic value (Hex).
Note: Refer to file below for more information about current implementation of Modbus:
* `components/freemodbus/README.rst`

3
examples/protocols/modbus/serial/mb_slave/README.md
View File

@ -89,3 +89,6 @@ I (14001) SLAVE_TEST: Modbus controller destroyed.
```
The output lines describe type of operation, its timestamp, modbus address, access type, storage address in parameter structure and number of registers accordingly.
Note: Refer to file below for more information about current implementation of Modbus:
* `components/freemodbus/README.rst`