Merge branch 'main' into maint-3.10

Author: daniestevez

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [5.1.1], [4.8.1], [3.15.1] - 2022-11-19
+
+### Fixed
+- RMS AGC block in aarch64 systems
+
 ## [5.1.0], [4.8.0], [3.15.0] - 2022-10-24
 
 ### Added
@@ -541,9 +546,11 @@ Large refactor release bringing new functionality and improvements. This is an o
 ## [1.0.0] - 2018-08-02
 First gr-satellites release using semantic versioning
 
-[Unreleased]: https://github.com/daniestevez/gr-satellites/compare/v5.1.0...main
+[Unreleased]: https://github.com/daniestevez/gr-satellites/compare/v5.1.1...main
+[5.1.1]: https://github.com/daniestevez/gr-satellites/compare/v5.1.0...v5.1.1
 [5.1.0]: https://github.com/daniestevez/gr-satellites/compare/v5.0.0...v5.1.0
 [5.0.0]: https://github.com/daniestevez/gr-satellites/compare/v4.6.0...v5.0.0
+[4.8.1]: https://github.com/daniestevez/gr-satellites/compare/v4.8.0...v4.8.1
 [4.8.0]: https://github.com/daniestevez/gr-satellites/compare/v4.7.0...v4.8.0
 [4.7.0]: https://github.com/daniestevez/gr-satellites/compare/v4.6.0...v4.7.0
 [4.6.0]: https://github.com/daniestevez/gr-satellites/compare/v4.5.0...v4.6.0
@@ -555,7 +562,8 @@ First gr-satellites release using semantic versioning
 [4.1.0]: https://github.com/daniestevez/gr-satellites/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/daniestevez/gr-satellites/compare/v4.0.0-rc1...v4.0.0
 [4.0.0-rc1]: https://github.com/daniestevez/gr-satellites/compare/v3.7.0...v4.0.0-rc1
-[3.14.0]: https://github.com/daniestevez/gr-satellites/compare/v3.14.0...v3.15.0
+[3.15.1]: https://github.com/daniestevez/gr-satellites/compare/v3.15.0...v3.15.1
+[3.15.0]: https://github.com/daniestevez/gr-satellites/compare/v3.14.0...v3.15.0
 [3.14.0]: https://github.com/daniestevez/gr-satellites/compare/v3.13.0...v3.14.0
 [3.13.0]: https://github.com/daniestevez/gr-satellites/compare/v3.12.0...v3.13.0
 [3.12.0]: https://github.com/daniestevez/gr-satellites/compare/v3.11.0...v3.12.0

CMakeLists.txt

@@ -44,7 +44,7 @@ list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_SOURCE_DIR}/cmake/Modules)
 # Set the version information here
 set(VERSION_MAJOR 5)
 set(VERSION_API 1)
-set(VERSION_ABI 0)
+set(VERSION_ABI 1)
 set(VERSION_PATCH 0)
 
 cmake_policy(SET CMP0011 NEW)

docs/source/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '5.1.0'
+release = '5.1.1'
 
 
 # -- General configuration ---------------------------------------------------

python/__init__.py

