eive/eive-obsw
eive/eive-obsw
13
4
Fork 0
Code Issues 4 Pull Requests 1 Releases 120 Wiki Activity

v1.14.0 #304

Merged
muellerr merged 366 commits from develop into main 2022-10-10 17:46:38 +02:00
Conversation 0 Commits 366 Files Changed 420 +268 -269
11 changed files with 268 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 3ca11b5894 - Show all commits

1
bsp_hosted/CMakeLists.txt
View File

@ -1,5 +1,4 @@
target_sources(${OBSW_NAME} PUBLIC InitMission.cpp main.cpp ObjectFactory.cpp) target_sources(${OBSW_NAME} PUBLIC InitMission.cpp main.cpp ObjectFactory.cpp)
add_subdirectory(fsfwconfig) add_subdirectory(fsfwconfig)
add_subdirectory(boardconfig) add_subdirectory(boardconfig)

2
bsp_hosted/InitMission.cpp
View File

@ -173,8 +173,6 @@ void initmission::initTasks() {
} }
#endif /* OBSW_ADD_TEST_CODE == 1 */ #endif /* OBSW_ADD_TEST_CODE == 1 */
sif::info << "Starting tasks.." << std::endl; sif::info << "Starting tasks.." << std::endl;
tmTcDistributor->startTask(); tmTcDistributor->startTask();
tmtcBridgeTask->startTask(); tmtcBridgeTask->startTask();

5
bsp_hosted/ObjectFactory.cpp
View File

