diff --git a/README.md b/README.md index 98a3d3f..0dd3ad6 100644 --- a/README.md +++ b/README.md @@ -36,24 +36,30 @@ sets of parameters. The primary parameter file is `src/cwtest/cfg/main.cfg`. # MIDI -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. +CLI Label | Source File | Function +------------------|----------------------|-------------- +midiDeviceReport | cwMidiDeviceTest.cpp | testReport() -midiDevice : Also Compares the time between MIDI events as generated by the device to the actual time between the -events as listed in the file. +List The current set of MIID hardware devices and their ports. + +CLI Label | Source File | Function +------------------|----------------------|-------------- +midiDevice | cwMidiDeviceTest.cpp | test() + +Interactive testing of the MIDI input file device +start/pause/unpause/stop functions. This function also validates the +latency of the device by comparing the time between MIDI events as +generated by the device to the actual time between the events in the +MIDI file. ## Serial -``` -cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDeviceReport -``` - -See `serialPortSrvTest()` in `cwSerialPortSrv.cpp`. +CLI Label | Source File | Function +------------------|----------------------|--------------------- +serialSrv | cwSerialPortSrv.cpp | esrialPortSrvTest() This is an interactive test of the serial port send/receive functions. -The test function continuously transmits ASCII values '0' through 'z' to external devices `/dev/ttyACM0` and '/dev/ttyACM1`. +The function continuously transmits ASCII values '0' through 'z' to external devices `/dev/ttyACM0` and '/dev/ttyACM1`. Those devices should increment the received value and send it back, where it is receieved and printed to the console. Firmware to run on ATMEGA328 based devices, like the Arduino Uno, is provided in `study/serial/arduino_xmt_recv/main.c`.