Power monitor

FprimeZephyrReference/Components/CMakeLists.txt

@@ -1,12 +1,13 @@
 # Include project-wide components here
 
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Drv/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/BootloaderTrigger/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ComDelay/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Drv/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FatalHandler")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FsSpace/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ImuManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/NullPrmDb/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PowerMonitor/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Watchdog")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/BootloaderTrigger/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AntennaDeployer/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FsSpace/")

FprimeZephyrReference/Components/Drv/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Helpers/")
+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")

FprimeZephyrReference/Components/Drv/Ina219Manager/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}/Ina219Manager.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/Ina219Manager.cpp"
+#   DEPENDS
+#       MyPackage_MyOtherModule
+)
+
+### Unit Tests ###
+# register_fprime_ut(
+#     AUTOCODER_INPUTS
+#         "${CMAKE_CURRENT_LIST_DIR}/Ina219Manager.fpp"
+#     SOURCES
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/Ina219ManagerTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/Ina219ManagerTester.cpp"
+#     DEPENDS
+#         STest # For rules-based testing
+#     UT_AUTO_HELPERS
+# )

FprimeZephyrReference/Components/Drv/Ina219Manager/Ina219Manager.cpp

@@ -0,0 +1,85 @@
+// ======================================================================
+// \title  Ina219Manager.cpp
+// \brief  cpp file for Ina219Manager component implementation class
+// ======================================================================
+
+#include "FprimeZephyrReference/Components/Drv/Ina219Manager/Ina219Manager.hpp"
+#include <Fw/Types/Assert.hpp>
+
+namespace Drv {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+Ina219Manager ::Ina219Manager(const char* const compName) : Ina219ManagerComponentBase(compName) {}
+
+Ina219Manager ::~Ina219Manager() {}
+
+// ----------------------------------------------------------------------
+// Helper methods
+// ----------------------------------------------------------------------
+
+void Ina219Manager::configure(const struct device* dev) {
+    this->m_dev = dev;
+}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+F64 Ina219Manager ::currentGet_handler(FwIndexType portNum) {
+    if (!device_is_ready(this->m_dev)) {
+        this->log_WARNING_HI_DeviceNotReady();
+        return 0;
+    }
+    this->log_WARNING_HI_DeviceNotReady_ThrottleClear();
+
+    struct sensor_value current;
+
+    sensor_sample_fetch_chan(this->m_dev, SENSOR_CHAN_CURRENT);
+
+    sensor_channel_get(this->m_dev, SENSOR_CHAN_CURRENT, &current);
+
+    this->tlmWrite_Current(sensor_value_to_double(&current));
+
+    return sensor_value_to_double(&current);
+}
+
+F64 Ina219Manager ::powerGet_handler(FwIndexType portNum) {
+    if (!device_is_ready(this->m_dev)) {
+        this->log_WARNING_HI_DeviceNotReady();
+        return 0;
+    }
+    this->log_WARNING_HI_DeviceNotReady_ThrottleClear();
+
+    struct sensor_value power;
+
+    sensor_sample_fetch_chan(this->m_dev, SENSOR_CHAN_POWER);
+
+    sensor_channel_get(this->m_dev, SENSOR_CHAN_POWER, &power);
+
+    this->tlmWrite_Power(sensor_value_to_double(&power));
+
+    return sensor_value_to_double(&power);
+}
+
+F64 Ina219Manager ::voltageGet_handler(FwIndexType portNum) {
+    if (!device_is_ready(this->m_dev)) {
+        this->log_WARNING_HI_DeviceNotReady();
+        return 0;
+    }
+    this->log_WARNING_HI_DeviceNotReady_ThrottleClear();
+
+    struct sensor_value voltage;
+
+    sensor_sample_fetch_chan(this->m_dev, SENSOR_CHAN_VOLTAGE);
+
+    sensor_channel_get(this->m_dev, SENSOR_CHAN_VOLTAGE, &voltage);
+
+    this->tlmWrite_Voltage(sensor_value_to_double(&voltage));
+
+    return sensor_value_to_double(&voltage);
+}
+
+}  // namespace Drv

