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

README.md : Experiment with formatting.

Browse Source
This commit is contained in:
kevin 2024-11-30 10:10:53 -05:00
parent 971a094408
commit c7c46fcaae
1 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -36,24 +36,30 @@ sets of parameters. The primary parameter file is `src/cwtest/cfg/main.cfg`.
# MIDI # MIDI
CLI Label | Cfg File | Notes CLI Label | Source File | Function
------------------|-----------|---------------------------------------------------------------- ------------------|----------------------|--------------
midiDeviceReport | main.cfg | List The current set of MIID hardware devices and their ports. midiDeviceReport | cwMidiDeviceTest.cpp | testReport()
midiDevice | " | Interactive testing of the MIDI input file device start/pause/unpause/stop functions.
midiDevice : Also Compares the time between MIDI events as generated by the device to the actual time between the List The current set of MIID hardware devices and their ports.
events as listed in the file.
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 ## Serial
``` CLI Label | Source File | Function
cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDeviceReport ------------------|----------------------|---------------------
``` serialSrv | cwSerialPortSrv.cpp | esrialPortSrvTest()
See `serialPortSrvTest()` in `cwSerialPortSrv.cpp`.
This is an interactive test of the serial port send/receive functions. 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. 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`. Firmware to run on ATMEGA328 based devices, like the Arduino Uno, is provided in `study/serial/arduino_xmt_recv/main.c`.