Recent changes to BlinkingLED

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 14:28:28 -0000

--- v18
+++ v19
@@ -30,9 +30,9 @@
 * HSM_Setup.h - through this setup file should be your state machines connected with the rest of the code. It's generated only if it doesn't exist yet.

 ##Create BSP and the main entry
-I have found a nice piece of code implementing the timer for Win32 and Linux as well at https://www.teuniz.net/Timer_code/. We will use it as timer BSP.
+I have found a nice piece of the code implementing the timer for Win32 and Linux as well at https://www.teuniz.net/Timer_code/. We will use it as the timer BSP.

-The main.c is the main entry, is has to initialise the HSM framework, and timer. There are also implemented helper functuion such as LedOn() and LedOff().
+The main.c is the main entry, it has to initialise the HSM framework and timer. There are also implemented helper functions such as LedOn() and LedOff().
 ~~~
 #include <stdio.h>
 #include <stdlib.h>
@@ -82,7 +82,7 @@
 ~~~

 ##Modify the HSM_Setup.h
-The compiler needs to know prototypes os all function we used in the diagram. The HSM_Setup.h is the right file where to define the protopypes or to include header files. Simply add the declaration as follows:
+The compiler needs to know prototypes of all functions we used in the diagram. The HSM_Setup.h is the right file where to define protopypes or to include header files. Simply add the declaration as follows:
 ~~~
 // Include all files you need here
 #include <stdint.h>

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 11:48:33 -0000

--- v17
+++ v18
@@ -12,7 +12,7 @@
 + The "On" state turns the LED on in the entry action (LedOn();),
 + When the eTimeout event arrives in the "On" state, the "On" state transitions back to the "Off" state. The cycle repeats forever because the eTimeout events keep getting generated at the pre-determined rate.

