Load switch

FprimeZephyrReference/Components/CMakeLists.txt

@@ -11,3 +11,4 @@ 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}/LoadSwitch/")

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

FprimeZephyrReference/Components/LoadSwitch/LoadSwitch.cpp

@@ -0,0 +1,53 @@
+// ======================================================================
+// \title  LoadSwitch.cpp
+// \author sarah
+// \brief  cpp file for LoadSwitch component implementation class
+// ======================================================================
+
+#include "FprimeZephyrReference/Components/LoadSwitch/LoadSwitch.hpp"
+
+#include <zephyr/drivers/gpio.h>
+
+namespace Components {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+LoadSwitch ::LoadSwitch(const char* const compName) : LoadSwitchComponentBase(compName) {}
+
+LoadSwitch ::~LoadSwitch() {}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+void LoadSwitch ::Reset_handler(FwIndexType portNum) {
+    this->gpioSet_out(0, Fw::Logic::LOW);
+    this->log_ACTIVITY_HI_StatusChanged(Fw::On::OFF);
+    this->tlmWrite_IsOn(Fw::On::OFF);
+    k_sleep(K_MSEC(100));
+    this->gpioSet_out(0, Fw::Logic::HIGH);
+    this->log_ACTIVITY_HI_StatusChanged(Fw::On::ON);
+    this->tlmWrite_IsOn(Fw::On::ON);
+}
+
+// ----------------------------------------------------------------------
+// Handler implementations for commands
+// ----------------------------------------------------------------------
+
+void LoadSwitch ::TURN_ON_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
+    this->gpioSet_out(0, Fw::Logic::HIGH);
+    this->log_ACTIVITY_HI_StatusChanged(Fw::On::ON);
+    this->tlmWrite_IsOn(Fw::On::ON);
+    this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+}
+
+void LoadSwitch ::TURN_OFF_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
+    this->gpioSet_out(0, Fw::Logic::LOW);
+    this->log_ACTIVITY_HI_StatusChanged(Fw::On::OFF);
+    this->tlmWrite_IsOn(Fw::On::OFF);
+    this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
+}
+
+}  // namespace Components

FprimeZephyrReference/Components/LoadSwitch/LoadSwitch.fpp

@@ -0,0 +1,72 @@
+module Components {
+    @ A generic load switch for controlling power to components
+    passive component LoadSwitch {
+
+        # One async command/port is required for active components
+        # This should be overridden by the developers with a useful command/port
+
+        ##############################################################################
+        #### Uncomment the following examples to start customizing your component ####
+        ##############################################################################
+
+        # @ Example async command
+        # async command COMMAND_NAME(param_name: U32)
+        sync command TURN_ON()
+        sync command TURN_OFF()
+
+        # @ Example telemetry counter
+        # telemetry ExampleCounter: U64
+        telemetry IsOn: Fw.On
+
+        # @ Example event
+        # event ExampleStateEvent(example_state: Fw.On) severity activity high id 0 format "State set to {}"
+        event StatusChanged($state: Fw.On) severity activity high id 1 format "Load switch state changed to {}"
+
+        # @ Example port: receiving calls from the rate group
+        # sync input port run: Svc.Sched
+        #output port Status: Drv.GpioRead
+        #We will not be putting a Drv.GpioRead port here, we are using the Gpio Driver component which has this already!
+
+        @ Port sending calls to the GPIO driver
+        output port gpioSet: Drv.GpioWrite
+
+
+        # Input that will be used by other components if they want to force a reset
+        # (off and on again) of the load switch
+        sync input port Reset: Fw.Signal
+
+        # @ Example parameter
+        # param PARAMETER_NAME: U32
+
+        ###############################################################################
+        # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #
+        ###############################################################################
+        @ Port for requesting the current time
+        time get port timeCaller
+
+        @ Port for sending command registrations
+        command reg port cmdRegOut
+
+        @ Port for receiving commands
+        command recv port cmdIn
+
+        @ Port for sending command responses
+        command resp port cmdResponseOut
+
+        @ 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
+
+        @ Port to return the value of a parameter
+        param get port prmGetOut
+
+        @Port to set the value of a parameter
+        param set port prmSetOut
+
+    }
+}

FprimeZephyrReference/Components/LoadSwitch/LoadSwitch.hpp

