moved some code to fsfw

example/utility/CMakeLists.txt

@@ -0,0 +1,4 @@
+target_sources(${TARGET_NAME} PRIVATE
+	utility.cpp
+    TmFunnel.cpp
+)

example/utility/PusPacketCreator.cpp

@@ -0,0 +1,10 @@
+#include <fsfw/tmtcpacket/pus/tc.h>
+#include <fsfw/tmtcpacket/pus/tm.h>
+#include <fsfw/globalfunctions/arrayprinter.h>
+#include <fsfw/serviceinterface/ServiceInterface.h>
+#include <mission/utility/PusPacketCreator.h>
+
+void PusPacketCreator::createPusPacketAndPrint() {
+	// TODO: use TC packet stored here instead..
+
+}

example/utility/PusPacketCreator.h

@@ -0,0 +1,16 @@
+/*
+ * PusPacketCreator.h
+ *
+ *  Created on: 21.03.2019
+ *      Author: gaisser
+ */
+
+#ifndef MISSION_UTILITY_PUSPACKETCREATOR_H_
+#define MISSION_UTILITY_PUSPACKETCREATOR_H_
+
+class PusPacketCreator {
+public:
+	static void createPusPacketAndPrint();
+};
+
+#endif /* MISSION_UTILITY_PUSPACKETCREATOR_H_ */

example/utility/TaskCreation.h

@@ -0,0 +1,22 @@
+#ifndef MISSION_UTILITY_TASKCREATION_H_
+#define MISSION_UTILITY_TASKCREATION_H_
+
+#include <fsfw/objectmanager/SystemObjectIF.h>
+#include <fsfw/serviceinterface/ServiceInterface.h>
+
+namespace task {
+
+void printInitError(const char* objName, object_id_t objectId) {
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+	sif::error << "InitMission: Adding object " << objName << "("
+			<< std::setw(8) << std::setfill('0') << std::hex << objectId
+			<< std::dec << ") failed." << std::endl;
+#else
+	sif::printError("InitMission: Adding object %s (0x%08x) failed.\n",
+			objName, static_cast<unsigned int>(objectId));
+#endif
+}
+
+}
+
+#endif /* MISSION_UTILITY_TASKCREATION_H_ */

example/utility/TmFunnel.cpp

