diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
@@ -31,3 +31,38 @@ This little tool will simulate the online capabilities of the new detector. Ther `$ make` 5. In the `bin` directory there will be two executables (`onlineDetectorSimulatorClient`, `onlineDetectorSimulatorServer`). + +## Usage + +The executable `onlineDetectorSimulatorClient` sends the UDP packages and `onlineDetectorSimulatorServer` receives them. + +The usage of the program will be shown using `localhost`: + +1. Copy the file `config.cfg` into the binary directory of your executables and make sure you have test data around. +2. Start `onlineDetectorSimulatorServer`: + + ```bash + $ ./onlineDetectorSimulatorServer <address> + ``` + + In case of localhost it would be: + + ```bash + $ ./onlineDetectorSimulatorServer localhost + ``` + +3. Start `onlineDetectorSimulatorClient`: + + ```bash + $ ./onlineDetectorSimulatorClient <packets_per_second> <address> + ``` + + Take into account, that currently `packets_per_secon`d value is not equal to the images per second sent out. If you reduce the packet size in `config.cfg` you need to increase the `packets_per_second` value by the same factor to keep the same images per second rate. + + ```bash + $ ./onlineDetectorSimulatorClient 1000 localhost + ``` + + The above command using the standard configuration in the repository sends approximately 1000 images per second via UDP. + + After some time, quit the client program using `ctrl+c`. The server program will stop after a timeout of `10 s`
\ No newline at end of file |