diff --git a/ch.psi.fda.cdump/Readme.md b/ch.psi.fda.cdump/Readme.md index 5772ca8..0dec0ea 100644 --- a/ch.psi.fda.cdump/Readme.md +++ b/ch.psi.fda.cdump/Readme.md @@ -1,6 +1,18 @@ # Overview Cdump enables users to record data via an ADC in a continuous way. Cdump requires a special IOC based configuration. +The basic setup and function of cdump is as follows: + +``` +IOC +[waveform (adcData)] < data +[sampling rate (smplRate)] < set/control sampling rate of the controller +[command (adcCmd)] < start stop acquisition process +``` + +There are 3 channels on the IOC. One for the data, and 2 for controlling the acquisition. + + # Usage To start the cdump client use the provided `bin/cdump` executable.