added rate group

Author: ineskhou

FprimeZephyrReference/Components/Burnwire/Burnwire.cpp

@@ -20,8 +20,27 @@ Burnwire ::~Burnwire() {}
 // Handler implementations for typed input ports
 // ----------------------------------------------------------------------
 
-void Burnwire ::stop_handler(FwIndexType portNum) {
-    // TODO
+// void Burnwire ::stop_handler(FwIndexType portNum) {
+//     //TODO
+// }
+
+void Burnwire ::schedIn_handler(FwIndexType portNum, U32 context) {
+    if (this->m_state == Fw::On::ON) {
+        this->m_safetyCounter++;
+        if (this->m_safetyCounter == 1) {
+            this->log_ACTIVITY_HI_SafetyTimerStatus(Fw::On::ON);
+        }
+
+        if (this->m_safetyCounter >= m_safetyMaxCount) {
+            // 30 seconds reached → turn OFF
+            this->gpioSet_out(0, Fw::Logic::LOW);
+            this->gpioSet_out(1, Fw::Logic::LOW);
+
+            this->m_state = Fw::On::OFF;
+            this->log_ACTIVITY_HI_SetBurnwireState(Fw::On::OFF);
+            this->log_ACTIVITY_HI_SafetyTimerStatus(Fw::On::OFF);
+        }
+    }
 }
 
 // ----------------------------------------------------------------------
@@ -36,6 +55,9 @@ void Burnwire ::START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     // confirm response
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 
+    // reset count to 0
+    this->m_safetyCounter = 0;
+
     this->gpioSet_out(0, Fw::Logic::HIGH);
     this->gpioSet_out(1, Fw::Logic::HIGH);
 }

FprimeZephyrReference/Components/Burnwire/Burnwire.fpp

@@ -22,11 +22,15 @@ module Components {
             severity activity high \
             format "Burnwire State: {}"
 
+        event SafetyTimerStatus(burnwire_state: Fw.On) \
+            severity activity high\
+            format "Safety Timer State: {} "
+
         # @ Example port: receiving calls from the rate group
         # sync input port run: Svc.Sched
 
-        @ Input Port to start and stop the burnwire
-        sync input port stop: Fw.Signal
+        @ Input Port to get the rate group
+        sync input port schedIn: Svc.Sched
 
         @ Port sending calls to the GPIO driver to stop and start the burnwire
         output port gpioSet: [2] Drv.GpioWrite

FprimeZephyrReference/Components/Burnwire/Burnwire.hpp

@@ -32,8 +32,10 @@ class Burnwire final : public BurnwireComponentBase {
     //! Handler implementation for stop
     //!
     //! Port to start and stop the burnwire
-    void stop_handler(FwIndexType portNum  //!< The port number
-                      ) override;
+
+    void schedIn_handler(FwIndexType portNum,  //!< The port number
+                         U32 context           //!< The call order
+                         ) override;
 
   private:
     // ----------------------------------------------------------------------
@@ -47,6 +49,8 @@ class Burnwire final : public BurnwireComponentBase {
     void STOP_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;
 
     Fw::On m_state = Fw::On::OFF;  // keeps track if burnwire is on or off
+    U32 m_safetyCounter = 0;       // keeps track of the safety number of seconds
+    U32 m_safetyMaxCount = 5;
 };
 
 }  // namespace Components

FprimeZephyrReference/Components/Burnwire/docs/sdd.md

@@ -9,6 +9,7 @@ Add requirements in the chart below
 |BW-002|The burnwire component shall turn off when commanded to |Hardware Test|
 |BW-003|The burnwire component shall provide an Event when it is turned on and off |Integration Test|
 |BW-004|The burnwire component shall activate by turning the GPIO pins on one at a time |Integration Test|
+|BW-005|The burnwire component shall be controlled by a safety timeout that can be changed within the code |Integration Test|
 
 
 ## Port Descriptions
@@ -33,8 +34,8 @@ Add requirements in the chart below
 ## Component States
 Add component states in the chart below
 | Name | Description |
-|---|---|
-|---|---|
+|----|---|
+|m_state|Keeps track if the burnwire is on or off|
 
 ## Sequence Diagrams
 Add sequence diagrams here
@@ -56,8 +57,9 @@ Add sequence diagrams here
 ## Unit Tests
 Add unit test descriptions in the chart below
 | Name | Description | Output | Coverage |
-|---|---|---|---|
-|---|---|---|---|
+|TestSafety|Tests Burnwire turns off after X seconds|---|---|
+|TestOn|Tests right GPIO pins turn on |---|---|
+|TestOn|Tests right GPIO pins turn off, same as on |---|---|
 
 ## Change Log
 | Date | Description |

FprimeZephyrReference/ReferenceDeployment/Top/ReferenceDeploymentTopology.cpp

@@ -16,12 +16,12 @@
 static const struct gpio_dt_spec ledGpio = GPIO_DT_SPEC_GET(DT_ALIAS(led0), gpios);
 static const struct gpio_dt_spec burnwire0Gpio = {
     .port = DEVICE_DT_GET(DT_NODELABEL(gpio0)),
-    .pin = 28,
+    .pin = 28,  // 28
     .dt_flags = GPIO_ACTIVE_HIGH,
 };
 static const struct gpio_dt_spec burnwire1Gpio = {
     .port = DEVICE_DT_GET(DT_NODELABEL(gpio0)),
-    .pin = 29,
+    .pin = 29,  // 29
     .dt_flags = GPIO_ACTIVE_HIGH,
 };
 

FprimeZephyrReference/ReferenceDeployment/Top/topology.fpp

@@ -95,6 +95,7 @@ module ReferenceDeployment {
       rateGroup1Hz.RateGroupMemberOut[2] -> ComCcsds.commsBufferManager.schedIn
       rateGroup1Hz.RateGroupMemberOut[3] -> CdhCore.tlmSend.Run
       rateGroup1Hz.RateGroupMemberOut[4] -> watchdog.run
+      rateGroup1Hz.RateGroupMemberOut[5] -> burnwire.schedIn
     }