@@ -0,0 +1,120 @@
+#include "TmFunnel.h"
+
+#include <fsfw/ipc/QueueFactory.h>
+#include <fsfw/objectmanager/ObjectManager.h>
+#include <fsfw/tmtcpacket/pus/tm.h>
+#include <fsfw/serviceinterface/ServiceInterface.h>
+
+object_id_t TmFunnel::downlinkDestination = objects::NO_OBJECT;
+object_id_t TmFunnel::storageDestination = objects::NO_OBJECT;
+
+TmFunnel::TmFunnel(object_id_t objectId, uint32_t messageDepth):
+                SystemObject(objectId), messageDepth(messageDepth) {
+    tmQueue = QueueFactory::instance()->createMessageQueue(messageDepth,
+            MessageQueueMessage::MAX_MESSAGE_SIZE);
+    storageQueue = QueueFactory::instance()->createMessageQueue(messageDepth,
+            MessageQueueMessage::MAX_MESSAGE_SIZE);
+}
+
+TmFunnel::~TmFunnel() {
+}
+
+MessageQueueId_t TmFunnel::getReportReceptionQueue(uint8_t virtualChannel) {
+    return tmQueue->getId();
+}
+
+ReturnValue_t TmFunnel::performOperation(uint8_t operationCode) {
+    TmTcMessage currentMessage;
+    ReturnValue_t status = tmQueue->receiveMessage(&currentMessage);
+    while(status == HasReturnvaluesIF::RETURN_OK)
+    {
+        status = handlePacket(&currentMessage);
+        if(status != HasReturnvaluesIF::RETURN_OK){
+            break;
+        }
+        status = tmQueue->receiveMessage(&currentMessage);
+    }
+
+    if (status == MessageQueueIF::EMPTY) {
+        return HasReturnvaluesIF::RETURN_OK;
+    }
+    else {
+        return status;
+    }
+}
+
+ReturnValue_t TmFunnel::handlePacket(TmTcMessage* message) {
+    uint8_t* packetData = nullptr;
+    size_t size = 0;
+    ReturnValue_t result = tmPool->modifyData(message->getStorageId(),
+            &packetData, &size);
+    if(result != HasReturnvaluesIF::RETURN_OK){
+        return result;
+    }
+    TmPacketPusC packet(packetData);
+    packet.setPacketSequenceCount(this->sourceSequenceCount);
+    sourceSequenceCount++;
+    sourceSequenceCount = sourceSequenceCount %
+            SpacePacketBase::LIMIT_SEQUENCE_COUNT;
+    packet.setErrorControl();
+
+    result = tmQueue->sendToDefault(message);
+    if(result != HasReturnvaluesIF::RETURN_OK){
+        tmPool->deleteData(message->getStorageId());
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+        sif::error << "TmFunnel::handlePacket: Error sending to downlink handler" << std::endl;
+#endif
+        return result;
+    }
+
+    if(storageDestination != objects::NO_OBJECT) {
+        result = storageQueue->sendToDefault(message);
+        if(result != HasReturnvaluesIF::RETURN_OK){
+            tmPool->deleteData(message->getStorageId());
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+            sif::error << "TmFunnel::handlePacket: Error sending to storage handler" << std::endl;
+#endif
+            return result;
+        }
+    }
+    return result;
+}
+
+ReturnValue_t TmFunnel::initialize() {
+
+    tmPool = ObjectManager::instance()->get<StorageManagerIF>(objects::TM_STORE);
+    if(tmPool == nullptr) {
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+        sif::error << "TmFunnel::initialize: TM store not set." << std::endl;
+        sif::error << "Make sure the tm store is set up properly and implements StorageManagerIF" <<
+                std::endl;
+#endif
+        return ObjectManagerIF::CHILD_INIT_FAILED;
+    }
+
+    AcceptsTelemetryIF* tmTarget = ObjectManager::instance()->
+            get<AcceptsTelemetryIF>(downlinkDestination);
+    if(tmTarget == nullptr){
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+        sif::error << "TmFunnel::initialize: Downlink Destination not set." << std::endl;
+        sif::error << "Make sure the downlink destination object is set up properly and implements "
+                "AcceptsTelemetryIF" << std::endl;
+#endif
+        return ObjectManagerIF::CHILD_INIT_FAILED;
+    }
+    tmQueue->setDefaultDestination(tmTarget->getReportReceptionQueue());
+
+    // Storage destination is optional.
+    if(storageDestination == objects::NO_OBJECT) {
+        return SystemObject::initialize();
+    }
+
+    AcceptsTelemetryIF* storageTarget = ObjectManager::instance()->
+            get<AcceptsTelemetryIF>(storageDestination);
+    if(storageTarget != nullptr) {
+        storageQueue->setDefaultDestination(
+                storageTarget->getReportReceptionQueue());
+    }
+
+    return SystemObject::initialize();
+}

example/utility/TmFunnel.h

@@ -0,0 +1,51 @@
+#ifndef MISSION_UTILITY_TMFUNNEL_H_
+#define MISSION_UTILITY_TMFUNNEL_H_
+
+#include <fsfw/objectmanager/SystemObject.h>
+#include <fsfw/tasks/ExecutableObjectIF.h>
+#include <fsfw/tmtcservices/AcceptsTelemetryIF.h>
+#include <fsfw/ipc/MessageQueueIF.h>
+#include <fsfw/tmtcservices/TmTcMessage.h>
+
+namespace Factory{
+void setStaticFrameworkObjectIds();
+}
+
+/**
+ * @brief       TM Recipient.
+ * @details
+ * Main telemetry receiver. All generated telemetry is funneled into
+ * this object.
+ * @ingroup     utility
+ * @author      J. Meier
+ */
+class TmFunnel:
+        public AcceptsTelemetryIF,
+        public ExecutableObjectIF,
+        public SystemObject {
+    friend void (Factory::setStaticFrameworkObjectIds)();
+public:
+    TmFunnel(object_id_t objectId, uint32_t messageDepth = 20);
+    virtual ~TmFunnel();
+
+    virtual MessageQueueId_t getReportReceptionQueue(
+            uint8_t virtualChannel = 0) override;
+    virtual ReturnValue_t performOperation(uint8_t operationCode = 0) override;
+    virtual ReturnValue_t initialize() override;
+
+protected:
+    static object_id_t downlinkDestination;
+    static object_id_t storageDestination;
+
+private:
+    uint16_t sourceSequenceCount = 0;
+    MessageQueueIF* tmQueue = nullptr;
+    MessageQueueIF* storageQueue = nullptr;
+
+    StorageManagerIF* tmPool = nullptr;
+    uint32_t messageDepth = 0;
+
+    ReturnValue_t handlePacket(TmTcMessage* message);
+};
+
+#endif /* MISSION_UTILITY_TMFUNNEL_H_ */

