Commit Graph

25 Commits

Author SHA1 Message Date
Robin Müller 05495077ec
doc update 2022-03-28 20:53:39 +02:00
Robin Müller 8ff9eadf30
update changelog, add basic instructions for etl 2022-03-28 20:43:36 +02:00
Robin Müller eac7e6db07
try readme tweak 2022-02-22 11:40:31 +01:00
Robin Müller 6744a55b9b docs update 2022-02-14 16:31:13 +01:00
Robin Mueller 751de7accc
Merge remote-tracking branch 'upstream/development' into mueller/cfdp-pdus 2022-02-01 11:00:57 +01:00
Robin Müller 602fa3a956 Merge remote-tracking branch 'upstream/development' into mueller/cfdp-pdus 2021-12-06 16:12:06 +01:00
Robin Müller cbcfa8fe56 Merge remote-tracking branch 'upstream/development' into mueller/clang-shell-script 2021-12-06 15:06:05 +01:00
Robin Müller 5907f8ee9d
Added CFDP packet stack
This PR adds the packet stack for the CCSDS File Delivery Protocol.
It also refactors the existing TMTC infastructure to allow sending
of CFDP packets to the CCSDS handlers.

This includes the whole PDU (Protocol Data Unit) stack:

- File Data PDUs

and all file directive PDUs

- Metadata PDU
- Finished PDU
- Prompt PDU
- Keep Alive PDU

The PR includes a full set of unittests for the packet stack
with a coverage of 90+ %.

The refactoring of the existing TMTC infastructure includes non-ideal
solutions like diamond inheritance.
Avoiding this solution would require refactoring the packet stack.
This would be a good idea anyway because the existing stack is tightly
coupled to the FSFW, making reuse more difficult if only the stack is
planned to be used without the store functionalities etc.

The PDU implementation provided here is only weakly coupled to the FSFW,
only using components like returnvalues or the Serialization modules.
There are dedicated serializers and deserializers, which also helps in
creating small focused modules which are easy to test.

Some of the modules here were provied by Matthias Tompert.
2021-12-03 15:37:49 +01:00
Robin Müller 15dddd7fc4
small README section for formatting 2021-12-01 16:17:27 +01:00
Robin Müller c2bf09d506 Introducing documentation with Sphinx
This PR introduces the generation of documentation based on
this excellent blog post:

It combines the tools Sphinx, Doxygen and Breathe to generate good
looking HTML documentation conveniently which can be hosted easily.

The helper scripts were unified and there is now one script
which can be used to create, build and open both tests and documentation.
"./ -h" can be used to get the different options.

This PR also contains some smaller fixes which were necessary for the docs
to build
2021-12-01 11:17:28 +01:00
Robin Müller ad744fb593
README improvement 2021-10-11 15:56:04 +02:00
Robin Müller 6c75b56054
README update 2021-10-11 15:51:27 +02:00
Robin Müller ade15ad16d
tests can now be built as part of FSFW
This PR refactores the tests so they are built as part of the FSFW.
This is done by adding Catch2 with the FetchContent directive.

A future implementation might also use a system installation of Catch2
by first checking whether Catch2 can already be found as a package

The custom configuration folder testcfg was moved from the user folder
to the actual unittest folder.

The tests can be built by setting the CMake FSFW_BUILD_UNITTESTS option
to TRUE/ON. They are built with the static library and dropped inside
the build folders fsfw directory.
2021-10-07 13:24:46 +02:00
Robin Müller ec00a84b29
update README for moved logo 2021-08-03 18:46:50 +02:00
Robin Müller b7060a9c78
update README 2021-05-18 15:35:47 +02:00
Robin Müller 482f240995 doc update 2021-01-13 11:39:19 +01:00
Robin Müller 820731de7b updated docs, added new doc folder 2020-12-22 13:23:19 +01:00
Steffen Gaisser 64b6edab6f Update '' 2020-12-01 13:32:50 +01:00
Steffen Gaisser 4241c00448 Added the new logos, colors are WIP at the moment 2020-11-30 18:30:58 +01:00
Jakob Meier 227ec25e89 some minor corrections in readme 2020-11-27 11:44:11 +01:00
Steffen Gaisser 5b5f2f3e1d Added hardware recommendations 2020-11-17 09:42:38 +01:00
Steffen Gaisser 51443d7a68 Version number 2020-11-13 15:09:00 +01:00
Steffen Gaisser 8aef4b9b99 Updated formatting 2020-11-13 14:36:32 +01:00
Steffen Gaisser 752601e85f WIP readme 2020-11-13 14:31:30 +01:00
Robin Müller 247c9f2947 added readme 2020-10-20 17:39:11 +02:00