tmp1075 handler, wip

mission/controller/ThermalController.cpp

@@ -0,0 +1,49 @@
+#include "ThermalController.h"
+#include <mission/devices/devicedefinitions/ThermalSensorPacket.h>
+
+ThermalController::ThermalController(object_id_t objectId):
+        ExtendedControllerBase(objectId, objects::NO_OBJECT),
+        thermalControllerSet(objectId) {
+}
+
+ReturnValue_t ThermalController::handleCommandMessage(
+        CommandMessage *message) {
+    return HasReturnvaluesIF::RETURN_OK;
+}
+
+void ThermalController::performControlOperation() {
+
+}
+
+void ThermalController::handleChangedDataset(sid_t sid,
+        store_address_t storeId) {
+    if(sid == sid_t(TSensorDefinitions::ObjIds::TEST_HKB_HANDLER,
+            TSensorDefinitions::THERMAL_SENSOR_SET_ID)) {
+        sif::info << "Update registered!" << std::endl;
+    }
+}
+
+ReturnValue_t ThermalController::initializeAfterTaskCreation() {
+    ReturnValue_t result =
+            ExtendedControllerBase::initializeAfterTaskCreation();
+    if(result != HasReturnvaluesIF::RETURN_OK) {
+        sif::error << "ThermalController::initializeAfterTaskCreation: Base"
+                << " class initialization failed!" << std::endl;
+    }
+    HasLocalDataPoolIF* testHkbHandler = objectManager->get<HasLocalDataPoolIF>(
+            TSensorDefinitions::ObjIds::TEST_HKB_HANDLER);
+    if(testHkbHandler == nullptr) {
+        sif::warning << "ThermalController::initializeAfterTaskCreation: Test"
+                << " HKB Handler invalid!" << std::endl;
+    }
+    // Test normal notifications without data packet first.
+    testHkbHandler->getHkManagerHandle()->subscribeForSetUpdateMessages(
+            TSensorDefinitions::THERMAL_SENSOR_SET_ID,
+            this->getObjectId(), commandQueue->getId(), false);
+    return result;
+}
+
+ReturnValue_t ThermalController::checkModeCommand(Mode_t mode,
+        Submode_t submode, uint32_t *msToReachTheMode) {
+    return HasReturnvaluesIF::RETURN_OK;
+}

mission/controller/ThermalController.h

@@ -0,0 +1,33 @@
+#ifndef MISSION_CONTROLLER_THERMALCONTROLLER_H_
+#define MISSION_CONTROLLER_THERMALCONTROLLER_H_
+
+#include <fsfw/controller/ExtendedControllerBase.h>
+#include "ctrldefinitions/ThermalCtrlPackets.h"
+
+
+class ThermalController: public ExtendedControllerBase {
+public:
+	ThermalController(object_id_t objectId);
+private:
+
+	// TODO: Add stubs for thermal components. Each device / assembly with one
+	// or multiple redundant sensors will have a thermal component.
+
+	/** ExtendedControllerBase overrides */
+    virtual ReturnValue_t handleCommandMessage(
+            CommandMessage *message) override;
+
+    virtual void performControlOperation() override;
+
+    virtual ReturnValue_t checkModeCommand(Mode_t mode, Submode_t submode,
+            uint32_t *msToReachTheMode) override;
+
+    ReturnValue_t initializeAfterTaskCreation() override;
+
+    void handleChangedDataset(sid_t sid, store_address_t storeId) override;
+
+    ThermalCtrl::ThermalControllerTemperatureSet thermalControllerSet;
+};
+
+
+#endif /* MISSION_CONTROLLER_THERMALCONTROLLER_H_ */

mission/devices/CMakeLists.txt

@@ -4,6 +4,7 @@ target_sources(${TARGET_NAME} PUBLIC
 	MGMHandlerLIS3MDL.cpp
 	MGMHandlerRM3100.cpp
 	GomspaceDeviceHandler.cpp
+	Tmp1075Handler.cpp
 )
 
 

mission/devices/GomspaceDeviceHandler.cpp

@@ -70,9 +70,9 @@ ReturnValue_t GomspaceDeviceHandler::buildCommandFromCommand(
 		}
 	}
 	default:
-		break;
+		return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
 	}
