kit-cel · ryanvolz · May 7, 2024 · Feb 18, 2025 · Feb 20, 2025
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,7 @@
+# In GNU Radio 3.9+, pybind11 compares hash values of headers and source
+# files against knowns values.  Conversion of values to CRLF on checkout
+# break those checks so keep LF values when files are subject to said checks
+#
+*.h    text eol=lf
+*.c    text eol=lf
+*.cc   text eol=lf
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -74,7 +74,7 @@ if(NOT CMAKE_MODULES_DIR)
   set(CMAKE_MODULES_DIR lib${LIB_SUFFIX}/cmake)
 endif(NOT CMAKE_MODULES_DIR)
 
-set(GR_INCLUDE_DIR      include/radar)
+set(GR_INCLUDE_DIR      include/gnuradio/radar)
 set(GR_CMAKE_DIR        ${CMAKE_MODULES_DIR}/gnuradio-radar)
 set(GR_PKG_DATA_DIR     ${GR_DATA_DIR}/${CMAKE_PROJECT_NAME})
 set(GR_PKG_DOC_DIR      ${GR_DOC_DIR}/${CMAKE_PROJECT_NAME})
@@ -132,9 +132,10 @@ add_custom_target(uninstall
 ########################################################################
 # Add subdirectories
 ########################################################################
-add_subdirectory(include/radar)
+add_subdirectory(include/gnuradio/radar)
 add_subdirectory(lib)
 add_subdirectory(apps)
+add_subdirectory(examples)
 add_subdirectory(docs)
 # NOTE: manually update below to use GRC to generate C++ flowgraphs w/o python
 if(ENABLE_PYTHON)
@@ -160,3 +161,6 @@ configure_package_config_file(
     INSTALL_DESTINATION ${GR_CMAKE_DIR}
 )
 
+install(FILES MANIFEST.yml
+    RENAME MANIFEST-${VERSION_MAJOR}.${VERSION_API}.${VERSION_ABI}${VERSION_PATCH}.yml
+    DESTINATION share/gnuradio/manifests/radar)
diff --git a/MANIFEST.md b/MANIFEST.md
diff --git a/MANIFEST.yml b/MANIFEST.yml
@@ -0,0 +1,25 @@
+title: The RADAR OOT Module
+version: 1.0
+brief: GNU Radio Radar Toolbox
+tags: # Tags are arbitrary, but look at CGRAN what other authors are using
+  - radar
+  - UHD
+author:
+  - Stefan Wunsch <stefan.wunsch@student.kit.edu>
+copyright_owner:
+  - Stefan Wunsch
+  - Communications Engineering Lab (CEL) at Karlsruhe Institute of Technology (KIT)
+license: GPL-3.0-or-later
+gr_supported_version:
+  - 3.7
+  - 3.8
+  - 3.9
+  - 3.10
+repo: https://github.com/kit-cel/gr-radar
+website: https://grradar.wordpress.com
+#icon: # Put a URL to a square image here that will be used as an icon
+description: |-
+  The *gr-radar* project provides a toolbox of commonly used radar algorithms. An important part is the *UHD Echotimer*, which enables a synchronized TX and RX stream from USRPs to ensure a constant phase relation in measurements. Example flowgraphs for CW, Dual CW, FSK, FMCW and OFDM radar are given and partly tested on hardware. GUI elements for target representation and further signal processing algorithms such as target tracking are implemented. Check out the project website for example videos and further information.
+
+  This project was initiated as a Google Summer of Code project and developed at the *Communication Engineering Lab (CEL)* at the *Karlsruhe Institute of Technology (KIT)*, Germany, <http://www.cel.kit.edu>.
+file_format: 1
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -0,0 +1,28 @@
+install(
+    FILES simulation/simulator_cw.grc
+          simulation/simulator_dual_cw_estimation_rcs.grc
+          simulation/simulator_dual_cw.grc
+          simulation/simulator_fmcw_rcs.grc
+          simulation/simulator_fmcw.grc
+          simulation/simulator_fsk_tracking_singletarget.grc
+          simulation/simulator_fsk.grc
+          simulation/simulator_ofdm.grc
+          simulation/simulator_sync_pulse.grc
+          tests/test_find_max_peak_c.grc
+          tests/test_msg_manipulator.grc
+          tests/test_signal_generator_cw_c.grc
+          tests/test_signal_generator_fmcw_c.grc
+          tests/test_split_cc.grc
+          tests/test_static_target_simulator_cc.grc
+          tests/test_ts_fft_cc.grc
+          tests/test_uhd_sink_source_inbuild.grc
+          tests/test_usrp_echotimer_cc.grc
+          usrp/usrp_echotimer_cw.grc
+          usrp/usrp_echotimer_dual_cw_rcs.grc
+          usrp/usrp_echotimer_dual_cw_tracking.grc
+          usrp/usrp_echotimer_dual_cw.grc
+          usrp/usrp_echotimer_fmcw.grc
+          usrp/usrp_echotimer_fsk_tracking_singletarget.grc
+          usrp/usrp_echotimer_fsk.grc
+          usrp/usrp_echotimer_sync_pulse.grc
+    DESTINATION share/gnuradio/examples/radar)
diff --git a/include/radar/CMakeLists.txt → include/gnuradio/radar/CMakeLists.txt b/include/radar/CMakeLists.txt → include/gnuradio/radar/CMakeLists.txt
@@ -53,5 +53,5 @@ install(FILES
     estimator_ofdm.h
     estimator_rcs.h
     trigger_command.h
-    DESTINATION include/radar
+    DESTINATION include/gnuradio/radar
 )
diff --git a/include/radar/api.h → include/gnuradio/radar/api.h b/include/radar/api.h → include/gnuradio/radar/api.h
diff --git a/include/radar/crop_matrix_vcvc.h → include/gnuradio/radar/crop_matrix_vcvc.h b/include/radar/crop_matrix_vcvc.h → include/gnuradio/radar/crop_matrix_vcvc.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_CROP_MATRIX_VCVC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_cw.h → include/gnuradio/radar/estimator_cw.h b/include/radar/estimator_cw.h → include/gnuradio/radar/estimator_cw.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_CW_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_fmcw.h → include/gnuradio/radar/estimator_fmcw.h b/include/radar/estimator_fmcw.h → include/gnuradio/radar/estimator_fmcw.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_FMCW_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_fsk.h → include/gnuradio/radar/estimator_fsk.h b/include/radar/estimator_fsk.h → include/gnuradio/radar/estimator_fsk.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_FSK_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_ofdm.h → include/gnuradio/radar/estimator_ofdm.h b/include/radar/estimator_ofdm.h → include/gnuradio/radar/estimator_ofdm.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_OFDM_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_rcs.h → include/gnuradio/radar/estimator_rcs.h b/include/radar/estimator_rcs.h → include/gnuradio/radar/estimator_rcs.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_RCS_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/estimator_sync_pulse_c.h → ...e/gnuradio/radar/estimator_sync_pulse_c.h b/include/radar/estimator_sync_pulse_c.h → ...e/gnuradio/radar/estimator_sync_pulse_c.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_ESTIMATOR_SYNC_PULSE_C_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/find_max_peak_c.h → include/gnuradio/radar/find_max_peak_c.h b/include/radar/find_max_peak_c.h → include/gnuradio/radar/find_max_peak_c.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_FIND_MAX_PEAK_C_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/msg_gate.h → include/gnuradio/radar/msg_gate.h b/include/radar/msg_gate.h → include/gnuradio/radar/msg_gate.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_MSG_GATE_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/msg_manipulator.h → include/gnuradio/radar/msg_manipulator.h b/include/radar/msg_manipulator.h → include/gnuradio/radar/msg_manipulator.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_MSG_MANIPULATOR_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/...de/radar/ofdm_cyclic_prefix_remover_cvc.h → ...io/radar/ofdm_cyclic_prefix_remover_cvc.h b/...de/radar/ofdm_cyclic_prefix_remover_cvc.h → ...io/radar/ofdm_cyclic_prefix_remover_cvc.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_OFDM_CYCLIC_PREFIX_REMOVER_CVC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/ofdm_divide_vcvc.h → include/gnuradio/radar/ofdm_divide_vcvc.h b/include/radar/ofdm_divide_vcvc.h → include/gnuradio/radar/ofdm_divide_vcvc.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_OFDM_DIVIDE_VCVC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/os_cfar_2d_vc.h → include/gnuradio/radar/os_cfar_2d_vc.h b/include/radar/os_cfar_2d_vc.h → include/gnuradio/radar/os_cfar_2d_vc.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_OS_CFAR_2D_VC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/os_cfar_c.h → include/gnuradio/radar/os_cfar_c.h b/include/radar/os_cfar_c.h → include/gnuradio/radar/os_cfar_c.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_OS_CFAR_C_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/print_results.h → include/gnuradio/radar/print_results.h b/include/radar/print_results.h → include/gnuradio/radar/print_results.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_PRINT_RESULTS_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/qtgui_scatter_plot.h → include/gnuradio/radar/qtgui_scatter_plot.h b/include/radar/qtgui_scatter_plot.h → include/gnuradio/radar/qtgui_scatter_plot.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_QTGUI_SCATTER_PLOT_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/qtgui_spectrogram_plot.h → ...e/gnuradio/radar/qtgui_spectrogram_plot.h b/include/radar/qtgui_spectrogram_plot.h → ...e/gnuradio/radar/qtgui_spectrogram_plot.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_QTGUI_SPECTROGRAM_PLOT_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/qtgui_time_plot.h → include/gnuradio/radar/qtgui_time_plot.h b/include/radar/qtgui_time_plot.h → include/gnuradio/radar/qtgui_time_plot.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_QTGUI_TIME_PLOT_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/signal_generator_cw_c.h → ...de/gnuradio/radar/signal_generator_cw_c.h b/include/radar/signal_generator_cw_c.h → ...de/gnuradio/radar/signal_generator_cw_c.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_SIGNAL_GENERATOR_CW_C_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/signal_generator_fmcw_c.h → .../gnuradio/radar/signal_generator_fmcw_c.h b/include/radar/signal_generator_fmcw_c.h → .../gnuradio/radar/signal_generator_fmcw_c.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_SIGNAL_GENERATOR_FMCW_C_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/signal_generator_fsk_c.h → ...e/gnuradio/radar/signal_generator_fsk_c.h b/include/radar/signal_generator_fsk_c.h → ...e/gnuradio/radar/signal_generator_fsk_c.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_SIGNAL_GENERATOR_FSK_C_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/...ude/radar/signal_generator_sync_pulse_c.h → ...dio/radar/signal_generator_sync_pulse_c.h b/...ude/radar/signal_generator_sync_pulse_c.h → ...dio/radar/signal_generator_sync_pulse_c.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_SIGNAL_GENERATOR_SYNC_PULSE_C_H
 
 #include <gnuradio/sync_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/split_cc.h → include/gnuradio/radar/split_cc.h b/include/radar/split_cc.h → include/gnuradio/radar/split_cc.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_SPLIT_CC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/split_fsk_cc.h → include/gnuradio/radar/split_fsk_cc.h b/include/radar/split_fsk_cc.h → include/gnuradio/radar/split_fsk_cc.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_SPLIT_FSK_CC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/static_target_simulator_cc.h → ...uradio/radar/static_target_simulator_cc.h b/include/radar/static_target_simulator_cc.h → ...uradio/radar/static_target_simulator_cc.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_STATIC_TARGET_SIMULATOR_CC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/tracking_singletarget.h → ...de/gnuradio/radar/tracking_singletarget.h b/include/radar/tracking_singletarget.h → ...de/gnuradio/radar/tracking_singletarget.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_TRACKING_SINGLETARGET_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/transpose_matrix_vcvc.h → ...de/gnuradio/radar/transpose_matrix_vcvc.h b/include/radar/transpose_matrix_vcvc.h → ...de/gnuradio/radar/transpose_matrix_vcvc.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_TRANSPOSE_MATRIX_VCVC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/trigger_command.h → include/gnuradio/radar/trigger_command.h b/include/radar/trigger_command.h → include/gnuradio/radar/trigger_command.h
@@ -23,7 +23,7 @@
 #define INCLUDED_RADAR_TRIGGER_COMMAND_H
 
 #include <gnuradio/block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/ts_fft_cc.h → include/gnuradio/radar/ts_fft_cc.h b/include/radar/ts_fft_cc.h → include/gnuradio/radar/ts_fft_cc.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_TS_FFT_CC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {

diff --git a/include/radar/usrp_echotimer_cc.h → include/gnuradio/radar/usrp_echotimer_cc.h b/include/radar/usrp_echotimer_cc.h → include/gnuradio/radar/usrp_echotimer_cc.h
@@ -22,7 +22,7 @@
 #define INCLUDED_RADAR_USRP_ECHOTIMER_CC_H
 
 #include <gnuradio/tagged_stream_block.h>
-#include <radar/api.h>
+#include <gnuradio/radar/api.h>
 
 namespace gr {
 namespace radar {