Merge branch 'mueller/dhb-docs' into mueller/master

CHANGELOG.md

@@ -1,4 +1,208 @@
-# Changed from ASTP 1.1.0 to 1.2.0
+Change Log
+=======
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [unreleased]
+
+# [v4.0.0]
+
+## Additions
+
+- CFDP Packet Stack and related tests added. It also refactors the existing TMTC infastructure to
+  allow sending of CFDP packets to the CCSDS handlers.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/528
+- added virtual function to print datasets
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/544
+- doSendRead Hook
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/545
+  
+### HAL additions
+
+- Linux Command Executor, which can execute shell commands in blocking and non-blocking mode
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/536
+- uio Mapper
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/543
+
+## Changes
+
+- Applied the `clang-format` auto-formatter to all source code
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/534
+- Updated Catch2 to v3.0.0-preview4
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/538
+- Changed CI to use prebuilt docker image
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/549
+
+## Bugfix
+
+- CMake fixes in PR https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/533 , was problematic
+  if the uppermost user `CMakeLists.txt` did not have the include paths set up properly, which
+  could lead to compile errors that `#include "fsfw/FSFW.h"` was not found.
+- Fix for build regression in Catch2 v3.0.0-preview4
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/548
+
+## API Changes
+
+- Aforementioned changes to existing TMTC stack
+
+## Known bugs
+
+- 
+
+# [v3.0.1]
+
+## API Changes
+
+* 
+
+## Bugfixes
+
+* Version number was not updated for v3.0.0 #542
+
+## Enhancement
+
+* 
+
+## Known bugs
+
+* 
+
+# [v3.0.0]
+
+## API Changes
+
+#### TCP Socket Changes
+
+* Keep Open TCP Implementation #496
+    * The socket will now kept open after disconnect. This allows reconnecting. 
+    * Only one connection is allowed
+    * No internal influence but clients need to change their Code.
+
+### GPIO IF
+
+* Add feature to open GPIO by line name #506
+
+### Bitutil
+
+* Unittests for Op Divider and Bitutility #510
+
+### Filesystem IF changed
+
+*  Filesystem Base Interface: Use IF instead of void pointer #511 
+
+### STM32
+
+* STM32 SPI Updates #518
+
+## Bugfixes
+
+* Small bugfix for LIS3 handler #504
+* Spelling fixed for function names #509
+* CMakeLists fixes #517
+* Out of bound reads and writes in unittests #519
+* Bug in TmPacketStoredPusC (#478)
+* Windows ifdef fixed #529
+
+## Enhancement
+
+* FSFW.h.in more default values #491
+* Minor updates for PUS services #498
+* HasReturnvaluesIF naming for parameter #499
+* Tests can now be built as part of FSFW and versioning moved to CMake #500
+*  Added integration test code #508 
+* More printouts for rejected TC packets #505
+* Arrayprinter format improvements #514
+* Adding code for CI with docker and jenkins #520
+* Added new function in SerializeAdapter  #513
+    *  Enables simple deSerialize if you keep track of the buffer position yourself
+    *  `` static ReturnValue_t deSerialize(T *object, const uint8_t* buffer,
+            size_t* deserSize, SerializeIF::Endianness streamEndianness) ``
+* Unittest helper scripts has a new Parameter to open the coverage html in the webrowser  #525
+    * ``'-o', '--open', Open coverage data in webbrowser`` 
+* Documentation updated. Sphinx Documentation can now be build with python script #526
+
+## Known bugs
+
+* Version number was not updated for v3.0.0 #542
+
+
+All Pull Requests:
+
+Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/19
+
+# [v2.0.0]
+
+## API Changes
+
+
+### File Structure changed to fit more common structure
+
+* See pull request (#445)
+  * HAL is now part of the main project
+    * **See Instructions below:**
+
+#### Instruction how to update existing / user code
+
+* Changes in `#include`:
+  * Rename `internalError` in includes to `internalerror`
+  * Rename `fsfw/hal` to `fsfw_hal`
+  * Rename `fsfw/tests` to `fsfw_tests`
+  * Rename `osal/FreeRTOS` to `osal/freertos`
+
+* Changes in `CMakeLists.txt`: 
+  * Rename `OS_FSFW` to `FSFW_OSAL`
+
+* Changes in `DleEncoder.cpp`
+    * Create an instance of the `DleEncoder` first before calling the `encode` and `decode` functions
+
+### Removed osal/linux/Timer (#486)
+
+* Was redundant to timemanager/Countdown
+
+#### Instruction how to update existing / user code
+
+* Use timemanager/Countdown instead
+
+## Bugfixes
+
+### TM Stack
+
+* Increased TM stack robustness by introducing `nullptr` checks and more printouts (#483)
+
+#### Host OSAL / FreeRTOS 
+
+* QueueMapManager Bugfix (NO_QUEUE was used as MessageQueueId) (#444)
+
+#### Events
+
+* Event output is now consistent (#447)
+
+#### DLE Encoder
+
+* Fixed possible out of bounds access in DLE Encoder (#492)
+
+## Enhancment
+
+* HAL as major new feature, also includes three MEMS devicehandlers as part of #481
+* Linux HAL updates (#456)
+* FreeRTOS Header cleaning update and Cmake tweaks (#442)
+* Printer updates (#453)
+* New returnvalue for for empty PST (#485)
+* TMTC Bridge: Increase limit of packets stored (#484)
+
+## Known bugs
+
+* Bug in TmPacketStoredPusC (#478)
+
+
+All Pull Requests:
+
+Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/5
+
+# [v1.2.0]
 
 ## API Changes
 
@@ -27,7 +231,7 @@
 
 - See API changes chapter. This change will keep the internal API consistent in the future
 
-# Changes from ASTP 1.0.0 to 1.1.0
+# [v1.1.0]
 
 ## API Changes
 

CMakeLists.txt

@@ -1,8 +1,8 @@
 cmake_minimum_required(VERSION 3.13)
 
-set(FSFW_VERSION 2)
+set(FSFW_VERSION 3)
 set(FSFW_SUBVERSION 0)
-set(FSFW_REVISION 0)
+set(FSFW_REVISION 1)
 
 # Add the cmake folder so the FindSphinx module is found
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
@@ -60,6 +60,8 @@ if(FSFW_BUILD_UNITTESTS)
         )
 
         FetchContent_MakeAvailable(Catch2)
+        #fixes regression -preview4, to be confirmed in later releases
+        set_target_properties(Catch2 PROPERTIES DEBUG_POSTFIX "")
     endif()
 
     set(FSFW_CONFIG_PATH tests/src/fsfw_tests/unit/testcfg)

automation/Dockerfile

@@ -6,9 +6,3 @@ RUN apt-get --yes upgrade
 #tzdata is a dependency, won't install otherwise
 ARG DEBIAN_FRONTEND=noninteractive
 RUN apt-get --yes install gcc g++ cmake make lcov git valgrind nano iputils-ping
-
-RUN git clone https://github.com/catchorg/Catch2.git && \
-	cd Catch2 && \
-	git checkout v3.0.0-preview4 && \
-	cmake -Bbuild -H. -DBUILD_TESTING=OFF && \
-	cmake --build build/ --target install

automation/Jenkinsfile

@@ -3,13 +3,7 @@ pipeline {
         BUILDDIR = 'build-tests'
     }
     agent {
-        dockerfile {
+        docker { image 'fsfw-ci:d1'}
-            dir 'automation'
-            //force docker to redownload base image and rebuild all steps instead of caching them
-            //this way, we always get an up to date docker image one each build
-            additionalBuildArgs  '--no-cache --pull'
-            reuseNode true
-        }
     }
     stages {
         stage('Clean') {

docs/devicehandlers.rst

@@ -1,10 +1,13 @@
+.. _dhb-prim-doc:
+
 Device Handlers
 ==================
 
-Device handler components rerpresent, control and monitor equipment, for example sensors or actuators of a spacecraft or the payload.
+Device handler components represent, control and monitor equipment, for example sensors or actuators
+of a spacecraft or the payload.
 
 Most device handlers have the same common functionality or
-requirements, which are fulfilled by implementing an certain interface:
+requirements, which are fulfilled by implementing certain interfaces:
 
 - The handler/device needs to be commandable: :cpp:class:`HasActionsIF`
 - The handler needs to communicate with the physical device via a dedicated
@@ -17,7 +20,7 @@ requirements, which are fulfilled by implementing an certain interface:
 - The handler has modes. For example there are the core modes `MODE_ON`, `MODE_OFF`
   and `MODE_NORMAL` provided by the FSFW. `MODE_ON` means that a device is physically powered
   but that it is not periodically polling data from the
-  physical device, `MODE_NORMAL` means that it is able to do that: :cpp:class`HasModesIF`
+  physical device, `MODE_NORMAL` means that it is able to do that: :cpp:class:`HasModesIF`
 
 The device handler base therefore provides abstractions for a lot of common
 functionality, which can potentially avoid high amounts or logic and code duplication.
@@ -60,6 +63,7 @@ functions implemented:
 and the respective source file with sensible default return values:
 
 .. code-block:: cpp
+
 	#include "TestDeviceHandler.h"
 
 	TestDeviceHandler::TestDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* cookie)

docs/highlevel.rst

@@ -118,7 +118,7 @@ The DH has mechanisms to monitor the communication with the physical device whic
 for FDIR reaction.  Device Handlers can be created by implementing ``DeviceHandlerBase``.
 A standard FDIR component for the DH will be created automatically but can
 be overwritten by the user. More information on DeviceHandlers can be found in the
-related [documentation section](doc/README-devicehandlers.md#top).
+related :ref:`documentation section <dhb-prim-doc>`.
 
 Modes and Health
 --------------------