Skip to content

Commit

Permalink
Rewrite and rename README as README.md in tests/
Browse files Browse the repository at this point in the history
  • Loading branch information
stephane committed May 17, 2016
1 parent 7612ce2 commit 2c2fc6d
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 43 deletions.
2 changes: 1 addition & 1 deletion tests/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
EXTRA_DIST = README unit-tests.sh
EXTRA_DIST = README.md unit-tests.sh

noinst_PROGRAMS = \
bandwidth-server-one \
Expand Down
42 changes: 0 additions & 42 deletions tests/README

This file was deleted.

27 changes: 27 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# License
Test programs of this directory are provided under BSD license (see associated
LICENSE file).

# Compilation
After installation, you can use pkg-config to compile these tests.
For example, to compile random-test-server run:

gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus`

- `random-test-server` is necessary to launch a server before running
random-test-client. By default, it receives and replies to Modbus query on the
localhost and port 1502.

- `random-test-client` sends many different queries to a large range of
addresses and values to test the communication between the client and the
server.

- `unit-test-server` and `unit-test-client` run a full unit test suite. These
programs are essential to test the Modbus protocol implementation and libmodbus
behavior.

- `bandwidth-server-one`, `bandwidth-server-many-up` and `bandwidth-client`
return very useful information about the performance of transfert rate between
the server and the client. `bandwidth-server-one` can only handles one
connection at once with a client whereas `bandwidth-server-many-up` opens a
connection for each new clients (with a limit).

0 comments on commit 2c2fc6d

Please sign in to comment.