Update readme
This commit is contained in:
+24
-5
@@ -1,15 +1,31 @@
|
||||
# Overview
|
||||
Cdump enables users to record data via an ADC in a continuous way. Cdump requires a special IOC based configuration.
|
||||
|
||||
# Usage
|
||||
To start cdump use `bin/cdump` executable.
|
||||
|
||||
Usage:
|
||||
|
||||
```
|
||||
Usage: cdump <samplingRate> <datafilename>
|
||||
Supported rates: 1Hz 2Hz 5Hz 10Hz 20Hz 50Hz 100Hz 200Hz 500Hz 1kHz 2kHz 5kHz 10kHz 20kHz 50kHz 100kHz
|
||||
```
|
||||
|
||||
|
||||
# Installation
|
||||
## Client
|
||||
Cdump is provided as a single zip file. To install extract the file at any location on your file system.
|
||||
The zip will include a `bin` and `lib` directory holding the executable and required libraries.
|
||||
|
||||
## IOC
|
||||
There need to be a special IOC based installation/configuration for Cdump.
|
||||
The number of channels that the logic will read out is fixed in through the configuration in the substitution file.
|
||||
|
||||
***The number of channels that the logic will read out is fixed in through the configuration in the substitution file.
|
||||
Depending on the number of configured channels and the update rate chosen, this logic might bring a lot of load to
|
||||
the IOC once it is started! Always monitor the IOC load while running a "scan". Also, only configure as many channels
|
||||
as really needed for an experiment!
|
||||
as really needed for an experiment!***
|
||||
|
||||
Template (adcRT.template):
|
||||
### Template (adcRT.template)
|
||||
|
||||
```
|
||||
record(waveform,"$(SYSTEM):convWf$(CARD)-0") {
|
||||
@@ -93,7 +109,7 @@ record (mbbo,"$(SYSTEM):CLOCK-FREQ$(CARD)")
|
||||
```
|
||||
|
||||
|
||||
Substitution File (adc.subs):
|
||||
### Substitution File (adc.subs)
|
||||
|
||||
```
|
||||
file adcRT_continuous.template
|
||||
@@ -103,7 +119,7 @@ file adcRT_continuous.template
|
||||
}
|
||||
```
|
||||
|
||||
Startup Script
|
||||
### Startup Script
|
||||
|
||||
```
|
||||
require "ADC8401RT", "test"
|
||||
@@ -138,3 +154,6 @@ configCarrier8004(6, 0x01800000, 4)
|
||||
# Configure for continuous waveform 64k bins
|
||||
addADC8401RTipac(2, 6, 0xc2, 0, 0, 13, 65536)
|
||||
```
|
||||
|
||||
# Development
|
||||
To build and package the cdump code use `mvn clean compile assembly:assembly` . This will generate a all in one zip file in the `/target` directory.
|
||||
|
||||
Reference in New Issue
Block a user