Skip to content

Commit a67076e

Browse files
update documentation
1 parent 019d7a3 commit a67076e

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,30 @@ cmake --build build
118118
The binary is located in the build directory.
119119

120120

121+
## Common Problems and Fixes
122+
123+
### Failed to create Shared Memory
124+
It can happen that the client reports the following error on startup:
125+
```
126+
Failed to create shared memory ...: File exists
127+
```
128+
This can be caused by:
129+
- Another modbus client is running that uses the shared memory with the given name.
130+
If you want to run multiple instances simultaneously use the option ```--name-prefix``` to change the name of the shared memory.
131+
- Any other application uses a shared memory with the given name (unlikely but possible)
132+
- A previous instance of a modbus client crashed or was forcefully terminated and was not able to unlink the shared memory.
133+
In this case, the option ```--force``` can be used to force the use of shared memory.
134+
In the other cases this option should not be used.
135+
136+
### Connection frequently times out
137+
138+
If the connection frequently times out, it may be reasonable to increase the tcp timeout with the option ```--tcp-timeout```.
139+
It is per default set to 5 seconds.
140+
141+
The two options x and y change the timeout behavior of the modbus connection.
142+
These should only be changed by experienced users.
143+
See the [libmodbus documentation](https://libmodbus.org/docs/v3.1.7/) ([byte timeout](https://libmodbus.org/docs/v3.1.7/modbus_set_byte_timeout.html) and [response timeout](https://libmodbus.org/docs/v3.1.7/modbus_set_response_timeout.html)) for more details.
144+
121145
## Links to related projects
122146

123147
### General Shared Memory Tools

0 commit comments

Comments
 (0)