rename to DetumbleManager

Author: hrfarmer

.github/copilot-instructions.md

@@ -3,7 +3,7 @@
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Drv/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ComDelay/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FatalHandler")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ImuManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/DetumbleManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/NullPrmDb/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Watchdog")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Burnwire/")

FprimeZephyrReference/Components/CMakeLists.txt

@@ -16,20 +16,20 @@
 
 register_fprime_library(
     AUTOCODER_INPUTS
-        "${CMAKE_CURRENT_LIST_DIR}/ImuManager.fpp"
+        "${CMAKE_CURRENT_LIST_DIR}/DetumbleManager.fpp"
     SOURCES
-        "${CMAKE_CURRENT_LIST_DIR}/ImuManager.cpp"
+        "${CMAKE_CURRENT_LIST_DIR}/DetumbleManager.cpp"
 #   DEPENDS
 #       MyPackage_MyOtherModule
 )
 
 ### Unit Tests ###
 # register_fprime_ut(
 #     AUTOCODER_INPUTS
-#         "${CMAKE_CURRENT_LIST_DIR}/ImuManager.fpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/DetumbleManager.fpp"
 #     SOURCES
-#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/ImuManagerTestMain.cpp"
-#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/ImuManagerTester.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/DetumbleManagerTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/DetumbleManagerTester.cpp"
 #     DEPENDS
 #         STest # For rules-based testing
 #     UT_AUTO_HELPERS

FprimeZephyrReference/Components/ImuManager/CMakeLists.txt renamed to FprimeZephyrReference/Components/DetumbleManager/CMakeLists.txt

@@ -1,9 +1,9 @@
 // ======================================================================
-// \title  ImuManager.cpp
-// \brief  cpp file for ImuManager component implementation class
+// \title  DetumbleManager.cpp
+// \brief  cpp file for DetumbleManager component implementation class
 // ======================================================================
 
-#include "FprimeZephyrReference/Components/ImuManager/ImuManager.hpp"
+#include "FprimeZephyrReference/Components/DetumbleManager/DetumbleManager.hpp"
 
 #include <Fw/Types/Assert.hpp>
 
