Fixed compilation error with include of main.h. Added comment blocks to top of source files. Added build script.

Author: Geoffrey Hunter

build.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+mkdir -p build
+cd build
+cmake ..
+make
+./src/FunctionPointerStateMachineExample

src/CMakeLists.txt

@@ -1,4 +1,3 @@
-project(NewtonRaphson)
 
 set(HEADER_FILES
         main.h

src/Led.c

@@ -1,3 +1,12 @@
+///
+/// \file 				Led.c
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the Led module.
+/// \details
+///		See README.md in root dir for more info.
 
 #include <stdio.h>
 

src/Led.h

@@ -1,3 +1,13 @@
+///
+/// \file 				Led.h
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the Led module.
+/// \details
+///		See README.md in root dir for more info.
+
 #ifndef LED_H
 #define LED_H
 

src/StateMachine.c

@@ -1,72 +1,58 @@
+///
+/// \file 				StateMachine.c
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the StateMachine module.
+/// \details
+///		See README.md in root dir for more info.
+
+// System includes
 #include <stdio.h>
 
-#include "StateMachine.h"
-
-#include "Main.h"
+// Local includes
 #include "Led.h"
+#include "main.h"
+#include "StateMachine.h"
 
 
 typedef struct {
     const char * name;
     void (*func)(void);
 } stateFunctionRow_t;
 
-/// @brief  Maps a state to it's state transition function, which should be called
+/// \brief  Maps a state to it's state transition function, which should be called
 ///         when the state transitions into this state.
-/// @warning    This has to stay in sync with the state_t enum!
+/// \warning    This has to stay in sync with the state_t enum!
 static stateFunctionRow_t stateFunctionA[] = {
       // NAME         // FUNC
-    { "ST_INIT",      &Led_Init },      // ST_INIT
     { "ST_IDLE",      &Led_Idle },      // ST_IDLE
     { "ST_LED_ON",    &Led_On },        // ST_LED_ON
     { "ST_LED_OFF",   &Led_Off },       // ST_LED_OFF
 };
 
-/// @brief      All the possible events that can occur for this state machine.
-/// @details    Unlike states_t, these do not need to be kept in a special order.
-typedef enum {
-    EV_ANY,
-    EV_NONE,
-    EV_BUTTON_PUSHED,
-    EV_TIME_OUT,
-} event_t;
-
 typedef struct {
     state_t currState;
     event_t event;
     state_t nextState;
 } stateTransMatrixRow_t;
 
 static stateTransMatrixRow_t stateTransMatrix[] = {
-    // CURR STATE  // EVENT           // NEXT STATE
-    { ST_INIT,     EV_ANY,               ST_IDLE    },
+    // CURR STATE  // EVENT              // NEXT STATE
     { ST_IDLE,     EV_BUTTON_PUSHED,     ST_LED_ON  },
     { ST_LED_ON,   EV_TIME_OUT,          ST_LED_OFF },
     { ST_LED_ON,   EV_BUTTON_PUSHED,     ST_IDLE    },
     { ST_LED_OFF,  EV_TIME_OUT,          ST_LED_ON  },
     { ST_LED_OFF,  EV_BUTTON_PUSHED,     ST_IDLE    }
 };
 
-event_t event;
-
 void StateMachine_Init(stateMachine_t * stateMachine) {
     printf("Initialising state machine.\r\n");
-    stateMachine->currState = ST_INIT;
-}
-
-event_t StateMachine_GetEvent() {
-    if(buttonPushed) {
-        buttonPushed = false;
-        return EV_BUTTON_PUSHED;
-    }
-
-    // No event
-    return EV_NONE;
+    stateMachine->currState = ST_IDLE;
 }
 
-void StateMachine_RunIteration(stateMachine_t *stateMachine) {
-    // Get an event
-    event = StateMachine_GetEvent();
+void StateMachine_RunIteration(stateMachine_t *stateMachine, event_t event) {
 
     // Iterate through the state transition matrix, checking if there is both a match with the current state
     // and the event

src/StateMachine.h

@@ -1,8 +1,17 @@
+///
+/// \file 				StateMachine.h
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the StateMachine module.
+/// \details
+///		See README.md in root dir for more info.
+
 #ifndef STATE_MACHINE_H
 #define STATE_MACHINE_H
 
 typedef enum {
-    ST_INIT,
     ST_IDLE,
     ST_LED_ON,
     ST_LED_OFF
@@ -12,8 +21,17 @@ typedef struct {
     state_t currState;
 } stateMachine_t;
 
+/// \brief      All the possible events that can occur for this state machine.
+/// \details    Unlike states_t, these do not need to be kept in a special order.
+typedef enum {
+    EV_ANY,
+    EV_NONE,
+    EV_BUTTON_PUSHED,
+    EV_TIME_OUT,
+} event_t;
+
 void StateMachine_Init(stateMachine_t * stateMachine);
-void StateMachine_RunIteration(stateMachine_t *stateMachine);
+void StateMachine_RunIteration(stateMachine_t *stateMachine, event_t event);
 const char * StateMachine_GetStateName(state_t state);
 
 #endif

src/main.c

@@ -1,27 +1,50 @@
+///
+/// \file 				main.c
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the main entry point to the state machine example.
+/// \details
+///		See README.md in root dir for more info.
 
 #include <stdio.h>
 #include <stdbool.h>
 
 #include "StateMachine.h"
 
-bool buttonPushed = false;
-
 int main() {
     printf("main() called.\r\n");
 
+    // Create new state machine object
     stateMachine_t stateMachine;
 
     StateMachine_Init(&stateMachine);
     printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
 
-    // Run first iteration
-    StateMachine_RunIteration(&stateMachine);
+    // Push button to start flasher
+    printf("Button pushed.\r\n");
+    StateMachine_RunIteration(&stateMachine, EV_BUTTON_PUSHED);
+    printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
+
+    // Timeout
+    printf("Timeout.\r\n");
+    StateMachine_RunIteration(&stateMachine, EV_TIME_OUT);
+    printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
+
+    // Timeout
+    printf("Timeout.\r\n");
+    StateMachine_RunIteration(&stateMachine, EV_TIME_OUT);
+    printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
+
+    // Timeout
+    printf("Timeout.\r\n");
+    StateMachine_RunIteration(&stateMachine, EV_TIME_OUT);
     printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
 
-    // Let's pretend a button was pushed
-    buttonPushed = true;
+    // Push button again to stop flasher
     printf("Button pushed.\r\n");
-    StateMachine_RunIteration(&stateMachine);
+    StateMachine_RunIteration(&stateMachine, EV_BUTTON_PUSHED);
     printf("State is now %s.\r\n", StateMachine_GetStateName(stateMachine.currState));
 
     return 0;

src/main.h

@@ -1,3 +1,13 @@
+///
+/// \file 				main.h
+/// \author 			Geoffrey Hunter (www.mbedded.ninja) <gbmhunter@gmail.com>
+/// \edited             n/a
+/// \created			2017-04-15
+/// \last-modified		2018-03-19
+/// \brief 				Contains the main entry point to the state machine example.
+/// \details
+///		See README.md in root dir for more info.
+
 #ifndef MAIN_H
 #define MAIN_H