@ -26,7 +26,6 @@
#include <test/testtasks/TestTask.h> #include <test/testtasks/TestTask.h>
#endif #endif
#include "mission/utility/GlobalConfigHandler.h"
#include <dummies/AcuDummy.h> #include <dummies/AcuDummy.h>
#include <dummies/BpxDummy.h> #include <dummies/BpxDummy.h>
#include <dummies/ComCookieDummy.h> #include <dummies/ComCookieDummy.h>
@ -45,6 +44,8 @@
#include <dummies/SyrlinksDummy.h> #include <dummies/SyrlinksDummy.h>
#include <dummies/TemperatureSensorsDummy.h> #include <dummies/TemperatureSensorsDummy.h>
#include "mission/utility/GlobalConfigHandler.h"
void Factory::setStaticFrameworkObjectIds() { void Factory::setStaticFrameworkObjectIds() {
PusServiceBase::packetSource = objects::PUS_PACKET_DISTRIBUTOR; PusServiceBase::packetSource = objects::PUS_PACKET_DISTRIBUTOR;
PusServiceBase::packetDestination = objects::TM_FUNNEL; PusServiceBase::packetDestination = objects::TM_FUNNEL;
@ -90,6 +91,4 @@ void ObjectFactory::produce(void* args) {
new SusDummy(); new SusDummy();
new ThermalController(objects::THERMAL_CONTROLLER, objects::NO_OBJECT); new ThermalController(objects::THERMAL_CONTROLLER, objects::NO_OBJECT);
new TestTask(objects::TEST_TASK); new TestTask(objects::TEST_TASK);
} }

4
bsp_hosted/main.cpp
View File

@ -31,7 +31,9 @@ int main(void) {
<< "v" << common::OBSW_VERSION << " | FSFW v" << fsfw::FSFW_VERSION << " --" << "v" << common::OBSW_VERSION << " | FSFW v" << fsfw::FSFW_VERSION << " --"
<< std::endl; << std::endl;
std::cout << "-- " << __DATE__ << " " << __TIME__ << " --" << std::endl; std::cout << "-- " << __DATE__ << " " << __TIME__ << " --" << std::endl;
std::cout << "-- " <<" BSP HOSTED"<< " --" << std::endl; std::cout << "-- "
<< " BSP HOSTED"
<< " --" << std::endl;
initmission::initMission(); initmission::initMission();

2
mission/controller/CMakeLists.txt
View File

@ -1,3 +1,3 @@
if(TGT_BSP MATCHES "arm/q7s" OR TGT_BSP MATCHES "") if(TGT_BSP MATCHES "arm/q7s" OR TGT_BSP MATCHES "")
target_sources(${LIB_EIVE_MISSION} PRIVATE ThermalController.cpp) target_sources(${LIB_EIVE_MISSION} PRIVATE ThermalController.cpp)
endif() endif()

7
mission/tmtc/CMakeLists.txt
View File

@ -1,5 +1,2 @@
target_sources(${LIB_EIVE_MISSION} PRIVATE target_sources(${LIB_EIVE_MISSION} PRIVATE CCSDSHandler.cpp VirtualChannel.cpp
CCSDSHandler.cpp TmFunnel.cpp)
VirtualChannel.cpp
TmFunnel.cpp
)

5
mission/utility/CMakeLists.txt
View File

@ -1,2 +1,3 @@
target_sources(${LIB_EIVE_MISSION} PRIVATE TmFunnel.cpp Timestamp.cpp target_sources(
ProgressPrinter.cpp Filenaming.cpp GlobalConfigHandler.cpp) ${LIB_EIVE_MISSION} PRIVATE TmFunnel.cpp Timestamp.cpp ProgressPrinter.cpp
Filenaming.cpp GlobalConfigHandler.cpp)

3
mission/utility/GlobalConfigFileDefinitions.h
View File

@ -8,7 +8,6 @@
#ifndef MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_ #ifndef MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_
#define MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_ #define MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_
static constexpr double PARAM0_DEFAULT = 5.0; static constexpr double PARAM0_DEFAULT = 5.0;
static constexpr int PARAM1_DEFAULT = 905; static constexpr int PARAM1_DEFAULT = 905;
@ -18,6 +17,4 @@ enum ParamIds : uint8_t {
PARAM2 = 2, PARAM2 = 2,
}; };
#endif /* MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_ */ #endif /* MISSION_UTILITY_GLOBALCONFIGFILEDEFINITIONS_H_ */

347
mission/utility/GlobalConfigHandler.cpp
View File

@ -6,256 +6,263 @@
*/ */
#include "GlobalConfigHandler.h" #include "GlobalConfigHandler.h"
#include <fsfw/ipc/MutexFactory.h>
#include "fsfw/serviceinterface/ServiceInterface.h"
#include <fsfw/ipc/MessageQueueIF.h> #include <fsfw/ipc/MessageQueueIF.h>
#include <fsfw/ipc/MutexFactory.h>
#include <fsfw/ipc/QueueFactory.h> #include <fsfw/ipc/QueueFactory.h>
#include "fsfw/serviceinterface/ServiceInterface.h"
MutexIF* GlobalConfigHandler::configLock = nullptr; MutexIF* GlobalConfigHandler::configLock = nullptr;
GlobalConfigHandler::GlobalConfigHandler(object_id_t objectId, std::string configFilePath): GlobalConfigHandler::GlobalConfigHandler(object_id_t objectId, std::string configFilePath)
SystemObject(objectId), : SystemObject(objectId),
NVMParameterBase(configFilePath), NVMParameterBase(configFilePath),
commandQueue(QueueFactory::instance()->createMessageQueue(20)) commandQueue(QueueFactory::instance()->createMessageQueue(20)) {
{ if (configLock == nullptr) {
if (configLock == nullptr) { configLock = MutexFactory::instance()->createMutex();
configLock = MutexFactory::instance()->createMutex(); }
}
} }
ReturnValue_t GlobalConfigHandler::initialize(){ ReturnValue_t GlobalConfigHandler::initialize() {
ReturnValue_t result = SystemObject::initialize();
ReturnValue_t result = SystemObject::initialize(); if (result != RETURN_OK) {
if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::initialize: SystemObject::initialize() failed with " << result << std::endl; sif::info << "GlobalConfigHandler::initialize: SystemObject::initialize() failed with "
<< result << std::endl;
#endif #endif
return result; return result;
} }
result = ReadConfigFile();
result = ReadConfigFile(); if (result != RETURN_OK) {
if(result!=RETURN_OK){
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::initialize: Creating JSON file at " << getFullName() << std::endl; sif::info << "GlobalConfigHandler::initialize: Creating JSON file at " << getFullName()
<< std::endl;
#endif #endif
result=ResetConfigFile(); result = ResetConfigFile();
if (result != RETURN_OK) { if (result != RETURN_OK) {
return result; return result;
} }
} }
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::initialize success " << std::endl; sif::info << "GlobalConfigHandler::initialize success " << std::endl;
#endif #endif
return result; return result;
}
GlobalConfigHandler::~GlobalConfigHandler() {
} }
GlobalConfigHandler::~GlobalConfigHandler() {}
ReturnValue_t GlobalConfigHandler::performOperation(uint8_t operationCode) { ReturnValue_t GlobalConfigHandler::performOperation(uint8_t operationCode) {
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
sif::debug<<"GlobalConfigHandler::performOperation"<<std::endl; sif::debug << "GlobalConfigHandler::performOperation" << std::endl;
return result; return result;
} }
ReturnValue_t GlobalConfigHandler::lockConfigFile() {
ReturnValue_t GlobalConfigHandler::lockConfigFile(){
ReturnValue_t result = RETURN_OK;
result = configLock->lockMutex(MutexIF::TimeoutType::WAITING, 10);
return result;
}
ReturnValue_t GlobalConfigHandler::unlockConfigFile(){
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
result=configLock->unlockMutex(); result = configLock->lockMutex(MutexIF::TimeoutType::WAITING, 10);
return result;
}
ReturnValue_t GlobalConfigHandler::unlockConfigFile() {
ReturnValue_t result = RETURN_OK;
result = configLock->unlockMutex();
return result; return result;
} }
template <typename T> ReturnValue_t GlobalConfigHandler::setConfigFileValue(ParamIds paramID, T data){ template <typename T>
ReturnValue_t result = RETURN_OK; ReturnValue_t GlobalConfigHandler::setConfigFileValue(ParamIds paramID, T data) {
ReturnValue_t resultSet = RETURN_OK; ReturnValue_t result = RETURN_OK;
ReturnValue_t resultSet = RETURN_OK;
result=lockConfigFile(); result = lockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::setConfigFileValue lock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::setConfigFileValue lock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
std:: string paramString; std::string paramString;
paramString=PARAM_KEY_MAP[paramID]; paramString = PARAM_KEY_MAP[paramID];
//Check if key exists in map before setting value. No check is done in setValue! Somehow PARAM_KEY_MAP.count(paramID) == 0 does not work // Check if key exists in map before setting value. No check is done in setValue! Somehow
if (paramString.empty() == true) { // PARAM_KEY_MAP.count(paramID) == 0 does not work
if (paramString.empty() == true) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::setConfigFileValue ParamId " << PARAM_KEY_MAP[paramID]<<" not found!" << std::endl; sif::info << "GlobalConfigHandler::setConfigFileValue ParamId " << PARAM_KEY_MAP[paramID]
<< " not found!" << std::endl;
#endif #endif
triggerEvent(SET_CONFIGFILEVALUE_FAILED, 1, 0); triggerEvent(SET_CONFIGFILEVALUE_FAILED, 1, 0);
return RETURN_FAILED; return RETURN_FAILED;
} }
resultSet=setValue(PARAM_KEY_MAP[paramID], data); resultSet = setValue(PARAM_KEY_MAP[paramID], data);
if(resultSet!=RETURN_OK){ if (resultSet != RETURN_OK) {
triggerEvent(SET_CONFIGFILEVALUE_FAILED, 0, 0); triggerEvent(SET_CONFIGFILEVALUE_FAILED, 0, 0);
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::setConfigFileValue set json failed with " << resultSet << std::endl; sif::info << "GlobalConfigHandler::setConfigFileValue set json failed with " << resultSet
<< std::endl;
#endif #endif
} }
result = unlockConfigFile();
result=unlockConfigFile(); if (result != RETURN_OK) {
if (result!= RETURN_OK){
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::setConfigFileValue unlock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::setConfigFileValue unlock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
return resultSet; return resultSet;
} }
template <typename T> ReturnValue_t GlobalConfigHandler::getConfigFileValue(ParamIds paramID, T& data){ template <typename T>
ReturnValue_t result = RETURN_OK; ReturnValue_t GlobalConfigHandler::getConfigFileValue(ParamIds paramID, T& data) {
ReturnValue_t resultGet = RETURN_OK; ReturnValue_t result = RETURN_OK;
ReturnValue_t resultGet = RETURN_OK;
result=lockConfigFile(); result = lockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::getConfigFileValue lock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::getConfigFileValue lock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
resultGet=getValue(PARAM_KEY_MAP[paramID], data); resultGet = getValue(PARAM_KEY_MAP[paramID], data);
if (resultGet!= RETURN_OK){ if (resultGet != RETURN_OK) {
triggerEvent(GET_CONFIGFILEVALUE_FAILED, 0, 0); triggerEvent(GET_CONFIGFILEVALUE_FAILED, 0, 0);
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::getConfigFileValue getValue failed with " << resultGet << std::endl; sif::info << "GlobalConfigHandler::getConfigFileValue getValue failed with " << resultGet
<< std::endl;
#endif #endif
} }
result=unlockConfigFile(); result = unlockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::getConfigFileValue unlock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::getConfigFileValue unlock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
return resultGet; return resultGet;
} }
ReturnValue_t GlobalConfigHandler::resetConfigFileValues(){ ReturnValue_t GlobalConfigHandler::resetConfigFileValues() {
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
result=lockConfigFile(); result = lockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::resetConfigFileValues lock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::resetConfigFileValues lock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
insertValue(PARAM_KEY_MAP[PARAM0], PARAM0_DEFAULT); insertValue(PARAM_KEY_MAP[PARAM0], PARAM0_DEFAULT);
insertValue(PARAM_KEY_MAP[PARAM1], PARAM1_DEFAULT); insertValue(PARAM_KEY_MAP[PARAM1], PARAM1_DEFAULT);
result = unlockConfigFile();
result=unlockConfigFile(); if (result != RETURN_OK) {
if (result!= RETURN_OK){
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::resetConfigFileValues unlock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::resetConfigFileValues unlock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
return result; return result;
} }
ReturnValue_t GlobalConfigHandler::WriteConfigFile(){ ReturnValue_t GlobalConfigHandler::WriteConfigFile() {
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
ReturnValue_t resultWrite = RETURN_OK; ReturnValue_t resultWrite = RETURN_OK;
result=lockConfigFile(); result = lockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::WriteConfigFile lock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::WriteConfigFile lock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
resultWrite =writeJsonFile(); resultWrite = writeJsonFile();
if(resultWrite!=RETURN_OK){ if (resultWrite != RETURN_OK) {
triggerEvent(WRITE_CONFIGFILE_FAILED, 0, 0); triggerEvent(WRITE_CONFIGFILE_FAILED, 0, 0);
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::WriteConfigFile write json failed with " << resultWrite << std::endl; sif::info << "GlobalConfigHandler::WriteConfigFile write json failed with " << resultWrite
<< std::endl;
#endif #endif
} }
result = unlockConfigFile();
result=unlockConfigFile(); if (result != RETURN_OK) {
if (result!= RETURN_OK){
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::WriteConfigFile unlock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::WriteConfigFile unlock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
return resultWrite; return resultWrite;
} }
ReturnValue_t GlobalConfigHandler::ReadConfigFile(){ ReturnValue_t GlobalConfigHandler::ReadConfigFile() {
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
ReturnValue_t resultRead = RETURN_OK; ReturnValue_t resultRead = RETURN_OK;
result=lockConfigFile(); result = lockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::ReadConfigFile lock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::ReadConfigFile lock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
resultRead=readJsonFile(); resultRead = readJsonFile();
if(resultRead!=RETURN_OK){ if (resultRead != RETURN_OK) {
triggerEvent(READ_CONFIGFILE_FAILED, 0, 0); triggerEvent(READ_CONFIGFILE_FAILED, 0, 0);
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::ReadConfigFile read json failed with " << resultRead << std::endl; sif::info << "GlobalConfigHandler::ReadConfigFile read json failed with " << resultRead
<< std::endl;
#endif #endif
} }
result=unlockConfigFile(); result = unlockConfigFile();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::ReadConfigFile unlock mutex failed with " << result << std::endl; sif::info << "GlobalConfigHandler::ReadConfigFile unlock mutex failed with " << result
<< std::endl;
#endif #endif
return result; return result;
} }
return resultRead; return resultRead;
} }
ReturnValue_t GlobalConfigHandler::ResetConfigFile(){ ReturnValue_t GlobalConfigHandler::ResetConfigFile() {
ReturnValue_t result = RETURN_OK; ReturnValue_t result = RETURN_OK;
result=resetConfigFileValues(); result = resetConfigFileValues();
if (result!= RETURN_OK){ if (result != RETURN_OK) {
#if OBSW_VERBOSE_LEVEL >= 1 #if OBSW_VERBOSE_LEVEL >= 1
sif::info << "GlobalConfigHandler::ResetConfigFile failed with " << result << std::endl; sif::info << "GlobalConfigHandler::ResetConfigFile failed with " << result << std::endl;
#endif #endif
return result; return result;
} }
result =writeJsonFile(); result = writeJsonFile();
return result; return result;
} }
ReturnValue_t GlobalConfigHandler::setConfigFileName(std::string configFileName) {
ReturnValue_t GlobalConfigHandler::setConfigFileName(std::string configFileName){ ReturnValue_t result = RETURN_OK;
ReturnValue_t result = RETURN_OK; setFullName(configFileName);
setFullName(configFileName); result = ResetConfigFile();
result=ResetConfigFile(); return result;
return result;
} }
std::string GlobalConfigHandler::getConfigFileName(){ std::string GlobalConfigHandler::getConfigFileName() { return getFullName(); }
return getFullName(); template ReturnValue_t GlobalConfigHandler::getConfigFileValue<double>(ParamIds paramID,
} double& data);
template ReturnValue_t GlobalConfigHandler::getConfigFileValue<int32_t>(ParamIds paramID,
int32_t& data);
template ReturnValue_t GlobalConfigHandler::getConfigFileValue<double>(ParamIds paramID, double& data);
template ReturnValue_t GlobalConfigHandler::getConfigFileValue<int32_t>(ParamIds paramID, int32_t& data);
template ReturnValue_t GlobalConfigHandler::setConfigFileValue<double>(ParamIds paramID, double data);
template ReturnValue_t GlobalConfigHandler::setConfigFileValue<int32_t>(ParamIds paramID, int32_t data);
template ReturnValue_t GlobalConfigHandler::setConfigFileValue<double>(ParamIds paramID,
double data);
template ReturnValue_t GlobalConfigHandler::setConfigFileValue<int32_t>(ParamIds paramID,
int32_t data);

83
mission/utility/GlobalConfigHandler.h
View File

@ -8,73 +8,72 @@
#ifndef MISSION_UTILITY_GLOBALCONFIGHANDLER_H_ #ifndef MISSION_UTILITY_GLOBALCONFIGHANDLER_H_
#define MISSION_UTILITY_GLOBALCONFIGHANDLER_H_ #define MISSION_UTILITY_GLOBALCONFIGHANDLER_H_
#include <fsfw/action/ActionHelper.h>
#include <fsfw/action/HasActionsIF.h>
#include <fsfw/objectmanager/SystemObject.h> #include <fsfw/objectmanager/SystemObject.h>
#include <fsfw/serviceinterface/ServiceInterfaceStream.h>
#include <fsfw/storagemanager/StorageManagerIF.h> #include <fsfw/storagemanager/StorageManagerIF.h>
#include <fsfw/tasks/ExecutableObjectIF.h> #include <fsfw/tasks/ExecutableObjectIF.h>
#include <sstream> #include <sstream>
#include <string> #include <string>
#include <fsfw/serviceinterface/ServiceInterfaceStream.h>
#include "mission/memory/NVMParameterBase.h" #include "GlobalConfigFileDefinitions.h"
#include "OBSWConfig.h" #include "OBSWConfig.h"
#include "fsfw/parameters/HasParametersIF.h" #include "fsfw/parameters/HasParametersIF.h"
#include "fsfw/parameters/ParameterHelper.h" #include "fsfw/parameters/ParameterHelper.h"
#include <fsfw/action/ActionHelper.h> #include "mission/memory/NVMParameterBase.h"
#include <fsfw/action/HasActionsIF.h>
#include "GlobalConfigFileDefinitions.h"
static std::map<ParamIds, std::string> PARAM_KEY_MAP = { static std::map<ParamIds, std::string> PARAM_KEY_MAP = {
{PARAM0, "Parameter0"}, {PARAM0, "Parameter0"},
{PARAM1, "Parameter1"}, {PARAM1, "Parameter1"},
}; };
/* /*
* Idea: This class is intended to be used as a subclass for the Core Controller. * Idea: This class is intended to be used as a subclass for the Core Controller.
* Its tasks is managing a configuration JSON file containing config values important for various object. * Its tasks is managing a configuration JSON file containing config values important for various
* If some function to read or write a config value is called, a mutex should be used so only one call is done at a time. * object. If some function to read or write a config value is called, a mutex should be used so
* only one call is done at a time.
*/ */
class GlobalConfigHandler: public SystemObject, class GlobalConfigHandler : public SystemObject,
public ExecutableObjectIF, public ExecutableObjectIF,
public NVMParameterBase{ public NVMParameterBase {
public: public:
GlobalConfigHandler(object_id_t objectId, std::string configFilePath); GlobalConfigHandler(object_id_t objectId, std::string configFilePath);
virtual ~GlobalConfigHandler(); virtual ~GlobalConfigHandler();
static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::CONFIGHANDLER; static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::CONFIGHANDLER;
static constexpr Event SET_CONFIGFILEVALUE_FAILED = MAKE_EVENT(1, severity::MEDIUM); static constexpr Event SET_CONFIGFILEVALUE_FAILED = MAKE_EVENT(1, severity::MEDIUM);
static constexpr Event GET_CONFIGFILEVALUE_FAILED = MAKE_EVENT(2, severity::MEDIUM); static constexpr Event GET_CONFIGFILEVALUE_FAILED = MAKE_EVENT(2, severity::MEDIUM);
static constexpr Event INSERT_CONFIGFILEVALUE_FAILED = MAKE_EVENT(3, severity::MEDIUM); static constexpr Event INSERT_CONFIGFILEVALUE_FAILED = MAKE_EVENT(3, severity::MEDIUM);
static constexpr Event WRITE_CONFIGFILE_FAILED = MAKE_EVENT(4, severity::MEDIUM); static constexpr Event WRITE_CONFIGFILE_FAILED = MAKE_EVENT(4, severity::MEDIUM);
static constexpr Event READ_CONFIGFILE_FAILED = MAKE_EVENT(5, severity::MEDIUM); static constexpr Event READ_CONFIGFILE_FAILED = MAKE_EVENT(5, severity::MEDIUM);
ReturnValue_t performOperation(uint8_t operationCode); ReturnValue_t performOperation(uint8_t operationCode);
ReturnValue_t initialize(); ReturnValue_t initialize();
template <typename T>
ReturnValue_t setConfigFileValue(ParamIds paramID, T data);
template <typename T>
ReturnValue_t getConfigFileValue(ParamIds paramID, T& data);
template <typename T> ReturnValue_t setConfigFileValue(ParamIds paramID, T data); ReturnValue_t ResetConfigFile();
template <typename T> ReturnValue_t getConfigFileValue(ParamIds paramID, T& data); ReturnValue_t WriteConfigFile();
std::string getConfigFileName();
private:
static MutexIF* configLock;
ReturnValue_t ResetConfigFile(); ReturnValue_t lockConfigFile();
ReturnValue_t WriteConfigFile(); ReturnValue_t unlockConfigFile();
std::string getConfigFileName(); ReturnValue_t resetConfigFileValues();
private:
static MutexIF* configLock ;
ReturnValue_t lockConfigFile();
ReturnValue_t unlockConfigFile();
ReturnValue_t resetConfigFileValues();
ReturnValue_t setConfigFileName(std::string configFileName);
ReturnValue_t ReadConfigFile();
MessageQueueIF* commandQueue;
ReturnValue_t setConfigFileName(std::string configFileName);
ReturnValue_t ReadConfigFile();
MessageQueueIF* commandQueue;
}; };
#endif /* MISSION_UTILITY_GLOBALCONFIGHANDLER_H_ */ #endif /* MISSION_UTILITY_GLOBALCONFIGHANDLER_H_ */

78
unittest/controller/testConfigFileHandler.cpp
View File

@ -1,65 +1,65 @@
#include <mission/utility/GlobalConfigHandler.h> #include <mission/utility/GlobalConfigHandler.h>
#include <objects/systemObjectList.h>
#include <catch2/catch_test_macros.hpp> #include <catch2/catch_test_macros.hpp>
#include <fstream> #include <fstream>
#include <iostream> #include <iostream>
#include <stdexcept> #include <stdexcept>
#include "../testEnvironment.h" #include "../testEnvironment.h"
#include <objects/systemObjectList.h>
TEST_CASE("Configfile Handler", "[ConfigHandler]") { TEST_CASE("Configfile Handler", "[ConfigHandler]") {
sif::debug << "Testcase config file handler" << std::endl;
testEnvironment::initialize();
// Init handler
GlobalConfigHandler confighandler = GlobalConfigHandler(objects::CONFIG_TEST, "JSON.config");
REQUIRE(confighandler.initialize() == HasReturnvaluesIF::RETURN_OK);
sif::debug<<"Testcase config file handler"<<std::endl; // Reset handler
testEnvironment::initialize(); REQUIRE(confighandler.ResetConfigFile() == HasReturnvaluesIF::RETURN_OK);
//Init handler
GlobalConfigHandler confighandler= GlobalConfigHandler(objects::CONFIG_TEST,"JSON.config");
REQUIRE(confighandler.initialize() == HasReturnvaluesIF::RETURN_OK);
//Reset handler // Get and set double as well as int values
REQUIRE(confighandler.ResetConfigFile() == HasReturnvaluesIF::RETURN_OK); double doubleData = 0.0;
REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(doubleData == 5.0);
//Get and set double as well as int values doubleData = 55.9;
double doubleData=0.0; double doubleDataRead = 0;
REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK); REQUIRE(confighandler.setConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(doubleData==5.0);
doubleData=55.9; REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleDataRead) == HasReturnvaluesIF::RETURN_OK);
double doubleDataRead=0; REQUIRE(doubleDataRead == doubleData);
REQUIRE(confighandler.setConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleDataRead) == HasReturnvaluesIF::RETURN_OK); REQUIRE(confighandler.WriteConfigFile() == HasReturnvaluesIF::RETURN_OK);
REQUIRE(doubleDataRead==doubleData);
REQUIRE(confighandler.WriteConfigFile()==HasReturnvaluesIF::RETURN_OK); int intData = 0;
int intData=0; REQUIRE(confighandler.getConfigFileValue(PARAM1, intData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(intData == 905);
REQUIRE(confighandler.getConfigFileValue(PARAM1, intData) == HasReturnvaluesIF::RETURN_OK); intData = 1337;
REQUIRE(intData==905); int intDataRead = 0;
REQUIRE(confighandler.setConfigFileValue(PARAM1, intData) == HasReturnvaluesIF::RETURN_OK);
intData=1337; REQUIRE(confighandler.getConfigFileValue(PARAM1, intDataRead) == HasReturnvaluesIF::RETURN_OK);
int intDataRead=0; REQUIRE(intDataRead == intData);
REQUIRE(confighandler.setConfigFileValue(PARAM1, intData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(confighandler.getConfigFileValue(PARAM1, intDataRead) == HasReturnvaluesIF::RETURN_OK); REQUIRE(confighandler.WriteConfigFile() == HasReturnvaluesIF::RETURN_OK);
REQUIRE(intDataRead==intData);
REQUIRE(confighandler.WriteConfigFile()==HasReturnvaluesIF::RETURN_OK); // Check file name
REQUIRE(confighandler.getConfigFileName() == "JSON.config");
//Check file name // Reset and check if it worked
REQUIRE(confighandler.getConfigFileName()=="JSON.config"); REQUIRE(confighandler.ResetConfigFile() == HasReturnvaluesIF::RETURN_OK);
//Reset and check if it worked doubleData = 0.0;
REQUIRE(confighandler.ResetConfigFile() == HasReturnvaluesIF::RETURN_OK); REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(doubleData == 5.0);
doubleData=0.0;
REQUIRE(confighandler.getConfigFileValue(PARAM0, doubleData) == HasReturnvaluesIF::RETURN_OK);
REQUIRE(doubleData==5.0);
//Test invalid Parameter
REQUIRE(confighandler.getConfigFileValue(PARAM2, doubleData) != HasReturnvaluesIF::RETURN_OK);//NVMParameterBase::KEY_NOT_EXISTS is private, why?
REQUIRE(confighandler.setConfigFileValue(PARAM2, doubleData) != HasReturnvaluesIF::RETURN_OK);
// Test invalid Parameter
REQUIRE(confighandler.getConfigFileValue(PARAM2, doubleData) !=
HasReturnvaluesIF::RETURN_OK); // NVMParameterBase::KEY_NOT_EXISTS is private, why?
REQUIRE(confighandler.setConfigFileValue(PARAM2, doubleData) != HasReturnvaluesIF::RETURN_OK);
} }