FprimeZephyrReference/Components/Drv/Ina219Manager/Ina219Manager.fpp

@@ -0,0 +1,50 @@
+module Drv {
+    port VoltageGet -> F64
+    port CurrentGet -> F64
+    port PowerGet -> F64
+}
+
+module Drv {
+    @ Manager for Ina219 device
+    passive component Ina219Manager {
+        # Ports
+        @ Port to read the voltage in volts
+        sync input port voltageGet: VoltageGet
+
+        @ Port to read the current in amps
+        sync input port currentGet: CurrentGet
+
+        @ Port to read the power in watts
+        sync input port powerGet: PowerGet
+
+        # Telemetry channels
+
+        @ Telemetry channel for voltage in volts
+        telemetry Voltage: F64
+
+        @ Telemetry channel for current in amps
+        telemetry Current: F64
+
+        @ Telemetry channel for power in watts
+        telemetry Power: F64
+
+        @ Event for reporting INA219 not ready error
+        event DeviceNotReady() severity warning high format "INA219 device not ready" throttle 5
+
+        ###############################################################################
+        # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #
+        ###############################################################################
+        @ Port for requesting the current time
+        time get port timeCaller
+
+        @ Port for sending textual representation of events
+        text event port logTextOut
+
+        @ Port for sending events to downlink
+        event port logOut
+
+        @ Port for sending telemetry channels to downlink
+        telemetry port tlmOut
+
+    }
+}

FprimeZephyrReference/Components/Drv/Ina219Manager/Ina219Manager.hpp

@@ -0,0 +1,70 @@
+// ======================================================================
+// \title  Ina219Manager.hpp
+// \brief  hpp file for Ina219Manager component implementation class
+// ======================================================================
+
+#ifndef Drv_Ina219Manager_HPP
+#define Drv_Ina219Manager_HPP
+
+#include "FprimeZephyrReference/Components/Drv/Ina219Manager/Ina219ManagerComponentAc.hpp"
+
+#include <zephyr/device.h>
+#include <zephyr/drivers/sensor.h>
+#include <zephyr/kernel.h>
+namespace Drv {
+
+class Ina219Manager final : public Ina219ManagerComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct Ina219Manager object
+    Ina219Manager(const char* const compName  //!< The component name
+    );
+
+    //! Destroy Ina219Manager object
+    ~Ina219Manager();
+
+  public:
+    // ----------------------------------------------------------------------
+    // Helper methods
+    // ----------------------------------------------------------------------
+
+    //! Configure the INA219 device
+    void configure(const struct device* dev);
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for currentGet
+    //!
+    //! Port to read the current in amps
+    F64 currentGet_handler(FwIndexType portNum  //!< The port number
+                           ) override;
+
+    //! Handler implementation for powerGet
+    //!
+    //! Port to read the power in watts
+    F64 powerGet_handler(FwIndexType portNum  //!< The port number
+                         ) override;
+
+    //! Handler implementation for voltageGet
+    //!
+    //! Port to read the voltage in volts
+    F64 voltageGet_handler(FwIndexType portNum  //!< The port number
+                           ) override;
+
+    // ----------------------------------------------------------------------
+    // Member variables
+    // ----------------------------------------------------------------------
+
+    //! Zephyr device stores the initialized LIS2MDL sensor
+    const struct device* m_dev;
+};
+
+}  // namespace Drv
+
+#endif

FprimeZephyrReference/Components/Drv/Ina219Manager/docs/sdd.md

