summaryrefslogtreecommitdiffstats
path: root/dpd/README.md
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2017-12-29 09:24:06 +0100
committerMatthias P. Braendli <matthias.braendli@mpb.li>2017-12-29 09:24:06 +0100
commit727e8c1e139cec691d07a45abab21836f46c3d33 (patch)
tree2691449b2c79e92d59a7828f84613e958fcde29c /dpd/README.md
parent0386346f9bad5214b7515b33a1c8fac353de4b6b (diff)
downloaddabmod-727e8c1e139cec691d07a45abab21836f46c3d33.tar.gz
dabmod-727e8c1e139cec691d07a45abab21836f46c3d33.tar.bz2
dabmod-727e8c1e139cec691d07a45abab21836f46c3d33.zip
Update DPD readme
Diffstat (limited to 'dpd/README.md')
-rw-r--r--dpd/README.md33
1 files changed, 25 insertions, 8 deletions
diff --git a/dpd/README.md b/dpd/README.md
index 1b481c0..fc84bad 100644
--- a/dpd/README.md
+++ b/dpd/README.md
@@ -109,14 +109,31 @@ The DPDCE uses automatic gain control for both TX and RX gain to get both a
high quantisation quality for the most frequent amplitude regions and a high
enough back-off so the peaks are also quantised correctly. This means that the
output power will stay at the same level, but the DPDCE may change TX gain to
-trade it with digital gain and also change RX gain.
-
-As a first test you should run the DPDCE with the *--plot* parameter. It
-preserves the output power and generates all available visualisation plots in
-the newly created logging directory `/tmp/dpd_<time_stamp>`. As the predistortion
-should increase the peak to shoulder ratio, you should select a *txgain* in the
-ODR-DabMod configuration file such that the initial peak-to-soulder ratio
-visible on your spectrum analyser. This way, you will be able to see a the
+trade it with digital gain and also change RX gain. This also implies that you
+should *not modify txgain, rxgain, digital gain or coefficient settings manually!*
+When the DPDCE is used, it controls these settings, and there are command line
+options for you to define initial values.
+
+To verify that the communication between the DPDCE and ODR-DabMod is ok,
+you can use the status and reset options:
+
+```
+cd dpd
+python main.py --status
+python main.py --reset
+```
+
+The reset option sets all DPD-related settings to the defaults (as shown in the
+`--help` usage screen) and stops.
+
+When neither `--status` nor `--reset` is given, the DPDCE will run the predistortion
+algorithm. As a first test you should run the DPDCE with the `--plot`
+parameter. It preserves the output power and generates all available
+visualisation plots in the newly created logging directory
+`/tmp/dpd_<time_stamp>`. As the predistortion should increase the peak to
+shoulder ratio, you should select a *txgain* in the ODR-DabMod configuration
+file such that the initial peak-to-soulder ratio visible on your spectrum
+analyser. This way, you will be able to see a the
change.
```