Merge branch 'master' into maint-3.8

Author: daniestevez

CHANGELOG.md

@@ -4,6 +4,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+## [3.6.0] - 2020-12-04
+
+### Added
+- PDU add metadata block
+- PDU Head/Tail block
+- Lucky-7 image receiver
+- Support for custom SIDS servers
+- Support for AISTECHSAT-2 custom protocol
+- Support for BOBCAT-1
+- Support for BY03
+- Support for FossaSat-1B and FossaSat-2
+- Support for NEUTRON-1
+- Support for SPOC
+- Support for TTU-100
+- Support for VZLUSAT-2
+
+### Changed
+- Replaced boost::bind() by C++ lambdas
+- Refactored Reed-Solomon decoder C++ blocks
+- Refactored CCSDS deframer blocks to allow more generality
+- Make --clk_limit parameter relative to samples per symbol
+- Updated AISTECHSAT-2 transmit frequency
+- Definitive NORAD IDs for NETSAT 1-4
+
+### Removed
+- Deprecated Astrocast 9k6 deframer in favour of the new CCSDS Reed-Solomon deframer
+- Deprecated CC11xx remove length, Header remover and Strip AX.25 header in favour of PDU Head/Tail
+
 ## [3.5.2] - 2020-10-21
 
 ### Changed
@@ -288,7 +318,8 @@ 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/v3.5.2...master
+[Unreleased]: https://github.com/daniestevez/gr-satellites/compare/v3.6.0...master
+[3.6.0]: https://github.com/daniestevez/gr-satellites/compare/v3.5.2...v3.6.0
 [3.5.2]: https://github.com/daniestevez/gr-satellites/compare/v3.5.1...v3.5.2
 [3.5.1]: https://github.com/daniestevez/gr-satellites/compare/v3.5.0...v3.5.1
 [3.5.0]: https://github.com/daniestevez/gr-satellites/compare/v3.4.0...v3.5.0

CMakeLists.txt

@@ -43,8 +43,8 @@ list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_SOURCE_DIR}/cmake/Modules)
 
 # Set the version information here
 set(VERSION_MAJOR 3)
-set(VERSION_API 5)
-set(VERSION_ABI 2)
+set(VERSION_API 6)
+set(VERSION_ABI 0)
 
 cmake_policy(SET CMP0011 NEW)
 
@@ -143,6 +143,15 @@ else(DOXYGEN_FOUND)
     option(ENABLE_DOXYGEN "Build docs using Doxygen" OFF)
 endif(DOXYGEN_FOUND)
 
+########################################################################
+# Setup manpage option
+########################################################################
+if(NOT WIN32)
+    option(ENABLE_MANPAGES "Build man pages for commands" ON)
+else(NOT WIN32)
+    option(ENABLE_MANPAGES "Build man pages for commands" OFF)
+endif(NOT WIN32)
+
 ########################################################################
 # Create uninstall target
 ########################################################################

README.md

@@ -39,7 +39,7 @@ Currently there are the following series of releases in the history of
 gr-satellites:
 
 * `v3.x.y` is the result of a large refactor that introduces a lot of
-  new functionality and improvements. The refactore started on September
+  new functionality and improvements. The refactor started on September
   2019 and was finished in May 2020.
 
 * `v2.x.y` is a series of releases compatible with GNU Radio 3.8 that existed

debian/changelog

@@ -1,5 +1,11 @@
-gr-satellites (3.5.0-0) UNRELEASED; urgency=medium
+gr-satellites (3.5.2-1) groovy; urgency=medium
+
+  * Fix dh_installman problems
+
+ --  <[email protected]>  Fri, 27 Nov 2020 15:56:58 +0000
+
+gr-satellites (3.5.2-0) groovy; urgency=medium
 
   * Initial release
 
- --  <[email protected]>  Sat, 19 Sep 2020 20:17:36 +0000
+ --  <[email protected]>  Fri, 27 Nov 2020 15:25:00 +0000

debian/rules

@@ -2,3 +2,7 @@
 
 %:
 	dh $@ --with python3
