From c9bfc8464aede0f79c167e18c5c0c79ded2444ce Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Sat, 11 Sep 2021 17:39:42 +0200
Subject: [PATCH] added function to enable periodic reply

---
 src/fsfw/devicehandlers/DeviceHandlerBase.cpp | 23 +++++++++++------
 src/fsfw/devicehandlers/DeviceHandlerBase.h   | 25 +++++++++++++------
 2 files changed, 33 insertions(+), 15 deletions(-)

diff --git a/src/fsfw/devicehandlers/DeviceHandlerBase.cpp b/src/fsfw/devicehandlers/DeviceHandlerBase.cpp
index 1a7fbc91..95e25b74 100644
--- a/src/fsfw/devicehandlers/DeviceHandlerBase.cpp
+++ b/src/fsfw/devicehandlers/DeviceHandlerBase.cpp
@@ -430,12 +430,7 @@ ReturnValue_t DeviceHandlerBase::insertInReplyMap(DeviceCommandId_t replyId,
     DeviceReplyInfo info;
     info.maxDelayCycles = maxDelayCycles;
     info.periodic = periodic;
-    if(info.periodic) {
-        info.delayCycles = info.maxDelayCycles;
-    }
-    else {
-        info.delayCycles = 0;
-    }
+    info.delayCycles = 0;
     info.replyLen = replyLen;
     info.dataSet = dataSet;
     info.command = deviceCommandMap.end();
@@ -474,7 +469,7 @@ ReturnValue_t DeviceHandlerBase::updateReplyMapEntry(DeviceCommandId_t deviceRep
     auto replyIter = deviceReplyMap.find(deviceReply);
     if (replyIter == deviceReplyMap.end()) {
         triggerEvent(INVALID_DEVICE_COMMAND, deviceReply);
-        return RETURN_FAILED;
+        return COMMAND_NOT_SUPPORTED;
     } else {
         DeviceReplyInfo *info = &(replyIter->second);
         if (maxDelayCycles != 0) {
@@ -486,6 +481,20 @@ ReturnValue_t DeviceHandlerBase::updateReplyMapEntry(DeviceCommandId_t deviceRep
     }
 }
 
+ReturnValue_t DeviceHandlerBase::enablePeriodicReply(DeviceCommandId_t deviceReply) {
+    auto replyIter = deviceReplyMap.find(deviceReply);
+    if (replyIter == deviceReplyMap.end()) {
+        triggerEvent(INVALID_DEVICE_COMMAND, deviceReply);
+        return COMMAND_NOT_SUPPORTED;
+    } else {
+        DeviceReplyInfo *info = &(replyIter->second);
+        if(not info->periodic) {
+            return COMMAND_NOT_SUPPORTED;
+        }
+        info->delayCycles = info->maxDelayCycles;
+    }
+    return HasReturnvaluesIF::RETURN_OK;
+}
 
 ReturnValue_t DeviceHandlerBase::setReplyDataset(DeviceCommandId_t replyId,
         LocalPoolDataSetBase *dataSet) {
diff --git a/src/fsfw/devicehandlers/DeviceHandlerBase.h b/src/fsfw/devicehandlers/DeviceHandlerBase.h
index 53bd1e65..d478b0fa 100644
--- a/src/fsfw/devicehandlers/DeviceHandlerBase.h
+++ b/src/fsfw/devicehandlers/DeviceHandlerBase.h
@@ -449,7 +449,9 @@ protected:
      * @param replyLen Will be supplied to the requestReceiveMessage call of
      * the communication interface.
      * @param periodic	Indicates if the command is periodic (i.e. it is sent
-     * by the device repeatedly without request) or not. Default is aperiodic (0)
+     * by the device repeatedly without request) or not. Default is aperiodic (0).
+     * Please note that periodic replies are disabled by default. You can enable them with
+     * #enablePeriodicReplies
      * @return	- @c RETURN_OK when the command was successfully inserted,
      *          - @c RETURN_FAILED else.
      */
@@ -464,7 +466,9 @@ protected:
      * @param maxDelayCycles The maximum number of delay cycles the reply waits
      * until it times out.
      * @param periodic	Indicates if the command is periodic (i.e. it is sent
-     * by the device repeatedly without request) or not. Default is aperiodic (0)
+     * by the device repeatedly without request) or not. Default is aperiodic (0).
+     * Please note that periodic replies are disabled by default. You can enable them with
+     * #enablePeriodicReplies
      * @return	- @c RETURN_OK when the command was successfully inserted,
      *          - @c RETURN_FAILED else.
      */
@@ -480,6 +484,13 @@ protected:
      */
     ReturnValue_t insertInCommandMap(DeviceCommandId_t deviceCommand);
 
+    /**
+     * Enables a periodic reply for a given command. It sets to delay cycles to the specified
+     * maximum delay cycles for a given reply ID.
+     * @return
+     */
+    ReturnValue_t enablePeriodicReply(DeviceCommandId_t deviceReply);
+
     /**
      * @brief   This function returns the reply length of the next reply to read.
      *
@@ -493,16 +504,14 @@ protected:
     virtual size_t getNextReplyLength(DeviceCommandId_t deviceCommand);
 
     /**
-     * @brief 	This is a helper method to facilitate updating entries
-     *        	in the reply map.
+     * @brief 	This is a helper method to facilitate updating entries in the reply map.
      * @param deviceCommand	Identifier of the reply to update.
-     * @param delayCycles The current number of delay cycles to wait.
-     * As stated in #fillCommandAndCookieMap, to disable periodic commands,
-     * this is set to zero.
+     * @param delayCycles The current number of delay cycles to wait. As stated in
+     * #fillCommandAndReplyMap, to disable periodic commands, this is set to zero.
      * @param maxDelayCycles The maximum number of delay cycles the reply waits
      * until it times out. By passing 0 the entry remains untouched.
      * @param periodic Indicates if the command is periodic (i.e. it is sent
-     * by the device repeatedly without request) or not.Default is aperiodic (0).
+     * by the device repeatedly without request) or not. Default is aperiodic (0).
      * Warning: The setting always overrides the value that was entered in the map.
      * @return - @c RETURN_OK when the command was successfully inserted,
      *         - @c RETURN_FAILED else.