-	return HasReturnvaluesIF::RETURN_OK;
+	return HasReturnvaluesIF::RETURN_FAILED;
 }
 
 void GomspaceDeviceHandler::fillCommandAndReplyMap(){

mission/devices/Tmp1075Handler.cpp

@@ -0,0 +1,134 @@
+#include <mission/devices/Tmp1075Handler.h>
+#include <mission/devices/devicedefinitions/Tmp1075Definitions.h>
+
+Tmp1075Handler::Tmp1075Handler(object_id_t objectId, object_id_t comIF,
+		CookieIF * comCookie) :
+		DeviceHandlerBase(objectId, comIF, comCookie), dataset(
+				this) {
+	if (comCookie == NULL) {
+		sif::error << "Tmp1075Handler: Invalid com cookie" << std::endl;
+	}
+}
+
+Tmp1075Handler::~Tmp1075Handler() {
+}
+
+
+void Tmp1075Handler::doStartUp(){
+	if(mode == _MODE_START_UP){
+		setMode(MODE_NORMAL);
+	}
+}
+
+void Tmp1075Handler::doShutDown(){
+
+}
+
+ReturnValue_t Tmp1075Handler::buildNormalDeviceCommand(
+		DeviceCommandId_t * id) {
+
+	if(communicationStep == CommunicationStep::START_ADC_CONVERSION) {
+		*id = TMP1075::START_ADC_CONVERSION;
+		communicationStep = CommunicationStep::GET_TEMPERATURE;
+		return buildCommandFromCommand(*id, NULL, 0);
+	}
+	else {
+		*id = TMP1075::GET_TEMP;
+		communicationStep = CommunicationStep::START_ADC_CONVERSION;
+		return buildCommandFromCommand(*id, NULL, 0);
+	}
+	return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Tmp1075Handler::buildTransitionDeviceCommand(
+		DeviceCommandId_t * id){
+	return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Tmp1075Handler::buildCommandFromCommand(
+		DeviceCommandId_t deviceCommand, const uint8_t * commandData,
+		size_t commandDataLen) {
+	switch(deviceCommand) {
+	case(TMP1075::START_ADC_CONVERSION): {
+		std::memset(cmdBuffer, 0, sizeof(cmdBuffer));
+		prepareAdcConversionCommand();
+		rawPacket = cmdBuffer;
+		rawPacketLen = TMP1075::CFGR_CMD_SIZE;
+		return RETURN_OK;
+	}
+	case(TMP1075::GET_TEMP): {
+		std::memset(cmdBuffer, 0, sizeof(cmdBuffer));
+		prepareGetTempCommand();
+		rawPacket = cmdBuffer;
+		rawPacketLen = TMP1075::POINTER_REG_SIZE;
+		rememberCommandId = TMP1075::GET_TEMP;
+		return RETURN_OK;
+	}
+	default:
+		return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
+	}
+	return HasReturnvaluesIF::RETURN_FAILED;
+}
+
+void Tmp1075Handler::fillCommandAndReplyMap(){
+	this->insertInCommandMap(TMP1075::START_ADC_CONVERSION);
+	this->insertInCommandAndReplyMap(TMP1075::GET_TEMP, 1, &dataset,
+			TMP1075::GET_TEMP_REPLY_SIZE);
+}
+
+ReturnValue_t Tmp1075Handler::scanForReply(const uint8_t *start,
+        size_t remainingSize, DeviceCommandId_t *foundId, size_t *foundLen) {
+	switch(rememberCommandId) {
+	case(TMP1075::GET_TEMP):
+			*foundId = TMP1075::GET_TEMP;
+			*foundLen = TMP1075::GET_TEMP_REPLY_SIZE;
+			rememberCommandId = TMP1075::NONE;
+		break;
+	default:
+		return IGNORE_REPLY_DATA;
+	}
+    return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t Tmp1075Handler::interpretDeviceReply(DeviceCommandId_t id,
+        const uint8_t *packet) {
+	switch (id) {
+	case TMP1075::GET_TEMP: {
+		int16_t tempValueRaw = packet[1] << 8 | packet[0] >> 4;
+		float tempValue = ((static_cast<float>(tempValueRaw)) * 0.0625);
+#if OBSW_ENHANCED_PRINTOUT == 1
+		sif::info << "Tmp1075: Temperature: " << tempValue<< " °C" << std::endl;
+#endif
+        ReturnValue_t result = dataset.read(20);
+        if(result == HasReturnvaluesIF::RETURN_OK) {
+            dataset.temperatureCelcius = tempValue;
+            dataset.commit(20);
+        }
+		break;
+	}
+
+	default: {
+		return DeviceHandlerIF::UNKNOWN_DEVICE_REPLY;
+	}
+
+	}
+	return HasReturnvaluesIF::RETURN_OK;
+}
+
+void Tmp1075Handler::setNormalDatapoolEntriesInvalid(){
+
+}
+
+void Tmp1075Handler::prepareAdcConversionCommand(){
+	cmdBuffer[0] = TMP1075::CFGR_ADDR;
+	cmdBuffer[1] = TMP1075::ONE_SHOT_MODE >> 8;
+	cmdBuffer[2] = TMP1075::ONE_SHOT_MODE & 0xFF;
+}
+
+void Tmp1075Handler::prepareGetTempCommand(){
+	cmdBuffer[0] = TMP1075::TEMP_REG_ADDR;
+}
+
+uint32_t Tmp1075Handler::getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo){
+	return 0;
+}

mission/devices/Tmp1075Handler.h

@@ -0,0 +1,66 @@
+#ifndef MISSION_DEVICES_TMP1075HANDLER_H_
+#define MISSION_DEVICES_TMP1075HANDLER_H_
+
+#include <fsfw/devicehandlers/DeviceHandlerBase.h>
+#include <mission/devices/devicedefinitions/Tmp1075Definitions.h>
+
+/**
+ * @brief	This is the device handler class for the tmp1075 temperature sensor.
+ *
+ * @details	The tmp1075 communicates via I2C. After the address byte and the
+ * 			read and write bit, a pointer address must be sent to the device.
+ * 			This pointer address is stored in the pointer register of the
+ * 			tmp1075 and defines to which address following data bytes will
+ * 			be written or from which address data will be read.
+ *
+ * @author	J. Meier
+ */
+class Tmp1075Handler: public DeviceHandlerBase {
+public:
+
+	Tmp1075Handler(object_id_t objectId, object_id_t comIF,
+			CookieIF * comCookie);
+	virtual ~Tmp1075Handler();
+
+protected:
+	void doStartUp() override;
+	void doShutDown() override;
+	ReturnValue_t buildNormalDeviceCommand(DeviceCommandId_t * id) override;
+	ReturnValue_t buildTransitionDeviceCommand(DeviceCommandId_t * id) override;
+	void fillCommandAndReplyMap() override;
+	ReturnValue_t buildCommandFromCommand(DeviceCommandId_t deviceCommand,
+				const uint8_t * commandData,size_t commandDataLen) override;
+	ReturnValue_t scanForReply(const uint8_t *start, size_t remainingSize,
+			DeviceCommandId_t *foundId, size_t *foundLen) override;
+	ReturnValue_t interpretDeviceReply(DeviceCommandId_t id,
+			const uint8_t *packet) override;
+	void setNormalDatapoolEntriesInvalid() override;
+	uint32_t getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) override;
+
+private:
+
+	/**
+	 * @brief	Function fills cmdBuffer with command to start the adc
+	 * 			conversion for a new temperature value.
+	 */
+	void prepareAdcConversionCommand();
+
+	void prepareGetTempCommand();
+
+	enum class CommunicationStep {
+		START_ADC_CONVERSION,
+		GET_TEMPERATURE
+	};
+
+	TMP1075::Tmp1075Dataset dataset;
+
+	static const uint8_t MAX_CMD_LEN = 3;
+
+	uint8_t rememberRequestedSize = 0;
+	uint8_t rememberCommandId = TMP1075::NONE;
+	uint8_t cmdBuffer[MAX_CMD_LEN];
+	CommunicationStep communicationStep =
+			CommunicationStep::START_ADC_CONVERSION;
+};
+
+#endif /* MISSION_DEVICES_TMP1075HANDLER_H_ */

mission/devices/devicedefinitions/Tmp1075Definitions.h

@@ -0,0 +1,51 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_TMP1075DEFINITIONS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_TMP1075DEFINITIONS_H_
+
+namespace TMP1075 {
+	static const uint8_t TEMP_REG_ADDR = 0x0;
+	static const uint8_t CFGR_ADDR = 0x1;
+
+	/* Writing this information to the configuration register sets the tmp1075
+	 * to shutdown mode and starts a single temperature conversion */
+	static const uint16_t ONE_SHOT_MODE = 0x8100;
+
+	static const DeviceCommandId_t NONE = 0x0; // Set when no command is pending
+	static const DeviceCommandId_t GET_TEMP = 0x1;
+	static const DeviceCommandId_t START_ADC_CONVERSION = 0x2;
+
+	static const uint8_t GET_TEMP_REPLY_SIZE = 2;
+	static const uint8_t CFGR_CMD_SIZE = 3;
+	static const uint8_t POINTER_REG_SIZE = 1;
+
+	static const lp_id_t TEMPERATURE_C = GET_TEMP;
+	static const uint32_t DATA_SET_ID = 0x0;
+
+	static const uint8_t MAX_REPLY_LENGTH = GET_TEMP_REPLY_SIZE;
+
+class Tmp1075Dataset:
+		public StaticLocalDataSet<sizeof(float)> {
+public:
+	/**
+	 * Constructor used by owner and data creators like device handlers.
+	 * @param owner
+	 * @param setId
+	 */
+	Tmp1075Dataset(HasLocalDataPoolIF* owner):
+		StaticLocalDataSet(owner, DATA_SET_ID) {
+	}
+
+	/**
+	 * Constructor used by data users like controllers.
+	 * @param sid
+	 */
+	Tmp1075Dataset(object_id_t objectId):
+		StaticLocalDataSet(sid_t(objectId, DATA_SET_ID)) {
+	}
+
+	lp_var_t<float> temperatureCelcius = lp_var_t<float>(hkManager->getOwner(),
+			TEMPERATURE_C, this);
+};
+}
+
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_TMP1075DEFINITIONS_H_ */