@@ -19,7 +19,7 @@
 ad-hoc protocols used in other satellites.
 """
 
-__version__ = 'v5.1.0'
+__version__ = 'v5.1.1'
 __author__ = 'Daniel Estevez'
 __copyright__ = 'Copyright 2016-2022 Daniel Estevez'
 __email__ = '[email protected]'

python/hier/CMakeLists.txt

@@ -50,4 +50,6 @@ GR_PYTHON_INSTALL(
 include(GrTest)
 
 set(GR_TEST_TARGET_DEPS gnuradio-satellites)
-set(GR_TEST_PYTHON_DIRS ${CMAKE_BINARY_DIR}/swig)
+set(GR_TEST_PYTHON_DIRS ${CMAKE_BINARY_DIR} ${CMAKE_BINARY_DIR}/swig)
+GR_ADD_TEST(qa_rms_agc ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/qa_rms_agc.py)
+GR_ADD_TEST(qa_rms_agc_f ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/qa_rms_agc_f.py)

python/hier/qa_rms_agc.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2022 Daniel Estevez <[email protected]>
+#
+# This file is part of gr-satellites
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gnuradio import gr, blocks, gr_unittest
+import numpy as np
+import pmt
+
+# bootstrap satellites module, even from build dir
+try:
+    import python as satellites
+except ImportError:
+    pass
+else:
+    import sys
+    sys.modules['satellites'] = satellites
+
+from satellites.hier import rms_agc
+
+
+class qa_rms_agc(gr_unittest.TestCase):
+    def setUp(self):
+        self.tb = gr.top_block()
+
+    def tearDown(self):
+        self.tb = None
+
+    def test_zero_input(self):
+        """Tests that if the input is zero, the output is also zero.
+
+        In some architectures we have found that the calculations produce nan
+        if the number that we put in the denominator to avoid 0/0 is too small.
+        """
+        n = 256
+        source = blocks.vector_source_c([0] * n, False, 1, [])
+        sink = blocks.vector_sink_c(1, n)
+        agc = rms_agc(alpha=1e-2, reference=1.0)
+        self.tb.connect(source, agc, sink)
+
+        self.tb.start()
+        self.tb.wait()
+
+        expected = np.zeros(n, 'complex64')
+        np.testing.assert_equal(
+            sink.data(), expected, 'AGC output is not zero')
+
+
+if __name__ == '__main__':
+    gr_unittest.run(qa_rms_agc)

python/hier/qa_rms_agc_f.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Copyright 2022 Daniel Estevez <[email protected]>
+#
+# This file is part of gr-satellites
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from gnuradio import gr, blocks, gr_unittest
+import numpy as np
+import pmt
+
+# bootstrap satellites module, even from build dir
+try:
+    import python as satellites
+except ImportError:
+    pass
+else:
+    import sys
+    sys.modules['satellites'] = satellites
+
+from satellites.hier import rms_agc_f
+
+
+class qa_rms_agc_f(gr_unittest.TestCase):
+    def setUp(self):
+        self.tb = gr.top_block()
+
+    def tearDown(self):
+        self.tb = None
+
+    def test_zero_input(self):
+        """Tests that if the input is zero, the output is also zero.
+
+        In some architectures we have found that the calculations produce nan
+        if the number that we put in the denominator to avoid 0/0 is too small.
+        """
+        n = 256
+        source = blocks.vector_source_f([0] * n, False, 1, [])
+        sink = blocks.vector_sink_f(1, n)
+        agc = rms_agc_f(alpha=1e-2, reference=1.0)
+        self.tb.connect(source, agc, sink)
+
+        self.tb.start()
+        self.tb.wait()
+
+        expected = np.zeros(n, 'float32')
+        np.testing.assert_equal(
+            sink.data(), expected, 'AGC output is not zero')
+
+
+if __name__ == '__main__':
+    gr_unittest.run(qa_rms_agc_f)

python/hier/rms_agc.grc

@@ -55,7 +55,7 @@ blocks:
     affinity: ''
     alias: ''
     comment: ''
-    const: 1e-20
+    const: 1e-19
     maxoutbuf: '0'
     minoutbuf: '0'
     type: float

python/hier/rms_agc.py

@@ -36,7 +36,7 @@ def __init__(self, alpha=1e-2, reference=0.5):
             blocks.multiply_const_ff(1.0/reference))
         self.blocks_float_to_complex_0 = blocks.float_to_complex(1)
         self.blocks_divide_xx_0 = blocks.divide_cc(1)
-        self.blocks_add_const_vxx_0 = blocks.add_const_ff(1e-20)
+        self.blocks_add_const_vxx_0 = blocks.add_const_ff(1e-19)
 
         ##################################################
         # Connections

python/hier/rms_agc_f.py

@@ -38,7 +38,7 @@ def __init__(self, alpha=1e-2, reference=0.5):
         self.blocks_multiply_const_vxx_0 = (
             blocks.multiply_const_ff(1.0/reference))
         self.blocks_divide_xx_0 = blocks.divide_ff(1)
-        self.blocks_add_const_vxx_0 = blocks.add_const_ff(1e-20)
+        self.blocks_add_const_vxx_0 = blocks.add_const_ff(1e-19)
 
         ##################################################
         # Connections