properlly parameters for REAL

Author: ineskhou

FprimeZephyrReference/Components/Burnwire/Burnwire.cpp

@@ -15,10 +15,6 @@ namespace Components {
 Burnwire ::Burnwire(const char* const compName) : BurnwireComponentBase(compName) {
     this->m_safetyCounter = 0;
     this->m_state = Fw::On::OFF;
-    Fw::ParamValid valid;
-    this->m_safetyMaxCount = this->paramGet_SAFETY_TIMER(valid);
-    this->log_ACTIVITY_HI_SafetyTimerSet(this->m_safetyMaxCount);
-    this->log_ACTIVITY_HI_SafetyTimerSet(m_safetyMaxCount);
 }
 
 Burnwire ::~Burnwire() {}
@@ -42,7 +38,10 @@ void Burnwire::startBurn() {
     this->m_safetyCounter = 0;
     this->m_state = Fw::On::ON;
     this->log_ACTIVITY_HI_SetBurnwireState(Fw::On::ON);
-    this->log_ACTIVITY_HI_SafetyTimerSet(this->m_safetyMaxCount);
+
+    Fw::ParamValid valid;
+    U32 timeout = this->paramGet_SAFETY_TIMER(valid);
+    this->log_ACTIVITY_HI_SafetyTimerState(timeout);
 }
 
 void Burnwire::stopBurn() {
@@ -77,8 +76,7 @@ void Burnwire ::schedIn_handler(FwIndexType portNum, U32 context) {
 // Handler implementations for commands
 // ----------------------------------------------------------------------
 
-void Burnwire ::START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, U32 max_duration) {
-    this->m_safetyMaxCount = max_duration;
+void Burnwire ::START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     this->startBurn();
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 }
@@ -88,13 +86,4 @@ void Burnwire ::STOP_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) {
     this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
 }
 
-void Burnwire ::parameterUpdated(FwPrmIdType id) {
-    if (id == this->PARAMID_SAFETY_TIMER) {
-        Fw::ParamValid valid;
-        this->m_safetyMaxCount = this->paramGet_SAFETY_TIMER(valid);
-        this->log_ACTIVITY_HI_SafetyTimerSet(this->m_safetyMaxCount);
-    }
-    this->log_ACTIVITY_HI_SafetyTimerSet(m_safetyMaxCount);
-}
-
 }  // namespace Components

FprimeZephyrReference/Components/Burnwire/Burnwire.fpp

@@ -8,14 +8,14 @@ module Components {
 
         # @ Examplesync command
         sync command START_BURNWIRE(
-            max_duration: U32
         )
 
 
 
         sync command STOP_BURNWIRE(
         )
 
+
         # @ Example telemetry counter
         # telemetry ExampleCounter: U64
 
@@ -29,9 +29,11 @@ module Components {
             severity activity high\
             format "Safety Timer State: {} "
 
-        event SafetyTimerSet(max_duration: U32) \
+
+        event SafetyTimerState(burnwire_status: U32) \
             severity activity high\
-            format "Safety Timer Set to: {} seconds"
+            format "Safety Timer State: {} "
+
 
         # @ Example port: receiving calls from the rate group
         # sync input port run: Svc.Sched
@@ -50,7 +52,7 @@ module Components {
 
         # @ Example parameter
         # param PARAMETER_NAME: U32
-        param SAFETY_TIMER: U32 default 5
+        param SAFETY_TIMER: U32 default 10
 
         ###############################################################################
         # Standard AC Ports: Required for Channels, Events, Commands, and Parameters  #

FprimeZephyrReference/Components/Burnwire/Burnwire.hpp

@@ -50,8 +50,6 @@ class Burnwire final : public BurnwireComponentBase {
                          U32 context           //!< The call order
                          ) override;
 
-    void parameterUpdated(FwPrmIdType id) override;
-
     // helper functions
     void startBurn();
 
@@ -63,15 +61,15 @@ class Burnwire final : public BurnwireComponentBase {
     // ----------------------------------------------------------------------
 
     //! Handler implementation for command START_BURNWIRE
-    void START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, U32 max_duration) override;
+    void START_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;
 
     //! Handler implementation for command STOP_BURNWIRE
     void STOP_BURNWIRE_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) override;
 
     Fw::On m_state = Fw::On::OFF;      // keeps track if burnwire is on or off
     std::atomic<U32> m_safetyCounter;  // makes this an atomic variable (so its set only in one command),
                                        // you read and write half the value bc a corrupted read could be dangerouts
-    U32 m_safetyMaxCount = 5;          // max count for safety timer (default 10 seconds)
+    U32 m_safetyMaxCount = 10;         // max count for safety timer (default 10 seconds)
 };
 
 }  // namespace Components

FprimeZephyrReference/Components/Burnwire/docs/sdd.md

@@ -1,6 +1,8 @@
 # Components::Burnwire
 
-Driving the Burnwire on and off. The deployment will be handled by the Antenna Deployment component TODO ADD details
+Driving the Burnwire on and off. This component activates the two pins that are required to heat the burnwire resisitor. The burnwire deployment will be handled by the Antenna Deployment, that will call the ports in the burnwire deployment. For testing, the commands to directly call the burnwire have been left in.
+
+Burnwire is agnostic to the ideal safety count, it simply sets it to be whatever the port or command passes onto
 
 ## Sequence Diagrams
 Add sequence diagrams here
@@ -9,12 +11,13 @@ Add sequence diagrams here
 Add requirements in the chart below
 | Name | Description | Validation |
 | ---- | -----------  | ------ |
-|BW-001|The burnwire shall turn on in response to a port call |Hardware Test|
-|BW-002|The burnwire shall turn off in response to a port call |Hardware Test|
+|BW-001|The burnwire shall turn on and off in response to a port calls |Hardware Test|
+|BW-002|The burnwire shall turn on and off in response to commands (TBR for testing for now) |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 attached to a 1Hz rate group that can be changed within the code |Integration Test|
-|BW-006|The burnwire safety time shall emit an event when it starts and stops |Integration Test|
+|BW-005|The burnwire component shall be controlled by a safety timeout attached to a 1Hz rate group |Integration Test|
+|BW-006|The safety timeout shall emit an event when it is changes | Integration test|
+|BW-007|The burnwire safety time shall emit an event when it starts and stops |Integration Test|
 
 ## Port Descriptions
 Name | Type | Description |
@@ -28,14 +31,15 @@ Name | Type | Description |
 ## Commands
 | Name | Description |
 | ---- | -----------  |
-|START_BURNWIRE|Starts the Burn|
+|START_BURNWIRE|Starts the Burn. Takes a argument max_duration which sets the parameter safetyMaxCount to timeout the burnwire|
 |STOP_BURNWIRE|Stops the Burn|
 
 ## Events
 | Name | Description |
 |---|---|
-|Burnwire_Start|Emitted once the burnwire has started|
-|Burnwire_Stop|Emitted once the burnwire has ended|
+|SetBurnwireState|Emits whether the burnwire turns off or on when it changes state|
+|SafetyTimerStatus|Emits when the Safety Time has stopped or started|
+|SafetyTimerState|Emits  the safety timer argument when it starts|
 
 
 ## Component States
@@ -55,4 +59,4 @@ Add unit test descriptions in the chart below
 
 ## Parameter
 | Name | Description |
-| m_safetyMaxCount | The maximum amount that the burnwire will burn before stopping itself for safety |
+|   SAFETY_TIMER   | By Default set in fpp (currently 10) is the max time the burnwire should ever run|