1 files changed, 57 insertions, 0 deletions
diff --git a/loragw_band_survey/README.TXT b/loragw_band_survey/README.TXT
new file mode 100644
index 0000000..da4e672
--- /dev/null
+++ b/loragw_band_survey/README.TXT
@@ -0,0 +1,57 @@
+	 / _____)             _              | |    
+	( (____  _____ ____ _| |_ _____  ____| |__  
+	 \____ \| ___ |    (_   _) ___ |/ ___)  _ \ 
+	 _____) ) ____| | | || |_| ____( (___| | | |
+	(______/|_____)_|_|_| \__)_____)\____)_| |_|
+		Š2013 Semtech-Cycleo
+
+Lora Gateway RF band survey application
+========================================
+
+1. Introduction
+----------------
+
+This software is used to scan the RF band and measure background RSSI and some
+measurement of interferer pattern.
+The RSSI is purposefully skew towards high values, to detect high power
+interferers (eg. a gateway installed in the beam of a powerful base station),
+and not to characterize the noise floor, or accurately measure the time-domain
+profile of interferers.
+
+2. Dependencies
+----------------
+
+This software call functions in the loragw_reg and loragw_reg sub-modules of
+loragwlib. loragw_spi is used indirectly, and the loragw_hal sub-module is not
+used at all, except for constants define at the top level.
+
+It has been qualified with the Lora Getway HAL library version beta8, and should
+be compatible with any compatible later version that use the same API, or a
+downward-compatible one.
+
+Because some non-public functions from loragw_hal had to be re-implemented, any
+change in the IP might affect this program even if an updated Lora Getway HAL
+library is provided.
+Connecting an incompatible concentrator board should give you the error:
+"ERROR: fail to connect to concentrator board"
+
+3. Usage
+---------
+
+To stop the application before the end of the measurement, press Ctrl+C.
+
+By default, the program scans the whole band (start and stop frequency defined in
+the loragw_hal.h file) with a 200 kHz measurement step.
+Use -f option to change start and stop frequency, and measurement step.
+
+The resolution bandwidth of the scan is 200 kHz and cannot be set by the user.
+
+The measurement results are put in a CSV file whose name include a UTC timestamp
+of measurement starting time in ISO 8601 recommended compact format:
+yyyymmddThhmmssZ (eg. 20131009T172345Z for October 9th, 2013 at 5:23:45PM UTC)
+
+4. Changelog
+-------------
+
+2013-10-18, beta 1
+Initial version.