-The diagram is exported into the [XMI file](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED.xmi) you can find attached.
+The diagram is exported into the [XMI file](https://sourceforge.net/projects/cuml/files/examples/BlinkingLED/BlinkingLED.xmi/download) you can find attached.

 ##Generating Code
 Open console and type in the following command line.
@@ -119,3 +119,5 @@

 That's all. Try to run the executable file blinkingLED.exe.
 ![Blinking LED in WIN32 console](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED_console.png)
+
+You can download the [source code](https://sourceforge.net/projects/cuml/files/examples/BlinkingLED/BlinkingLED_src.zip/download) and the [diagram](https://sourceforge.net/projects/cuml/files/examples/BlinkingLED/BlinkingLED.zargo/download)

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 11:42:46 -0000

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 09:50:04 -0000

--- v15
+++ v16
@@ -82,7 +82,7 @@
 ~~~

 ##Modify the HSM_Setup.h
-The compiler needs to know prototypes os all function we have used in the diagram. The HSM_Setup.h is the right file where to define the protopypes or to include helper files. Simply add the declaration as follows:
+The compiler needs to know prototypes os all function we used in the diagram. The HSM_Setup.h is the right file where to define the protopypes or to include header files. Simply add the declaration as follows:
 ~~~
 // Include all files you need here
 #include <stdint.h>
@@ -94,8 +94,8 @@

 ##Makefile and compilation
 To be able to build the program on your computer a C-compiler is needed. You are free
-to use whatever compiler you have installed.
-The Makefile for MinGW gcc compiler is easy to write.
+to use whatever compiler you have installed. I used the GCC toolchain for MinGW.
+The Makefile is easy to write.
 ~~~
 CC = gcc
 CFLAGS = -I.
@@ -117,5 +117,5 @@
 gcc -o blinkingLED main.o blinkingLED_FSM.o HSM_Framework.o timer.o
 ~~~

-That's all. Your example blinking application is done, try to run the blinkingLED.exe
+That's all. Try to run the executable file blinkingLED.exe.
 ![Blinking LED in WIN32 console](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED_console.png)

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 09:44:09 -0000

--- v14
+++ v15
@@ -6,11 +6,10 @@

 ![Blinking LED statechart diagram](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED.png)

-1. The initial transition leads to the state "Off" which turns the LED off in the entry action (LedOff();),
-+ As second action a counter starts to countdown with time passed as a parameter.
+1. The initial transition contain an action which starts the timer responsible to generation of the eTimeout signal every half second,
++ The initial transition leads to the state "Off" which turns the LED off in the entry action (LedOff();),
 + When the eTimeout event arrives in the "Off" state, the "Off" state transitions to the "On" state,
 + The "On" state turns the LED on in the entry action (LedOn();),
-+ As second action a counter starts again to countdown with time passed as a parameter.
 + When the eTimeout event arrives in the "On" state, the "On" state transitions back to the "Off" state. The cycle repeats forever because the eTimeout events keep getting generated at the pre-determined rate.

 The diagram is exported into the [XMI file](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED.xmi) you can find attached.
@@ -31,10 +30,92 @@
 * HSM_Setup.h - through this setup file should be your state machines connected with the rest of the code. It's generated only if it doesn't exist yet.

 ##Create BSP and the main entry
+I have found a nice piece of code implementing the timer for Win32 and Linux as well at https://www.teuniz.net/Timer_code/. We will use it as timer BSP.
+
+The main.c is the main entry, is has to initialise the HSM framework, and timer. There are also implemented helper functuion such as LedOn() and LedOff().
+~~~
+#include <stdio.h>
+#include <stdlib.h>
+#include "HSM_Framework.h"
+#include "blinkingLED_FSM.h"
+#include "timer.h"
+
+void LedOn(void)
+{
+    printf("LED ON\n");
+}
+
+void LedOff(void)
+{
+    printf("LED OFF\n");
+}
+
+void TimerHandler(void)
+{
+    HSM_AddPendingEvent( &blinkingLED_FSM, eTimeout );
+}
+
+void StartTimer(int ms)
+{
+    if(start_timer(ms, &TimerHandler))
+    {
+        printf("\n timer error\n");
+        exit(EXIT_FAILURE);
+    }
+}
+
+int main(void)
+{
+    //first of all we need to init state machine framework
+    HSM_Init();
+
+    printf("\npress ctl-c to quit.\n");
+
+    //the main infinite loop
+    while(1)
+    {
+        HSM_ProcessEvents();
+    }
+
+    return EXIT_SUCCESS;
+}
+~~~

 ##Modify the HSM_Setup.h
+The compiler needs to know prototypes os all function we have used in the diagram. The HSM_Setup.h is the right file where to define the protopypes or to include helper files. Simply add the declaration as follows:
+~~~
+// Include all files you need here
+#include <stdint.h>
+
+extern void LedOn(void);
+extern void LedOff(void);
+extern void StartTimer(int ms);
+~~~

 ##Makefile and compilation
+To be able to build the program on your computer a C-compiler is needed. You are free
+to use whatever compiler you have installed.
+The Makefile for MinGW gcc compiler is easy to write.
+~~~
+CC = gcc
+CFLAGS = -I.
+LDFLAGS =

-TODO
+%.o: %.c
+   $(CC) $(CFLAGS) -o $@ -c $<

+blinkingLED: main.o blinkingLED_FSM.o HSM_Framework.o timer.o
+   $(CC) -o $@ $^ $(LDFLAGS)
+~~~
+
+Type make in a console located into your folder. You should see something like this:
+~~~
+gcc -I. -o main.o -c main.c
+gcc -I. -o blinkingLED_FSM.o -c blinkingLED_FSM.c
+gcc -I. -o HSM_Framework.o -c HSM_Framework.c
+gcc -I. -o timer.o -c timer.c
+gcc -o blinkingLED main.o blinkingLED_FSM.o HSM_Framework.o timer.o
+~~~
+
+That's all. Your example blinking application is done, try to run the blinkingLED.exe
+![Blinking LED in WIN32 console](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED_console.png)

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 09:04:20 -0000

--- v13
+++ v14
@@ -4,7 +4,7 @@
 ##Drawing the Diagram
 For this example I was using the ArgoUML editor. The final diagram is shown on the picture below.

-![Blinking LED statechart diagram](https://sourceforge.net/p/cuml/wiki/Examples/attachment/BlinkingLED.png)
+![Blinking LED statechart diagram](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED.png)

 1. The initial transition leads to the state "Off" which turns the LED off in the entry action (LedOff();),
 + As second action a counter starts to countdown with time passed as a parameter.
@@ -13,7 +13,7 @@
 + As second action a counter starts again to countdown with time passed as a parameter.
 + When the eTimeout event arrives in the "On" state, the "On" state transitions back to the "Off" state. The cycle repeats forever because the eTimeout events keep getting generated at the pre-determined rate.

-The diagram is exported into the [XMI file](https://sourceforge.net/p/cuml/wiki/Examples/attachment/BlinkingLED.xmi) you can find attached.
+The diagram is exported into the [XMI file](https://sourceforge.net/p/cuml/wiki/BlinkingLED/attachment/BlinkingLED.xmi) you can find attached.

 ##Generating Code
 Open console and type in the following command line.

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 09:02:58 -0000

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 09:02:36 -0000

BlinkingLED modified by Petr Pazourek

Petr Pazourek — Wed, 25 Oct 2017 07:25:19 -0000

Examples modified by Petr Pazourek

Petr Pazourek — Tue, 24 Oct 2017 14:57:21 -0000

--- v9
+++ v10
@@ -2,7 +2,7 @@
 There is a very simple example which shows how to work with the Cuml tool.

 ##Drawing the Diagram
-For this example I was using the ArgoUML editor. The final diagram is shiown on the picture below.
+For this example I was using the ArgoUML editor. The final diagram is shown on the picture below.

 ![Blinking LED statechart diagram](https://sourceforge.net/p/cuml/wiki/Examples/attachment/BlinkingLED.png)

@@ -34,7 +34,7 @@

 ##Modify the HSM_Setup.h

-##Makefile a compilation
+##Makefile and compilation

 TODO