aboutsummaryrefslogtreecommitdiffstats
path: root/tools/gr-usrptest/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/gr-usrptest/README.md')
-rw-r--r--tools/gr-usrptest/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/tools/gr-usrptest/README.md b/tools/gr-usrptest/README.md
new file mode 100644
index 000000000..bc8a70c1d
--- /dev/null
+++ b/tools/gr-usrptest/README.md
@@ -0,0 +1,18 @@
+# gr-usrptest OOT-Module
+
+## Usage
+This OOT is used to run GNU Radio based tests on various USRPs and daughterboards catch regressions.
+
+## Structure
+gr-usrptest follows the structure of a regular OOT-Module with some additions.
+The python directory contains a couple additional submodules.
+ - flowgraphs
+ - Contains dynamically configured GNU Radio flowgraphs.
+ - rts_tests
+ - Contains tests which can be run unsupervised and store results
+ - labview_control
+ - Contains classes and functions to control a remote LabVIEW instance with python_labview_automation
+
+## Applications
+ - usrp_phasealignment.py
+ - calculates phase differences between an arbitrary number of USRP devices. Runs phase difference measurement a speficied number of times and retunes the USRP daugtherboards to a random frequency between measurements. Prints average phase difference and standard deviation for every measurement in human readable format.