example/utility/compile_time.h

@@ -0,0 +1,97 @@
+/*
+ *
+ * Created: 29.03.2018
+ *
+ * Authors:
+ *
+ * Assembled from the code released on Stackoverflow by:
+ *   Dennis (instructable.com/member/nqtronix)    |   https://stackoverflow.com/questions/23032002/c-c-how-to-get-integer-unix-timestamp-of-build-time-not-string
+ * and
+ *   Alexis Wilke                                 |   https://stackoverflow.com/questions/10538444/do-you-know-of-a-c-macro-to-compute-unix-time-and-date
+ *
+ * Assembled by Jean Rabault
+ *
+ * UNIX_TIMESTAMP gives the UNIX timestamp (unsigned long integer of seconds since 1st Jan 1970) of compilation from macros using the compiler defined __TIME__ macro.
+ * This should include Gregorian calendar leap days, in particular the 29ths of February, 100 and 400 years modulo leaps.
+ *
+ * Careful: __TIME__ is the local time of the computer, NOT the UTC time in general!
+ *
+ */
+
+#ifndef COMPILE_TIME_H_
+#define COMPILE_TIME_H_
+
+// Some definitions for calculation
+#define SEC_PER_MIN             60UL
+#define SEC_PER_HOUR            3600UL
+#define SEC_PER_DAY             86400UL
+#define SEC_PER_YEAR            (SEC_PER_DAY*365)
+
+// extracts 1..4 characters from a string and interprets it as a decimal value
+#define CONV_STR2DEC_1(str, i)  (str[i]>'0'?str[i]-'0':0)
+#define CONV_STR2DEC_2(str, i)  (CONV_STR2DEC_1(str, i)*10 + str[i+1]-'0')
+#define CONV_STR2DEC_3(str, i)  (CONV_STR2DEC_2(str, i)*10 + str[i+2]-'0')
+#define CONV_STR2DEC_4(str, i)  (CONV_STR2DEC_3(str, i)*10 + str[i+3]-'0')
+
+// Custom "glue logic" to convert the month name to a usable number
+#define GET_MONTH(str, i)      (str[i]=='J' && str[i+1]=='a' && str[i+2]=='n' ? 1 :     \
+                                str[i]=='F' && str[i+1]=='e' && str[i+2]=='b' ? 2 :     \
+                                str[i]=='M' && str[i+1]=='a' && str[i+2]=='r' ? 3 :     \
+                                str[i]=='A' && str[i+1]=='p' && str[i+2]=='r' ? 4 :     \
+                                str[i]=='M' && str[i+1]=='a' && str[i+2]=='y' ? 5 :     \
+                                str[i]=='J' && str[i+1]=='u' && str[i+2]=='n' ? 6 :     \
+                                str[i]=='J' && str[i+1]=='u' && str[i+2]=='l' ? 7 :     \
+                                str[i]=='A' && str[i+1]=='u' && str[i+2]=='g' ? 8 :     \
+                                str[i]=='S' && str[i+1]=='e' && str[i+2]=='p' ? 9 :     \
+                                str[i]=='O' && str[i+1]=='c' && str[i+2]=='t' ? 10 :    \
+                                str[i]=='N' && str[i+1]=='o' && str[i+2]=='v' ? 11 :    \
+                                str[i]=='D' && str[i+1]=='e' && str[i+2]=='c' ? 12 : 0)
+
+// extract the information from the time string given by __TIME__ and __DATE__
+#define __TIME_SECONDS__        CONV_STR2DEC_2(__TIME__, 6)
+#define __TIME_MINUTES__        CONV_STR2DEC_2(__TIME__, 3)
+#define __TIME_HOURS__          CONV_STR2DEC_2(__TIME__, 0)
+#define __TIME_DAYS__           CONV_STR2DEC_2(__DATE__, 4)
+#define __TIME_MONTH__          GET_MONTH(__DATE__, 0)
+#define __TIME_YEARS__          CONV_STR2DEC_4(__DATE__, 7)
+
+// Days in February
+#define _UNIX_TIMESTAMP_FDAY(year) \
+    (((year) % 400) == 0UL ? 29UL : \
+        (((year) % 100) == 0UL ? 28UL : \
+            (((year) % 4) == 0UL ? 29UL : \
+                28UL)))
+
+// Days in the year
+#define _UNIX_TIMESTAMP_YDAY(year, month, day) \
+    ( \
+        /* January */    day \
+        /* February */ + (month >=  2 ? 31UL : 0UL) \
+        /* March */    + (month >=  3 ? _UNIX_TIMESTAMP_FDAY(year) : 0UL) \
+        /* April */    + (month >=  4 ? 31UL : 0UL) \
+        /* May */      + (month >=  5 ? 30UL : 0UL) \
+        /* June */     + (month >=  6 ? 31UL : 0UL) \
+        /* July */     + (month >=  7 ? 30UL : 0UL) \
+        /* August */   + (month >=  8 ? 31UL : 0UL) \
+        /* September */+ (month >=  9 ? 31UL : 0UL) \
+        /* October */  + (month >= 10 ? 30UL : 0UL) \
+        /* November */ + (month >= 11 ? 31UL : 0UL) \
+        /* December */ + (month >= 12 ? 30UL : 0UL) \
+    )
+
+// get the UNIX timestamp from a digits representation
+#define _UNIX_TIMESTAMP(year, month, day, hour, minute, second) \
+    ( /* time */ second \
+                + minute * SEC_PER_MIN \
+                + hour * SEC_PER_HOUR \
+    + /* year day (month + day) */ (_UNIX_TIMESTAMP_YDAY(year, month, day) - 1) * SEC_PER_DAY \
+    + /* year */ (year - 1970UL) * SEC_PER_YEAR \
+                + ((year - 1969UL) / 4UL) * SEC_PER_DAY \
+                - ((year - 1901UL) / 100UL) * SEC_PER_DAY \
+                + ((year - 1601UL) / 400UL) * SEC_PER_DAY \
+    )
+
+// the UNIX timestamp
+#define UNIX_TIMESTAMP (_UNIX_TIMESTAMP(__TIME_YEARS__, __TIME_MONTH__, __TIME_DAYS__, __TIME_HOURS__, __TIME_MINUTES__, __TIME_SECONDS__))
+
+#endif