+
+# Do not run dh_installman
+override_dh_installman:
+

docs/CMakeLists.txt

@@ -39,6 +39,8 @@ endif(ENABLE_DOXYGEN)
 ########################################################################
 # Man pages
 ########################################################################
+if(ENABLE_MANPAGES)
+
 FIND_PROGRAM(BZIP
              NAMES bzip2
              PATHS /bin
@@ -70,3 +72,5 @@ foreach(manpage ${manpages})
        DESTINATION ${MAN_INSTALL_DIR}/man1
     )
 endforeach(manpage)
+
+endif(ENABLE_MANPAGES)

docs/source/command_line.rst

@@ -495,6 +495,8 @@ certain satellite projects:
 
 * `Harbin Institute of Technology`_, which connects to the telemetry proxy included in
   `gr-lilacsat`_ and `gr-dslwp`_.
+
+* Any custom server using the SIDS protocol.
 
 To enable telemetry submission, it is necessary to edit some parameters in
 ``gr_satellites``'s config file, which is located in
@@ -554,7 +556,10 @@ through the proxy is disabled for this run).
    The Harbin Institute of Technology proxy is a Python2 application that uses
    PyQt4. Users having more modern sytems may find useful the PyQt5 version that
    can be found in the `pyqt5 branch of gr-lilacsat`_. This requires ``tornado`` version
-   4.5.3. It will not work with more recent versions of ``tornado``. 
+   4.5.3. It will not work with more recent versions of ``tornado``.
+
+No special configuration needs to be done to enable submission to custom SIDS servers,
+since these use the same protocol and configuration as SatNOGS DB.
 
 For some telemetry servers, including SatNOGS DB, the frames are submitted
 together with a timestamp of reception. This timestamp is taken from the
@@ -573,8 +578,8 @@ displayed in real time as they are being received, using `feh`_.
 
 Currently the satellites that have decoders supporting file reception are ATL-1
 and SMOG-P (they transmit RF spectrum data), and the satellites that have
-decoders supporting image reception are 1KUNS-PF, BY70-1, D-SAT, LilacSat-1 and
-Światowid.
+decoders supporting image reception are 1KUNS-PF, BY70-1, D-SAT, LilacSat-1,
+Lucky-7 and Światowid.
 
 For satellites supporting file reception, the ``--file_output_path`` parameter
 can be used to set the directory that is used to store received files. The

docs/source/components.rst

@@ -382,7 +382,8 @@ Blue Book (see the `CCSDS Blue Books`_).
 
 The CCSDS Reed-Solomon deframer implements Reed-Solomon TM frames, which use a
 Reed-Solmon (255, 223) code (or a shortened version of this code) and the CCSDS
-synchronous scrambler. The CCSDS Concatenated deframer implements
+synchronous scrambler. There is support for several interleave Reed-Solomon codewords.
+The CCSDS Concatenated deframer implements
 concatenated TM frames, which add an r=1/2, k=7 convolutional code as an inner
 coding to the Reed-Solomon frames. The usage of both deframers is very similar.
 
@@ -403,16 +404,18 @@ Message Debug block.
 The figure below shows the options used by the CCSDS Concatenated
 deframer. The CCSDS Reed-Solomon deframer block allows exactly the same options,
 except for the *Convolutional code* option,
-since all the other options refer to the convolutional inner code.
+since all the other options refer to the Reed-Solomon outer code.
 
 The *Frame size* option indicates the size of the frame in bytes (after
-Reed-Solomon decoding). The *Differential encoding* option enables differential
-decoding, which is often used to solve the BPSK 180º phase ambiguity. The
-*Use RS dual basis* option enables the usage of the dual basis definition for the Reed-Solmon
-code. The *Use scrambler* option enables or disables the use of the CCSDS synchronous
-descrambler. Most satellites using CCSDS frames use scrambling.
-The *Convolutional code* option can be used to toggle between the CCSDS/NASA-GSFC
-(most usual and default) and NASA-DSN conventions for the convolutional code.
+Reed-Solomon decoding). The *Precoding* option can be used enable a differential
+decoder before the Reed-Solomon decoder.
+This is often used to solve the BPSK 180º phase ambiguity.
+The *Reed-Solomon basis* option can be used to toggle between the conventional
+and dual basis definitions of the Reed-Solomon code. The CCSDS standard
+specifies the dual basis, but the conventional basis is frequently used. The
+*Reed-Solomon interleve depth* option can be used to enable decoding of interleaved
+Reed-Solomon codewords. The *Scrambler* option can be used to enable or disable
+the CCSDS synchronous scrambler.
 The *Syncword threshold* option can be used to choose the number of bit
 errors that are allowed in the detection of the syncword.
 

