Ver código fonte

Add documentation about the test programs.

Stéphane Raimbault 17 anos atrás
pai
commit
5d78520833
3 arquivos alterados com 40 adições e 6 exclusões
  1. 13 4
      README
  2. 0 2
      TODO
  3. 27 0
      tests/README

+ 13 - 4
README

@@ -2,10 +2,8 @@
 A groovy libmodbus
 ==================
 
-Presentation
-============
-https://launchpad.net/libmodbus
-http://copyleft.free.fr/wordpress/index.php/libmodbus/
+Overview
+========
 
 libmodbus is a free software library to send/receive data with a
 device which respect the Modbus protocol. This library can use a
@@ -18,6 +16,9 @@ Schneider at www.schneiderautomation.com.
 The license of libmodbus is LGPL v3.
 The licence of programs in the tests directory is GPL v3.
 
+https://launchpad.net/libmodbus
+http://copyleft.free.fr/wordpress/index.php/libmodbus/
+
 
 Installation
 ============
@@ -40,3 +41,11 @@ or 'waf' if you use a global Waf script.
 The sources are built in the 'build' directory at the root of the
 project source files.
 
+
+Testing
+=======
+
+Some testing programs are provided in the tests directory, you can
+freely edit the code source to fit your needs (it's Free Sofware :).
+
+See tests/README for a description of each program.

+ 0 - 2
TODO

@@ -3,5 +3,3 @@ Features
 * broadcasting
 * slave must listen only request sent for him
 
-Documentation
-* README with an example to test the library

+ 27 - 0
tests/README

@@ -0,0 +1,27 @@
+test-master-random 
+------------------
+This programm sends many different queries to a large range of
+addresses and values to test the communication between the master and
+the slave.
+
+unit-test-slave
+---------------
+It's necessary to launch this server before run unit-test-master. By
+default, it receives and responses to Modbus query on the localhost
+and port 1502.
+
+unit-test-master
+----------------
+By default, this program sends some queries with the values defined in
+unit-test.h and checks the responses. These programs are useful to
+test the protocol implementation.
+
+bench-bandwidth-slave
+---------------------
+It's a program very similar to unit-test-slave and works with
+bench-bandwidth-master.
+
+bench-bandwidth-master
+----------------------
+It returns some very useful informations about the performance of
+transfert rate between the slave and the master.