example/utility/utility.cpp

@@ -0,0 +1,22 @@
+#include "utility.h"
+#include <FSFWConfig.h>
+#include <OBSWVersion.h>
+
+#include <fsfw/serviceinterface/ServiceInterface.h>
+
+void utility::commonInitPrint(const char *const os, const char* const board) {
+    if(os == nullptr or board == nullptr) {
+        return;
+    }
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+    std::cout << "-- FSFW Example (" << os<< ") v" << FSFW_EXAMPLE_VERSION << "." <<
+            FSFW_EXAMPLE_SUBVERSION << "." << FSFW_EXAMPLE_REVISION  << " --" << std::endl;
+    std::cout << "-- Compiled for " << board << " --" << std::endl;
+    std::cout << "-- Compiled on " << __DATE__ << " " << __TIME__ << " --" << std::endl;
+#else
+    printf("\n\r-- FSFW Example (%s) v%d.%d.%d --\n", os, FSFW_EXAMPLE_VERSION,
+            FSFW_EXAMPLE_SUBVERSION, FSFW_EXAMPLE_REVISION);
+    printf("-- Compiled for %s --\n", board);
+    printf("-- Compiled on %s %s --\n", __DATE__, __TIME__);
+#endif
+}

example/utility/utility.h

@@ -0,0 +1,11 @@
+#ifndef COMMON_UTILITY_UTILITY_H_
+#define COMMON_UTILITY_UTILITY_H_
+
+namespace utility {
+
+void commonInitPrint(const char *const os, const char* const board);
+
+}
+
+
+#endif /* COMMON_UTILITY_UTILITY_H_ */