changed version (major!), updated documenation

utat-ss · Sep 15, 2024 · 26394f4 · 26394f4
1 parent 48ea784
commit 26394f4
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# v3.0.0
+
+## Fixes
+
+- Block `ESTTC Deframer`
+    - Reduced number of clock bytes necessary.
+    - This was causing a lot of packet loss.
+- Deleted deprecated blocks
+    - `HERON RX BB`
+    - A lot of helper classes that weren't being used or being used by deleted blocks
+- Documentation
+    - Initiated preliminary documenation
+    - Lot of work needs to be done, but this is a start!
+
 # v2.1.1
 
 ## Fixes

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,7 +17,7 @@ set(CMAKE_BUILD_TYPE "Release" CACHE STRING "")
 cmake_minimum_required(VERSION 3.8)
 project(gr-UTAT_HERON
     LANGUAGES CXX C
-    VERSION 2.1.1 # VERSION INFO BELOW ASWELL!!
+    VERSION 3.0.0 # VERSION INFO BELOW ASWELL!!
     DESCRIPTION "GNURadio OutOfTree module for UTAT HERON Mk II"
     HOMEPAGE_URL "https://github.com/utat-ss/HERON-gr-utat"
 )
@@ -36,10 +36,10 @@ find_package(Gnuradio "3.10" REQUIRED COMPONENTS blocks digital filter analog ff
 
 # Set the version information here
 # cmake-format: off
-set(VERSION_MAJOR 2)
-set(VERSION_API   1)
-set(VERSION_ABI   0)
-set(VERSION_PATCH 1)
+set(VERSION_MAJOR 3)
+set(VERSION_API   0)
+set(VERSION_ABI   0) # ignore
+set(VERSION_PATCH 0)
 # cmake-format: on
 
 cmake_policy(SET CMP0011 NEW)

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# gr-UTAT_HERON v2.1.1
+# gr-UTAT_HERON v3.0.0
 
 A GNURadio out-of-tree module for the HERON Mk II ground station.
 

diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in
@@ -48,7 +48,7 @@ PROJECT_NAME           = "@PROJECT_NAME@"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = "@PROJECT_VERSION@"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/docs/doxygen/other/group_defs.dox b/docs/doxygen/other/group_defs.dox
@@ -1,6 +1,11 @@
 /*!
- * \defgroup block Signal Processing Blocks
- * \brief All C++ blocks that can be used from the UTAT_HERON GNU Radio
- *        module are listed here or in the subcategories below.
- *
+ * \defgroup framing Protocol framers and deframers
+ * \brief Blocks that can wrap and unwrap datalink layer protocols.
+ * 
+ * \defgroup digital Digital manipulation
+ * \brief Blocks used to alter/maniuplate digital packets
+ * 
+ * \defgroup utils Utilities
+ * \brief Blocks used to control the flowgraph
+ * 
  */
diff --git a/include/gnuradio/UTAT_HERON/esttc_deframer.h b/include/gnuradio/UTAT_HERON/esttc_deframer.h
@@ -16,7 +16,7 @@ namespace UTAT_HERON {
 
 /*!
  * \brief Identifies ESTTC packets from bitstream, and outputs the payload as PDU
- * \ingroup UTAT_HERON
+ * \ingroup framing
  */
 class UTAT_HERON_API esttc_deframer : virtual public gr::hier_block2
 {

diff --git a/include/gnuradio/UTAT_HERON/esttc_framer.h b/include/gnuradio/UTAT_HERON/esttc_framer.h
@@ -16,7 +16,7 @@ namespace UTAT_HERON {
 
 /*!
  * \brief Generates valid ESTTC packets with the input as the payload
- * \ingroup UTAT_HERON
+ * \ingroup framing
  *
  */
 class UTAT_HERON_API esttc_framer : virtual public gr::hier_block2

diff --git a/include/gnuradio/UTAT_HERON/header_format_esttc.h b/include/gnuradio/UTAT_HERON/header_format_esttc.h
@@ -17,6 +17,7 @@ namespace UTAT_HERON {
 
 /*!
  * \brief Contains instructions on how to generate/indentify ESTTC packet headers
+ * \ingroup framing
  *
  * This block does not generate/check CRC. Its primary purpose is to provide information about
  * packet headers for other blocks to use to actually perform framing and deframing.

diff --git a/include/gnuradio/UTAT_HERON/tagged_stream_fixed_length_padder.h b/include/gnuradio/UTAT_HERON/tagged_stream_fixed_length_padder.h
@@ -16,7 +16,7 @@ namespace UTAT_HERON {
 
 /*!
  * \brief Generate data padding to ensure correct number of samples are generated at the end
- * \ingroup UTAT_HERON
+ * \ingroup digital
  *
  * Adding padding to IQ data is not a good idea since IQ signals need to follow specific patterns.
  * Padding should be added to the actual data before modulation. However, we cannot determine the

diff --git a/include/gnuradio/UTAT_HERON/variable_filter.h b/include/gnuradio/UTAT_HERON/variable_filter.h
@@ -16,7 +16,7 @@ namespace UTAT_HERON {
 
 /*!
  * \brief Allow messages to pass through with specific keys
- * \ingroup UTAT_HERON
+ * \ingroup utils
  */
 class UTAT_HERON_API variable_filter : virtual public gr::block
 {