Temp sensor

.codespell-ignore-words.txt

@@ -1,3 +1,4 @@
+ALS
 comIn
 Ines
 rsource

FprimeZephyrReference/Components/ADCS/ADCS.cpp

@@ -0,0 +1,43 @@
+// ======================================================================
+// \title  ADCS.cpp
+// \brief  cpp file for ADCS component implementation class
+// ======================================================================
+
+#include "FprimeZephyrReference/Components/ADCS/ADCS.hpp"
+
+#include <Fw/Types/Assert.hpp>
+
+namespace Components {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+ADCS::ADCS(const char* const compName) : ADCSComponentBase(compName) {}
+
+ADCS::~ADCS() {}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+void ADCS::run_handler(FwIndexType portNum, U32 context) {
+    Fw::Success condition;
+
+    // Visible light
+    for (FwIndexType i = 0; i < this->getNum_visibleLightGet_OutputPorts(); i++) {
+        this->visibleLightGet_out(i, condition);
+    }
+
+    // Infra-red light
+    for (FwIndexType i = 0; i < this->getNum_infraRedLightGet_OutputPorts(); i++) {
+        this->infraRedLightGet_out(i, condition);
+    }
+
+    // Ambient light
+    for (FwIndexType i = 0; i < this->getNum_ambientLightGet_OutputPorts(); i++) {
+        this->ambientLightGet_out(i, condition);
+    }
+}
+
+}  // namespace Components

FprimeZephyrReference/Components/ADCS/ADCS.fpp

@@ -0,0 +1,30 @@
+module Components {
+    @ Attitude Determination and Control Component for F Prime FSW framework.
+    passive component ADCS {
+        sync input port run: Svc.Sched
+
+        @ Port for visible light from the light sensors
+        output port visibleLightGet: [6] Drv.lightGet
+
+        @Port for infra-red light from the light sensors
+        output port infraRedLightGet: [6] Drv.lightGet
+
+        @Port for ambient light from the light sensors
+        output port ambientLightGet: [6] Drv.lightGet
+
+        ###############################################################################
+        # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #
+        ###############################################################################
+        @ Port for requesting the current time
+        time get port timeCaller
+
+        @ Port for emitting telemetry
+        telemetry port tlmOut
+
+        @ Port for emitting events
+        event port logOut
+
+        @ Port for emitting text events
+        text event port logTextOut
+    }
+}

FprimeZephyrReference/Components/ADCS/ADCS.hpp

@@ -0,0 +1,41 @@
+// ======================================================================
+// \title  ADCS.hpp
+// \brief  hpp file for ADCS component implementation class
+// ======================================================================
+
+#ifndef Components_ADCS_HPP
+#define Components_ADCS_HPP
+
+#include "FprimeZephyrReference/Components/ADCS/ADCSComponentAc.hpp"
+
+namespace Components {
+
+class ADCS final : public ADCSComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct ADCS object
+    ADCS(const char* const compName  //!< The component name
+    );
+
+    //! Destroy ADCS object
+    ~ADCS();
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for run
+    //!
+    //! Scheduled port for periodic temperature reading
+    void run_handler(FwIndexType portNum,  //!< The port number
+                     U32 context           //!< The call order
+                     ) override;
+};
+
+}  // namespace Components
+
+#endif

FprimeZephyrReference/Components/ADCS/CMakeLists.txt

@@ -0,0 +1,18 @@
+####
+# F Prime CMakeLists.txt:
+#
+# SOURCES: list of source files (to be compiled)
+# AUTOCODER_INPUTS: list of files to be passed to the autocoders
+# DEPENDS: list of libraries that this module depends on
+#
+# More information in the F´ CMake API documentation:
+# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
+#
+####
+
+register_fprime_library(
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/ADCS.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/ADCS.cpp"
+)

FprimeZephyrReference/Components/CMakeLists.txt

@@ -1,5 +1,6 @@
 # Include project-wide components here
 
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ADCS/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/BootloaderTrigger/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")
@@ -14,4 +15,5 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/NullPrmDb/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PowerMonitor/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ResetManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/StartupManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ThermalManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Watchdog")

FprimeZephyrReference/Components/Drv/CMakeLists.txt

@@ -2,4 +2,6 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Ina219Manager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Lis2mdlManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Lsm6dsoManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/RtcManager")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Tmp112Manager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Types/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Veml6031Manager/")

FprimeZephyrReference/Components/Drv/Tmp112Manager/CMakeLists.txt

@@ -0,0 +1,36 @@
+####
+# F Prime CMakeLists.txt:
+#
+# SOURCES: list of source files (to be compiled)
+# AUTOCODER_INPUTS: list of files to be passed to the autocoders
+# DEPENDS: list of libraries that this module depends on
+#
+# More information in the F´ CMake API documentation:
+# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
+#
+####
+
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer. i.e. The module defined by
+# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.
+
+register_fprime_library(
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/Tmp112Manager.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/Tmp112Manager.cpp"
+#   DEPENDS
+#       MyPackage_MyOtherModule
+)
+
+### Unit Tests ###
+# register_fprime_ut(
+#     AUTOCODER_INPUTS
+#         "${CMAKE_CURRENT_LIST_DIR}/Tmp112Manager.fpp"
+#     SOURCES
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/Tmp112ManagerTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/Tmp112ManagerTester.cpp"
+#     DEPENDS
+#         STest # For rules-based testing
+#     UT_AUTO_HELPERS
+# )

FprimeZephyrReference/Components/Drv/Tmp112Manager/TMP112Manager.cpp

