cml/cwtest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md : More updates.

Browse Source
This commit is contained in:
kevin 2024-11-30 08:46:51 -05:00
parent 1286aea854
commit 971a094408
1 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,4 +1,6 @@
# libcw Testing and Development App # cwtest Testing and Development Application for libcw.
`cwtest` is a command line interface to `libcw`.
Command line: Command line:
``` ```
@ -22,30 +24,25 @@ Where `<file.cfg>` refers to a libcw configuration file file with the form:
} }
``` ```
`<label>` refers to a specific set of parameters which are associated with a library function. `<label>` refers to a specific set of named parameters
See `main.cpp` `mode_array[]` for the mapping of labels to functions. (e.g. `program_0`,`program_1`) which are associated with a library
function. See `main.cpp` `mode_array[]` for the mapping of labels to
functions.
The goal of `cwtest` is to be able to easily exercize `libcw` functions with a flexible The goal of `cwtest` is to be able to easily exercise `libcw`
sets of parameters. The configuration file provides the parameters. functions, or build simple utilities based on them, with a flexible
sets of parameters. The primary parameter file is `src/cwtest/cfg/main.cfg`.
## MIDI # MIDI
# midiDeviceReport CLI Label | Cfg File | Notes
------------------|-----------|----------------------------------------------------------------
midiDeviceReport | main.cfg | List The current set of MIID hardware devices and their ports.
midiDevice | " | Interactive testing of the MIDI input file device start/pause/unpause/stop functions.
List The current set of MIID hardware devices and their ports. midiDevice : Also Compares the time between MIDI events as generated by the device to the actual time between the
```
cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDeviceReport
```
# midiDevice
Interactive testing of the MIDI input file device start/pause/unpause/stop functions.
Compares the time between MIDI events as generated by the device to the actual time between the
events as listed in the file. events as listed in the file.
```
cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDevice
```
## Serial ## Serial
@ -105,6 +102,21 @@ Generate a list of devices and device attributes from libcw. This will include
## socketUdp
See test_udp() in `cwTcpSocketTest.cpp`.
Interactive send/recv tester for UDP based sockets. This tester can work across machines or
on a single machine specifying '127.0.0.1' (localhost) as the remote address and choosing different
port numbers for the remote and local address.
## socketUdp
See test_udp() in `cwTcpSocketTest.cpp`.
Interactive send/recv tester for TCP based sockets. This tester can work across machines or
on a single machine specifying '127.0.0.1' (localhost) as the remote address and choosing different
port numbers for the remote and local address.