docs/source/conf.py

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

docs/source/images/ccsds_deframer_flowgraph.png

@@ -9,8 +9,10 @@ decoders for Amateur satellites.
    :caption: Contents:
 
    introduction.rst
+   installation_intro.rst
    installation.rst
    installation_conda.rst
+   installation_ppa.rst
    overview.rst
    command_line.rst
    satellite_decoder.rst

docs/source/images/ccsds_deframer_options.png

@@ -1,14 +1,11 @@
+.. _Installing from source:
+
 Installing from source
 ======================
 
-gr-satellites is a GNU Radio out-of-tree module, and can be installed as
-such, by building it from source in a system where GNU Radio is already
-installed. Alternatively, it is possible to
-:ref:`install gr-satellites and GNU Radio <Installing using conda>`, and this
-might provide an easier or quicker way of installation, especially in
-Linux distributions where GNU Radio is not so easy to install, or in macOS.
-
-The general steps for installing gr-satellites from source include making sure that
+gr-satellites is a GNU Radio out-of-tree module, and can be installed as such,
+by building it from source in a system where GNU Radio is already installed. The
+general steps for installing gr-satellites from source include making sure that
 all the dependencies are installed and then building and installing the
 out-of-tree module.
 

docs/source/index.rst

@@ -0,0 +1,31 @@
+Installation
+============
+
+There are currently three major ways to install gr-satellites:
+
+* :ref:`Building from source <Installing from source>`
+* :ref:`Installing using conda <Installing using conda>`
+* :ref:`Using the Ubuntu PPA <Installing using the Ubuntu PPA>`
+
+Installing from the Ubuntu PPA is the easiest and recommended way to install
+gr-satellites in Ubuntu 20.10 and later versions.
+
+Conda is a multi-platform package manager that can be used to install
+gr-satellites and its dependencies (such as GNU Radio) in a virtual environment
+that does not clash with the system-wide set up. It is the recommended way to
+install gr-satellites in Windows and macOS, and also in Linux distributions
+which do not include GNU Radio 3.8.
+
+It is also possible to build gr-satellites from source, which is easy to do on
+Linux systems, and perhaps also macOS, but not in Windows.
+
+Finally, there are a number of distributions that provide their own packages for
+gr-satellites:
+
+* `Arch Linux`_, through the AUR
+* `Debian Linux`_ (testing and unstable releases)
+* `MacPorts`_
+
+.. _Arch Linux: https://aur.archlinux.org/packages/gr-satellites-git/
+.. _Debian Linux: https://packages.debian.org/sid/gr-satellites
+.. _MacPorts: https://ports.macports.org/port/gr-satellites/

docs/source/installation.rst

@@ -0,0 +1,22 @@
+.. _Installing using the Ubuntu PPA:
+
+Installing from the Ubuntu PPA
+==============================
+
+The `Ubuntu PPA`_ is an easy way to install the latest version of gr-satellites
+in Ubuntu 20.10 and later.
+
+To use the PPA, it must first be added to the system by doing
+
+.. code-block:: console
+
+   $ sudo add-apt-repository ppa:daniestevez/gr-satellites
+   $ sudo apt-get update
+
+Then gr-satellites can be installed by doing
+
+.. code-block:: console
+
+   $ sudo apt-get install gr-satellites
+
+.. _Ubuntu PPA: https://launchpad.net/~daniestevez/+archive/ubuntu/gr-satellites/