@@ -0,0 +1,165 @@
+// ======================================================================
+// \title  Tmp112Manager.cpp
+// \brief  cpp file for Tmp112Manager component implementation class
+// ======================================================================
+
+#include "FprimeZephyrReference/Components/Drv/Tmp112Manager/Tmp112Manager.hpp"
+
+#include <Fw/Types/Assert.hpp>
+#include <string>
+
+#include <zephyr/sys/printk.h>
+
+namespace Drv {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+Tmp112Manager ::Tmp112Manager(const char* const compName) : Tmp112ManagerComponentBase(compName) {}
+
+Tmp112Manager ::~Tmp112Manager() {}
+
+// ----------------------------------------------------------------------
+// Helper methods
+// ----------------------------------------------------------------------
+
+void Tmp112Manager::configure(const struct device* tca,
+                              const struct device* mux,
+                              const struct device* dev,
+                              bool loadSwitchCheck) {
+    this->m_tca = tca;
+    this->m_mux = mux;
+    this->m_dev = dev;
+    // TODO(nateinaction): Abstract load switch check, perhaps wrap this component and only use when needed?
+    this->m_load_switch_check = loadSwitchCheck;
+}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+Fw::Success Tmp112Manager ::loadSwitchStateChanged_handler(FwIndexType portNum, const Fw::On& state) {
+    // Store the load switch state
+    this->m_load_switch_state = state;
+
+    // If the load switch is off, deinitialize the device
+    if (this->m_load_switch_state == Fw::On::OFF) {
+        return this->deinitializeDevice();
+    }
+
+    // If the load switch is on, set the timeout
+    // We only consider the load switch to be fully on after a timeout period
+    this->m_load_switch_on_timeout = this->getTime();
+    this->m_load_switch_on_timeout.add(1, 0);
+
+    return Fw::Success::SUCCESS;
+}
+
+F64 Tmp112Manager ::temperatureGet_handler(FwIndexType portNum, Fw::Success& condition) {
+    condition = Fw::Success::FAILURE;
+
+    if (!this->initializeDevice()) {
+        return 0;
+    }
+
+    int rc = sensor_sample_fetch_chan(this->m_dev, SENSOR_CHAN_AMBIENT_TEMP);
+    if (rc != 0) {
+        this->log_WARNING_HI_SensorSampleFetchFailed(rc);
+        return 0;
+    }
+    this->log_WARNING_HI_SensorSampleFetchFailed_ThrottleClear();
+
+    struct sensor_value val;
+    rc = sensor_channel_get(this->m_dev, SENSOR_CHAN_AMBIENT_TEMP, &val);
+    if (rc != 0) {
+        this->log_WARNING_HI_SensorChannelGetFailed(rc);
+        return 0;
+    }
+    this->log_WARNING_HI_SensorChannelGetFailed_ThrottleClear();
+
+    F64 temp = sensor_value_to_double(&val);
+
+    this->tlmWrite_Temperature(temp);
+
+    condition = Fw::Success::SUCCESS;
+    return temp;
+}
+
+bool Tmp112Manager ::isDeviceInitialized() {
+    if (!this->m_dev) {
+        this->log_WARNING_HI_DeviceNil();
+        return false;
+    }
+    this->log_WARNING_HI_DeviceNil_ThrottleClear();
+
+    if (!this->m_dev->state) {
+        this->log_WARNING_HI_DeviceStateNil();
+        return false;
+    }
+    this->log_WARNING_HI_DeviceStateNil_ThrottleClear();
+
+    return this->m_dev->state->initialized;
+}
+
+Fw::Success Tmp112Manager ::initializeDevice() {
+    if (this->isDeviceInitialized()) {
+        if (!device_is_ready(this->m_dev)) {
+            this->log_WARNING_HI_DeviceNotReady();
+            return Fw::Success::FAILURE;
+        }
+        this->log_WARNING_HI_DeviceNotReady_ThrottleClear();
+        return Fw::Success::SUCCESS;
+    }
+
+    if (!device_is_ready(this->m_tca)) {
+        this->log_WARNING_HI_TcaUnhealthy();
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_TcaUnhealthy_ThrottleClear();
+
+    if (!device_is_ready(this->m_mux)) {
+        this->log_WARNING_HI_MuxUnhealthy();
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_MuxUnhealthy_ThrottleClear();
+
+    if (!this->loadSwitchReady()) {
+        this->log_WARNING_HI_LoadSwitchNotReady();
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_LoadSwitchNotReady_ThrottleClear();
+
+    int rc = device_init(this->m_dev);
+    if (rc < 0) {
+        this->log_WARNING_HI_DeviceInitFailed(rc);
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_DeviceInitFailed_ThrottleClear();
+
+    return Fw::Success::SUCCESS;
+}
+
+Fw::Success Tmp112Manager ::deinitializeDevice() {
+    if (!this->m_dev) {
+        this->log_WARNING_HI_DeviceNil();
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_DeviceNil_ThrottleClear();
+
+    if (!this->m_dev->state) {
+        this->log_WARNING_HI_DeviceStateNil();
+        return Fw::Success::FAILURE;
+    }
+    this->log_WARNING_HI_DeviceStateNil_ThrottleClear();
+
+    this->m_dev->state->initialized = false;
+    return Fw::Success::SUCCESS;
+}
+
+bool Tmp112Manager ::loadSwitchReady() {
+    return (this->m_load_switch_state == Fw::On::ON && this->getTime() >= this->m_load_switch_on_timeout) ||
+           !this->m_load_switch_check;
+}
+
+}  // namespace Drv