@@ -0,0 +1,111 @@
+# Drv::Ina219Manager
+
+The INA219 Manager component interfaces with the INA219 current/power monitor to provide voltage, current, and power measurements.
+
+## Usage Examples
+
+The INA219 Manager component is designed to be called periodically to collect and return sensor data. It operates as a passive component that responds to manager calls.
+
+### Typical Usage
+
+1. The component is instantiated and initialized during system startup
+2. A manager calls any of the input ports: `VoltageGet`, `CurrentGet`, or `PowerGet`
+3. On each call, the component:
+   - Fetches fresh sensor samples from the sensor
+   - Converts sensor data to double precision floating point
+   - Writes telemetry data
+   - Returns data in SI units
+
+## Class Diagram
+
+```mermaid
+classDiagram
+    namespace Drv {
+        class Ina219ManagerComponentBase {
+            <<Auto-generated>>
+        }
+        class Ina219Manager {
+            - m_dev: const struct device*
+            + Ina219Manager(const char* compName)
+            + ~Ina219Manager()
+            + configure(const struct device* dev)
+            - voltageGet_handler(const FwIndexType portNum): F64
+            - currentGet_handler(const FwIndexType portNum): F64
+            - powerGet_handler(const FwIndexType portNum): F64
+        }
+    }
+    Ina219ManagerComponentBase <|-- Ina219Manager : inherits
+```
+
+## Port Descriptions
+| Name | Type | Description |
+|---|---|---|
+| VoltageGet | sync input | Triggers voltage data collection and returns voltage in volts |
+| CurrentGet | sync input | Triggers current data collection and returns current in amps |
+| PowerGet | sync input | Triggers power data collection and returns power in watts |
+
+## Sequence Diagrams
+
+### VoltageGet
+```mermaid
+sequenceDiagram
+    participant Manager
+    participant INA219 Manager
+    participant Zephyr Sensor API
+    participant INA219 Sensor
+
+    Manager-->>INA219 Manager: Call VoltageGet synchronous input port
+    INA219 Manager->>Zephyr Sensor API: Fetch sensor data
+    Zephyr Sensor API->>INA219 Sensor: Read sensor
+    INA219 Sensor->>Zephyr Sensor API: Return sensor data
+    Zephyr Sensor API->>INA219 Manager: Return voltage sensor_value struct
+    INA219 Manager->>INA219 Manager: Write telemetry
+    INA219 Manager-->>Manager: Return F64 voltage in volts
+```
+
+### CurrentGet
+```mermaid
+sequenceDiagram
+    participant Manager
+    participant INA219 Manager
+    participant Zephyr Sensor API
+    participant INA219 Sensor
+
+    Manager-->>INA219 Manager: Call CurrentGet synchronous input port
+    INA219 Manager->>Zephyr Sensor API: Fetch sensor data
+    Zephyr Sensor API->>INA219 Sensor: Read sensor
+    INA219 Sensor->>Zephyr Sensor API: Return sensor data
+    Zephyr Sensor API->>INA219 Manager: Return current sensor_value struct
+    INA219 Manager->>INA219 Manager: Write telemetry
+    INA219 Manager-->>Manager: Return F64 current in amps
+```
+
+### PowerGet
+```mermaid
+sequenceDiagram
+    participant Manager
+    participant INA219 Manager
+    participant Zephyr Sensor API
+    participant INA219 Sensor
+
+    Manager-->>INA219 Manager: Call PowerGet synchronous input port
+    INA219 Manager->>Zephyr Sensor API: Fetch sensor data
+    Zephyr Sensor API->>INA219 Sensor: Read sensor
+    INA219 Sensor->>Zephyr Sensor API: Return sensor data
+    Zephyr Sensor API->>INA219 Manager: Return power sensor_value struct
+    INA219 Manager->>INA219 Manager: Write telemetry
+    INA219 Manager-->>Manager: Return F64 power in watts
+```
+
+## Requirements
+| Name | Description | Validation |
+|---|---|---|
+| VoltageGet Port | The component shall provide access to voltage sensor data and return in volts | Integration test |
+| CurrentGet Port | The component shall provide access to current sensor data and return in amps | Integration test |
+| PowerGet Port | The component shall provide access to power sensor data and return in watts | Integration test |
+| DeviceNotReady Event | The component shall emit a throttled warning event when the device is not ready | Verify event is emitted and throttled to 5 occurrences |
+
+## Change Log
+| Date | Description |
+|---|---|
+| 2025-11-03 | Initial INA219 Manager component |