Skip to content

Commit 6884be5

Browse files
committed
Update docs
1 parent 64fdff4 commit 6884be5

14 files changed

Lines changed: 61 additions & 26 deletions

README.md

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,31 @@
22

33
## Overview
44

5-
ModbusTools are cross-platform (Windows, Linux) Modbus simulator tools (client and server) with GUI
6-
to work with standard Modbus Protocol.
7-
Modbus Tools are a free, open-source tools with a simple user interface written in C++/Qt.
8-
It implements TCP, RTU and ASCII versions of Modbus Protocol.
5+
ModbusTools are cross-platform (Windows, Linux) GUI simulators (client/server) that support
6+
TCP, UDP, RTU, ASCII, RTU/ASCII over TCP/UDP Modbus protocol types.
7+
Modbus tools are a free, open-source tools with a simple user interface written in C++/Qt.
98

10-
### *New in version 0.4*:
9+
Supported Modbus functions:
1110

12-
*From now server application allows you to create program logic for the Modbus device simulator
13-
using your favorite Python programming language.*
14-
15-
Software implements such Modbus functions as:
1611
* `1 ` (`0x01`) - `READ_COILS`
1712
* `2 ` (`0x02`) - `READ_DISCRETE_INPUTS`
1813
* `3 ` (`0x03`) - `READ_HOLDING_REGISTERS`
1914
* `4 ` (`0x04`) - `READ_INPUT_REGISTERS`
2015
* `5 ` (`0x05`) - `WRITE_SINGLE_COIL`
2116
* `6 ` (`0x06`) - `WRITE_SINGLE_REGISTER`
2217
* `7 ` (`0x07`) - `READ_EXCEPTION_STATUS`
18+
* `8 ` (`0x08`) - `DIAGNOSTICS` (v0.5+)
19+
* `11` (`0x0B`) - `GET_COMM_EVENT_COUNTER` (v0.5+)
20+
* `12` (`0x0C`) - `GET_COMM_EVENT_LOG` (v0.5+)
2321
* `15` (`0x0F`) - `WRITE_MULTIPLE_COILS`
2422
* `16` (`0x10`) - `WRITE_MULTIPLE_REGISTERS`
25-
* `17` (`0x11`) - `REPORT_SERVER_ID` (since v0.4)
26-
* `22` (`0x16`) - `MASK_WRITE_REGISTER` (since v0.3)
23+
* `17` (`0x11`) - `REPORT_SERVER_ID` (v0.4+)
24+
* `20` (`0x14`) - `READ_FILE_RECORD` (v0.5+)
25+
* `21` (`0x15`) - `WRITE_FILE_RECORD` (v0.5+)
26+
* `22` (`0x16`) - `MASK_WRITE_REGISTER` (v0.3+)
2727
* `23` (`0x17`) - `READ_WRITE_MULTIPLE_REGISTERS` (since v0.3)
28+
* `24` (`0x18`) - `READ_FIFO_QUEUE` (v0.5+)
29+
* `43/14` (`0x2B/0x0E`) - `READ_DEVICE_ID` (v0.5+)
2830

2931
ModbusTools work with Qt Framework version 5 (5.8 or later).
3032
It based on `ModbusLib` cross platform library project:
@@ -109,7 +111,29 @@ to the specified port with unit address (e.g. `unit=0` for broadcast request).
109111
It works in parallel with regular Modbus application messages and
110112
can be seen in LogView as regular Modbus message as well.
111113

112-
### Scanner window (since v0.3)
114+
__*New in version 0.5*__:
115+
116+
`SendMessage` window contains list with predefined functions
117+
with parameters that can be periodically sent to the server.
118+
119+
### Send Bytes window (v0.5+)
120+
121+
This is a new tool for Modbus client that provides abillity to send
122+
any byte sequence to the server which can be non standard sequence.
123+
This tool can be useful for the server that provides non standard
124+
behavior or to test server's response for some byte sequence.
125+
126+
![](./doc/images/client_sendbytes_window.png)
127+
128+
This window can be opened using menu `Tools->Send Bytes`.
129+
User can send message to the predefined port.
130+
It works in parallel with regular Modbus application messages and
131+
can be seen in LogView as regular Modbus message as well.
132+
133+
`SendBytes` window contains list with predefined byte sequences
134+
that can be periodically sent to the server.
135+
136+
### Scanner window (v0.3+)
113137

