Documentation and Config
Added/Updated README's and added the config file required to run the signal
generator tool.
Change-Id: I6c3a9e95f1e9f2cb39cb6635e555a7460ce6e0cd
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2f78cf5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*.pyc
+
diff --git a/signal_generator/README b/signal_generator/README
index a422a75..3904791 100644
--- a/signal_generator/README
+++ b/signal_generator/README
@@ -4,10 +4,19 @@
with differing strengths. The script takes in arguments by specifying a type of
signal to broadcast followed by the corresponding parameters for that signal.
This script requires the user to specify at least 1 signal in order to operate.
-In order to broadcast from file, use the '-f' flag and specify the path to the
-file as well as a factor which corresponds to a db-gain on the specific signal.
-A general db-gain can also be specified by using the '-g' flag to amplify the
-combined signal.
+
+The script currently supports 4 types of signals:
+
+1) It can broadcast a signal from a raw data file which is generated by a file
+ source in GNURadio and by the bandpass_recorder.py script included in this
+ project.
+2) Periodic - Generates a single sine wave at a specified offset from the
+ center frequency and should show up as a spike in the fourier transform.
+3) Wifi - Mimics a wifi signal. The type-specific signals like this require
+ that a config file be specified. The parameters of this signal can be
+ generated using signal_analyzer.py. It also requires a signal profile stored
+ in a .npy file.
+4) Bluetooth - Mimics a Bluetooth signal. See Wifi for description.
Usage: signal_generator.py [options]
@@ -16,5 +25,6 @@
Note: If you are playing from a file and are getting Underruns (U), try moving
the file to local storage.
-A set of useful recordings have been placed at "/google/data/rw/teams/gfiber/sdr/recordings"
-that can be used for testing or other purposes.
+A set of useful recordings and signal profiles have been placed at
+"/google/data/rw/teams/gfiber/sdr/recordings" that can be used for testing or
+other purposes.
diff --git a/signal_generator/bluetooth.npy b/signal_generator/bluetooth.npy
new file mode 100644
index 0000000..cb3c831
--- /dev/null
+++ b/signal_generator/bluetooth.npy
Binary files differ
diff --git a/signal_generator/signals.config b/signal_generator/signals.config
new file mode 100644
index 0000000..e3b22e8
--- /dev/null
+++ b/signal_generator/signals.config
@@ -0,0 +1,11 @@
+[bluetooth]
+length=17533
+duty=0.254440
+amplitude=0.172925
+profile='bluetooth.npy'
+
+[wifi]
+length=136
+duty=0.361137
+amplitude=0.967984
+profile='wifi.npy'
diff --git a/signal_generator/wifi.npy b/signal_generator/wifi.npy
new file mode 100644
index 0000000..6825ffb
--- /dev/null
+++ b/signal_generator/wifi.npy
Binary files differ
diff --git a/udp_test/README b/udp_test/README
new file mode 100644
index 0000000..c66c06c
--- /dev/null
+++ b/udp_test/README
@@ -0,0 +1,13 @@
+UDP Test Tool
+===============================================================================
+The UDP Test tool is a connection testing tool that is similar to iperf. This
+tool has been created partially due to limitations in iperf. This tool is
+designed to test downstream throughput and measures the speed of a connection
+by sending UDP traffic very quickly to a downstream client and measuring the
+packet loss and adjusting the send rate accordingly.
+
+There are currently some issues with the UDP Test tool. Right now, it is not
+able to show similar rates as iperf (using tcp). UDP should be faster than
+TCP and so presumably the transmit rates of the tool should be higher. Because
+of this it seems that the UDP Test tool is not impacted significantly by
+interference. A good alternative is to use iperf with the -i and -t options.