@@ -13,15 +13,15 @@ namespace Components {
 // Component construction and destruction
 // ----------------------------------------------------------------------
 
-ImuManager ::ImuManager(const char* const compName) : ImuManagerComponentBase(compName) {}
+DetumbleManager ::DetumbleManager(const char* const compName) : DetumbleManagerComponentBase(compName) {}
 
-ImuManager ::~ImuManager() {}
+DetumbleManager ::~DetumbleManager() {}
 
 // ----------------------------------------------------------------------
 // Handler implementations for typed input ports
 // ----------------------------------------------------------------------
 
-void ImuManager ::run_handler(FwIndexType portNum, U32 context) {
+void DetumbleManager ::run_handler(FwIndexType portNum, U32 context) {
     // Read from Lsm6dsoManager
     this->accelerationGet_out(0);
     this->angularVelocityGet_out(0);

FprimeZephyrReference/Components/ImuManager/ImuManager.cpp renamed to FprimeZephyrReference/Components/DetumbleManager/DetumbleManager.cpp

@@ -1,6 +1,6 @@
 module Components {
     @ IMU Manager Component for F Prime FSW framework.
-    passive component ImuManager {
+    passive component DetumbleManager {
         sync input port run: Svc.Sched
 
         @ Port for sending accelerationGet calls to the LSM6DSO Driver

FprimeZephyrReference/Components/ImuManager/ImuManager.fpp renamed to FprimeZephyrReference/Components/DetumbleManager/DetumbleManager.fpp

@@ -1,26 +1,26 @@
 // ======================================================================
-// \title  ImuManager.hpp
-// \brief  hpp file for ImuManager component implementation class
+// \title  DetumbleManager.hpp
+// \brief  hpp file for DetumbleManager component implementation class
 // ======================================================================
 
-#ifndef Components_ImuManager_HPP
-#define Components_ImuManager_HPP
+#ifndef Components_DetumbleManager_HPP
+#define Components_DetumbleManager_HPP
 
-#include "FprimeZephyrReference/Components/ImuManager/ImuManagerComponentAc.hpp"
+#include "FprimeZephyrReference/Components/DetumbleManager/DetumbleManagerComponentAc.hpp"
 
 namespace Components {
 
-class ImuManager final : public ImuManagerComponentBase {
+class DetumbleManager final : public DetumbleManagerComponentBase {
   public:
     // ----------------------------------------------------------------------
     // Component construction and destruction
     // ----------------------------------------------------------------------
 
-    //! Construct ImuManager object
-    ImuManager(const char* const compName);
+    //! Construct DetumbleManager object
+    DetumbleManager(const char* const compName);
 
-    //! Destroy ImuManager object
-    ~ImuManager();
+    //! Destroy DetumbleManager object
+    ~DetumbleManager();
 
   private:
     // ----------------------------------------------------------------------

FprimeZephyrReference/Components/ImuManager/ImuManager.hpp renamed to FprimeZephyrReference/Components/DetumbleManager/DetumbleManager.hpp

@@ -0,0 +1,73 @@
+# Components::DetumbleManager
+
+The IMU Manager (Inertial Measurement Unit) component provides sensor data related to motion and orientation of the craft. It interfaces with two drivers: the LIS2MDL Manager and the LSM6DSO Driver which provide acceleration, angular velocity, magnetic field, and temperature measurements.
+
+## Usage Examples
+
+The IMU Manager component is designed to be scheduled periodically to trigger collection of sensor data and telemetering. It operates as a passive component that responds to scheduler calls.
+
+### Typical Usage
+
+1. The component is instantiated and initialized during system startup
+2. The scheduler calls the `run` port at regular intervals
+3. On each run call, the component:
+   - Fetches sensor data from both the LIS2MDL Manager and LSM6DSO Driver
+   - Outputs telemetry for acceleration, angular velocity, magnetic field, and temperature
+
+## Class Diagram
+
+```mermaid
+classDiagram
+    namespace Components {
+        class DetumbleManagerComponentBase {
+            <<Auto-generated>>
+        }
+        class DetumbleManager {
+            + DetumbleManager(const char* compName)
+            + ~DetumbleManager()
+            - run_handler(FwIndexType portNum, U32 context): void
+        }
+    }
+    DetumbleManagerComponentBase <|-- DetumbleManager : inherits
+```
+
+## Port Descriptions
+
+| Name               | Type       | Description                                                |
+| ------------------ | ---------- | ---------------------------------------------------------- |
+| run                | sync input | Scheduler port that triggers sensor data collection        |
+| accelerationGet    | output     | Port for calling accelerationGet on the LSM6DSO Manager    |
+| angularVelocityGet | output     | Port for calling angularVelocityGet on the LSM6DSO Manager |
+| magneticFieldGet   | output     | Port for calling magneticFieldGet on the LIS2MDL Manager   |
+| temperatureGet     | output     | Port for calling temperatureGet on the LSM6DSO Manager     |
+| timeCaller         | time get   | Port for requesting current system time                    |
+
+## Sequence Diagrams
+
+```mermaid
+sequenceDiagram
+    participant Scheduler
+    participant IMU Manager
+    participant LIS2MDL Manager
+    participant LSM6DSO Manager
+
+    Scheduler-->>IMU Manager: run
+    IMU Manager->>LSM6DSO Manager: AccelerationGet
+    IMU Manager->>LSM6DSO Manager: AngularVelocityGet
+    IMU Manager->>LSM6DSO Manager: TemperatureGet
+    IMU Manager->>LIS2MDL Manager: MagneticFieldGet
+```
+
+## Requirements
+
+| Name                   | Description                                                                                          | Validation                                             |
+| ---------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
+| Sensor Data Collection | The component shall trigger data collection from both LSM6DSO and LIS2MDL sensors when run is called | Verify all sensor manager output ports are called      |
+| Periodic Operation     | The component shall operate as a scheduled component responding to scheduler calls                   | Verify component responds correctly to scheduler input |
+
+## Change Log
+
+| Date      | Description                                                           |
+| --------- | --------------------------------------------------------------------- |
+| 2025-9-9  | Initial IMU Manager component                                         |
+| 2025-9-18 | Extracted Zephyr calls to discrete LIS2MDL Manager and LSM6DSO Driver |

FprimeZephyrReference/Components/DetumbleManager/docs/sdd.md

@@ -64,7 +64,7 @@ module ReferenceDeployment {
 
   instance rtcManager: Drv.RtcManager base id 0x10016000
 
-  instance imuManager: Components.ImuManager base id 0x10017000
+  instance DetumbleManager: Components.DetumbleManager base id 0x10017000
 
   instance lis2mdlManager: Drv.Lis2mdlManager base id 0x10018000
 

FprimeZephyrReference/Components/ImuManager/docs/sdd.md

@@ -32,7 +32,7 @@ module ReferenceDeployment {
     instance watchdog
     instance prmDb
     instance rtcManager
-    instance imuManager
+    instance DetumbleManager
     instance lis2mdlManager
     instance lsm6dsoManager
     instance bootloaderTrigger
@@ -132,7 +132,7 @@ module ReferenceDeployment {
       rateGroup1Hz.RateGroupMemberOut[2] -> ComCcsds.commsBufferManager.schedIn
       rateGroup1Hz.RateGroupMemberOut[3] -> CdhCore.tlmSend.Run
       rateGroup1Hz.RateGroupMemberOut[4] -> watchdog.run
-      rateGroup1Hz.RateGroupMemberOut[5] -> imuManager.run
+      rateGroup1Hz.RateGroupMemberOut[5] -> DetumbleManager.run
       rateGroup1Hz.RateGroupMemberOut[6] -> comDelay.run
       rateGroup1Hz.RateGroupMemberOut[7] -> burnwire.schedIn
       rateGroup1Hz.RateGroupMemberOut[8] -> antennaDeployer.schedIn
@@ -155,11 +155,11 @@ module ReferenceDeployment {
       antennaDeployer.burnStop -> burnwire.burnStop
     }
 
-    connections imuManager {
-      imuManager.accelerationGet -> lsm6dsoManager.accelerationGet
-      imuManager.angularVelocityGet -> lsm6dsoManager.angularVelocityGet
-      imuManager.magneticFieldGet -> lis2mdlManager.magneticFieldGet
-      imuManager.temperatureGet -> lsm6dsoManager.temperatureGet
+    connections DetumbleManager {
+      DetumbleManager.accelerationGet -> lsm6dsoManager.accelerationGet
+      DetumbleManager.angularVelocityGet -> lsm6dsoManager.angularVelocityGet
+      DetumbleManager.magneticFieldGet -> lis2mdlManager.magneticFieldGet
+      DetumbleManager.temperatureGet -> lsm6dsoManager.temperatureGet
     }
   }
 }