@@ -0,0 +1,57 @@
+// ======================================================================
+// \title  LoadSwitch.hpp
+// \author sarah
+// \brief  hpp file for LoadSwitch component implementation class
+// ======================================================================
+
+#ifndef Components_LoadSwitch_HPP
+#define Components_LoadSwitch_HPP
+
+#include "FprimeZephyrReference/Components/LoadSwitch/LoadSwitchComponentAc.hpp"
+#include <zephyr/kernel.h>
+
+// Forward declare Zephyr types to avoid header conflicts
+struct device;
+
+namespace Components {
+
+class LoadSwitch final : public LoadSwitchComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct LoadSwitch object
+    LoadSwitch(const char* const compName  //!< The component name
+    );
+
+    //! Destroy LoadSwitch object
+    ~LoadSwitch();
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for commands
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for command TURN_ON
+    void TURN_ON_cmdHandler(FwOpcodeType opCode,  //!< The opcode
+                            U32 cmdSeq            //!< The command sequence number
+                            ) override;
+
+    //! Handler implementation for command TURN_OFF
+    void TURN_OFF_cmdHandler(FwOpcodeType opCode,  //!< The opcode
+                             U32 cmdSeq            //!< The command sequence number
+                             ) override;
+
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for Reset
+    void Reset_handler(FwIndexType portNum  //!< The port number
+                       ) override;
+};
+
+}  // namespace Components
+
+#endif

FprimeZephyrReference/Components/LoadSwitch/docs/sdd.md

@@ -0,0 +1,53 @@
+# Components::LoadSwitch
+
+![LoadSwitch](LoadSwitch.svg)
+
+## Overview
+
+The `LoadSwitch` component is an active F' component that controls a single load switch output
+through the `gpioSet` output port (connected to the platform's GPIO driver). It exposes two
+async commands to turn the switch on and off, telemetry reporting the current state, and an
+async `Reset` input which toggles the switch (off, short delay, on).
+
+## Responsibility
+
+- Control the power rail for a connected peripheral by asserting/deasserting a GPIO.
+- Report state changes via an event and telemetry channel.
+
+## External interface
+
+### Commands
+
+| Name | Description | Implementation notes |
+|---|---|---|
+| TURN_ON | Turn on the associated power rail | `TURN_ON_cmdHandler` sets the gpio via `gpioSet_out(0, Fw::Logic::HIGH)`, emits `StatusChanged` (ON), updates `IsOn` telemetry, replies OK. |
+| TURN_OFF | Turn off the associated power rail | `TURN_OFF_cmdHandler` sets the gpio via `gpioSet_out(0, Fw::Logic::LOW)`, emits `StatusChanged` (OFF), updates `IsOn` telemetry, replies OK. |
+
+### Telemetry
+
+| Name | Type | Description |
+|---|---:|---|
+| IsOn | Fw.On | Current power state; written after commands and on Reset handling. |
+
+### Events
+
+| Name | Severity | ID | Format |
+|---|---|---:|---|
+| StatusChanged | activity high | 1 | "Load switch state changed to {}" |
+
+The component logs the `StatusChanged` event whenever the switch transitions due to a command or a Reset.
+
+### Ports
+
+| Port name | Direction | Port type | Notes |
+|---|---|---|---|
+| gpioSet | output | Drv.GpioWrite | Used to write the physical GPIO. Implementation always uses index 0 (`gpioSet_out(0, ...)`). |
+| Reset | input (async) | Fw.Signal | Causes the component to perform a hardware reset sequence: LOW -> wait 100ms -> HIGH. |
+
+
+## Change Log
+
+| Date | Description |
+|---|---|
+| 10-22-2025 | Sarah, Kevin, and MoMata's first commit |
+| 11-07-2025 | Updated SDD to match implementation in `LoadSwitch.cpp/.hpp/.fpp` (commands, telemetry, event, ports, reset behavior). |

FprimeZephyrReference/ReferenceDeployment/Top/ReferenceDeploymentPackets.fppi

@@ -61,7 +61,18 @@ telemetry packets ReferenceDeploymentPackets {
     ReferenceDeployment.antennaDeployer.LastDistance
   }
 
-  packet PowerMonitor id 9 group 4 {
+  packet LoadSwitches id 9 group 4 {
+    ReferenceDeployment.face4LoadSwitch.IsOn
+    ReferenceDeployment.face0LoadSwitch.IsOn
+    ReferenceDeployment.face1LoadSwitch.IsOn
+    ReferenceDeployment.face2LoadSwitch.IsOn
+    ReferenceDeployment.face3LoadSwitch.IsOn
+    ReferenceDeployment.face5LoadSwitch.IsOn
+    ReferenceDeployment.payloadPowerLoadSwitch.IsOn
+    ReferenceDeployment.payloadBatteryLoadSwitch.IsOn
+  }
+
+  packet PowerMonitor id 10 group 4 {
     ReferenceDeployment.ina219SysManager.Voltage
     ReferenceDeployment.ina219SysManager.Current
     ReferenceDeployment.ina219SysManager.Power