Phase 1 state machines

.github/actions/spelling/allow.txt

@@ -6,3 +6,5 @@ usec
 usecs
 workaround
 workarounds
+DEVICESM
+HACKSM

Drv/GpioDriverPorts/GpioDriverPorts.fpp

@@ -1,15 +1,15 @@
 module Drv {
 
   port GpioWrite(
-                  state: Fw.Logic
+                  $state: Fw.Logic
                 )
 
 }
 
 module Drv {
 
   port GpioRead(
-                 ref state: Fw.Logic
+                 ref $state: Fw.Logic
                )
 
 }

FppTest/CMakeLists.txt

@@ -14,12 +14,14 @@ include("${CMAKE_CURRENT_LIST_DIR}/../cmake/FPrime-Code.cmake")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/array/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/component/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/dp/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/state_machine/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/enum/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/struct/")
 set(SOURCE_FILES "source.cpp")
 set(MOD_DEPS
     ${PROJECT_NAME}/array
     ${PROJECT_NAME}/dp
+    ${PROJECT_NAME}/state_machine
     ${PROJECT_NAME}/enum
     ${PROJECT_NAME}/struct
     ${PROJECT_NAME}/component/empty

FppTest/state_machine/CMakeLists.txt

@@ -0,0 +1,21 @@
+set(SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
+)
+set(MOD_DEPS Fw/Sm)
+
+register_fprime_module()
+
+set(UT_SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTestMain.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTester.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
+)
+
+set(UT_MOD_DEPS STest)
+set(UT_AUTO_HELPERS ON)
+register_fprime_ut()

FppTest/state_machine/DeviceSm.cpp

@@ -0,0 +1,74 @@
+
+// ======================================================================
+// \title  DeviceSm.cpp
+// \author Auto-generated
+// \brief  cpp file for state machine DeviceSm
+//
+// ======================================================================            
+
+#include <Fw/Types/Assert.hpp>
+#include "DeviceSm.hpp"
+
+
+void FppTest::DeviceSm::init(const FwEnumStoreType stateMachineId)
+{
+    parent->DeviceSm_turnOff(stateMachineId);
+    this->state = OFF;
+
+}
+
+
+void FppTest::DeviceSm::update(
+    const FwEnumStoreType stateMachineId, 
+    const DeviceSm_Interface::DeviceSm_Signals signal, 
+    const Fw::SmSignalBuffer &data
+)
+{
+    switch (this->state) {
+
+            /**
+            * state OFF
+            */
+            case OFF:
+
+            switch (signal) {
+
+                case DeviceSm_Interface::DeviceSm_Signals::RTI_SIG:
+                        if ( parent->DeviceSm_g1(stateMachineId) ) {
+                            parent->DeviceSm_a1(stateMachineId, signal, data);
+                            parent->DeviceSm_turnOn(stateMachineId);
+                            this->state = ON;
+                        }
+
+                    break;
+
+                default:
+                    break;
+            }
+            break;
+
+            /**
+            * state ON
+            */
+            case ON:
+
+            switch (signal) {
+
+                case DeviceSm_Interface::DeviceSm_Signals::RTI_SIG:
+                        if (parent->DeviceSm_g2(stateMachineId, signal, data) ) {
+                            parent->DeviceSm_a2(stateMachineId);
+                            parent->DeviceSm_turnOff(stateMachineId);
+                            this->state = OFF;
+                        }
+
+                    break;
+
+                default:
+                    break;
+            }
+            break;
+
+        default:
+        FW_ASSERT(0);
+    }
+}

FppTest/state_machine/DeviceSm.fppi

@@ -0,0 +1,7 @@
+
+
+    enum DeviceSmStates {
+        OFF = 0
+        ON = 1
+    }
+

FppTest/state_machine/DeviceSm.hpp

@@ -0,0 +1,76 @@
+
+// ======================================================================
+// \title  DeviceSm.h
+// \author Auto-generated
+// \brief  header file for state machine DeviceSm
+//
+// ======================================================================
+
+#ifndef DEVICESM_H_
+#define DEVICESM_H_
+
+#include <Fw/Sm/SmSignalBuffer.hpp>
+#include <config/FpConfig.hpp>
+
+namespace FppTest {
+
+class DeviceSm_Interface {
+  public:
+    enum DeviceSm_Signals {
+      RTI_SIG,
+    };
+
+
+    virtual bool DeviceSm_g1(const FwEnumStoreType stateMachineId) = 0;
+
+
+    virtual bool DeviceSm_g2(
+        const FwEnumStoreType stateMachineId, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
+        const Fw::SmSignalBuffer &data) = 0;
+
+
+    virtual void DeviceSm_turnOff(const FwEnumStoreType stateMachineId) = 0;
+
+
+    virtual  void DeviceSm_a1(
+        const FwEnumStoreType stateMachineId, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
+        const Fw::SmSignalBuffer &data) = 0;
+
+
+    virtual void DeviceSm_turnOn(const FwEnumStoreType stateMachineId) = 0;
+
+
+    virtual void DeviceSm_a2(const FwEnumStoreType stateMachineId) = 0;
+
+
+};
+
+class DeviceSm {
+
+  private:
+    DeviceSm_Interface *parent;
+
+  public:
+
+    DeviceSm(DeviceSm_Interface* parent) : parent(parent) {}
+
+    enum DeviceSm_States {
+      OFF,
+      ON,
+    };
+
+    enum DeviceSm_States state;
+
+    void init(const FwEnumStoreType stateMachineId);
+    void update(
+        const FwEnumStoreType stateMachineId, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
+        const Fw::SmSignalBuffer &data
+    );
+};
+
+}
+
+#endif

FppTest/state_machine/DeviceSm.plantuml

@@ -0,0 +1,16 @@
+
+@startuml
+
+[*] --> OFF
+
+state OFF {
+    OFF::Entry: turnOff()
+}
+
+state ON {
+    ON::Entry: turnOn()
+}
+
+OFF --> ON : RTI [g1()]/a1(e)
+ON --> OFF : RTI [g2(e)]/a2()
+@enduml

FppTest/state_machine/HackSm.cpp

@@ -0,0 +1,98 @@
+
+// ======================================================================
+// \title  HackSm.cpp
+// \author Auto-generated
+// \brief  cpp file for state machine HackSm
+//
+// ======================================================================            
+
+#include <Fw/Types/Assert.hpp>
+#include "HackSm.hpp"
+
+
+void FppTest::HackSm::init(const FwEnumStoreType stateMachineId)
+{
+    parent->HackSm_turnOff(stateMachineId);
+    this->state = OFF;
+
+}
+
+
+void FppTest::HackSm::update(
+    const FwEnumStoreType stateMachineId, 
+    const HackSm_Interface::HackSm_Signals signal, 
+    const Fw::SmSignalBuffer &data
+)
+{
+    switch (this->state) {
+
+            /**
+            * state OFF
+            */
+            case OFF:
+
+            switch (signal) {
+
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
+                        parent->HackSm_turnOn(stateMachineId);
+                        this->state = ON;
+
+                    break;
+
+                case HackSm_Interface::HackSm_Signals::CHECK_SIG:
+                        parent->HackSm_doDiag(stateMachineId);
+                        this->state = DIAG;
+
+                    break;
+
+                default:
+                    break;
+            }
+            break;
+
+            /**
+            * state ON
+            */
+            case ON:
+
+            switch (signal) {
+
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
+                        parent->HackSm_turnOff(stateMachineId);
+                        this->state = OFF;
+
+                    break;
+
+                case HackSm_Interface::HackSm_Signals::CHECK_SIG:
+                        parent->HackSm_doDiag(stateMachineId);
+                        this->state = DIAG;
+
+                    break;
+
+                default:
+                    break;
+            }
+            break;
+
+            /**
+            * state DIAG
+            */
+            case DIAG:
+
+            switch (signal) {
+
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
+                        parent->HackSm_turnOff(stateMachineId);
+                        this->state = OFF;
+
+                    break;
+
+                default:
+                    break;
+            }
+            break;
+
+        default:
+        FW_ASSERT(0);
+    }
+}