Skip to content

Commit b3542a6

Browse files
committed
Updated README
1 parent 676f987 commit b3542a6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,33 @@ Please see the [project website](https://paulorb.github.io/modbus-simulator-cli/
88

99
> :warning: **This is a work in progress**:
1010
11+
## Features
12+
* High performance TCP Server
13+
* 100% Kotlin code - JVM (Multiplatform)
14+
* Ability to associate memory registers with symbols (variable names)
15+
* Ability to create custom simulation which can during runtime set, clear variables, execute math operations over registers, deal with specific timing requirements
16+
* Available as CLI tool or as docker image
17+
18+
## Registers
19+
The table below shows the supported registers and which datatype
20+
and simulation operation can be performed for each register.
21+
22+
| Register | Datatype | Operations |
23+
|------------------------|----------------|------------|
24+
| Coils (0x) | BOOL | Set |
25+
| Input register (1x) | BOOL | Set |
26+
| Discrete Input (3x) | INT16 | Set, Add |
27+
| Holding Registers (4x) | INT16, FLOAT32 | Set, Add |
28+
29+
## Quick Start
30+
1. Compile with gradle and generate fat Jar
31+
32+
```shell
33+
./gradlew shadowJar
34+
```
35+
2. Run it with "-sr" argument which is the most basic simulation, consisting in generating random values each time a read operation is performed.
36+
37+
```shell
38+
java -jar build/libs/modbus-simulator-cli-1.0-SNAPSHOT-all.jar -sr
39+
```
40+
For customization options check [full documentation](https://paulorb.github.io/modbus-simulator-cli/)

0 commit comments

Comments
 (0)