114138
`Scanner` tool window is intended to scan Modbus network to determine which device
115139
with current settings are present in the network.
@@ -125,6 +149,12 @@ There is a list of found devices in central widget.
125149
Found devices can be add to the current project:
126150
button `To Project` add selected devices, `All To Project` - all devices will be added to the project.
127151

152+
__*New in version 0.5*__:
153+
154+
`Scanner` window contains special tab `Functions`, that shows
155+
result of every request function, so it can be used to scan device(s)
156+
for specific function or function parameter support.
157+
128158
## About Modbus Server
129159

130160
The server implements Modbus server device and works like Modbus simulator.
@@ -144,7 +174,7 @@ Device contains settings for a single device (such as Modbus Unit Address, memor
144174
The DataViewItem contains a single data unit to be read/write from the device and has many formats to
145175
represent the current data. Action provides simulation capabilities (automatic change of device memory values).
146176

147-
### Scripting using Python (since v0.4)
177+
### Scripting using Python (v0.4+)
148178

149179
Since v0.4 version 'server' application allows to extend logic of your Modbus device
150180
simulator using one the most popular programming language - Python.

changelog.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,14 @@ List of changes of new v0.4 version of ModbusTools:
214214
* `RTU` over `TCP`
215215
* `ASCII` over `TCP`
216216
* `RTU` over `UDP`
217-
* `ASCII` over `UDP`
218-
* Added `SendBytes`-tool for Modbus client
219-
* Updated `Send Message` dialog for Modbus client
217+
* `ASCII` over `UDP`
218+
* Added support for `FC08`, `FC11`, `FC12`, `FC20`, `FC21`, `FC24`, `FC43/14`
219+
* Added `SendBytes`-tool for Modbus client ((+ predefined message list))
220+
* Updated `Send Message` dialog for Modbus client (added predefined message list)
220221
* Updated `Scanner` dialog for Modbus client (added function support scanning)
222+
* Added `LogView` message category colorization
223+
* Added statistics for Port/Device of `mbclient`/`mbserver`
224+
* Renamed `ByteOrder` param into `SwapBytes`
225+
* Renamed project file extensions `pjc`/`pjs` into `mbc`/`mbs`
226+
* Renamed `core`/`client`/`server` into `mbcore`/`mbclient`/`mbserver`
227+
* Added cmake option to separate client and server compilation
24.2 KB
Loading
41.3 KB
Loading
65 KB
Loading
42.7 KB
Loading

src/client/core/client.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@
3939
#include <runtime/client_runtime.h>
4040

4141
mbClient::Strings::Strings() :
42-
settings_application(QStringLiteral("Client")),
42+
settings_application(QStringLiteral("mbclient")),
4343
default_client(settings_application),
44-
default_conf_file(QStringLiteral("client.conf")),
4544
GUID(QStringLiteral("e9da9345-c8b1-47d0-acbd-0a3401fef700")) // generated by https://www.guidgenerator.com/online-guid-generator.aspx
4645
{
4746
}

src/client/core/client.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ class mbClient : public mbCore
4646
{
4747
const QString settings_application;
4848
const QString default_client;
49-
const QString default_conf_file;
5049
const QString GUID;
5150
Strings();
5251
static const Strings &instance();

src/client/gui/sendbytes/client_sendbytesui.ui

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@
279279
</property>
280280
<property name="icon">
281281
<iconset resource="../../../core/gui/core_rsc.qrc">
282-
<normaloff>:/core/icons/remove.png</normaloff>:/core/icons/remove.png</iconset>
282+
<normaloff>:/core/icons/minus.ico</normaloff>:/core/icons/minus.ico</iconset>
283283
</property>
284284
</widget>
285285
</item>

src/client/gui/sendmessage/client_sendmessageui.ui

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@
348348
</property>
349349
<property name="icon">
350350
<iconset resource="../../../core/gui/core_rsc.qrc">
351-
<normaloff>:/core/icons/remove.png</normaloff>:/core/icons/remove.png</iconset>
351+
<normaloff>:/core/icons/minus.ico</normaloff>:/core/icons/minus.ico</iconset>
352352
</property>
353353
</widget>
354354
</item>

0 commit comments

Comments
 (0)