SinelaboreRT - wiki:getting_started

Getting started on macOS with Astah and Clang

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 May 2024 20:40:48 +0000

Getting started on macOS with Astah and Clang

This section guides you through the whole development process from designing a state machine to integrating it into an application. This will help you to get familiar with the code generator and its features.

All files for this tutorial are available in this folder: examples/microwave_handbook_astah_win32

A Microwave Oven

In this section we create the model of a simple microwave oven using a state machine diagram. A microwave oven was chosen because it is self-explanatory and not too complex to model. To keep this example as simple and clear as possible the hardware interaction routines are excluded. The following figure 1 shows the hardware of our fictitious microwave oven. For this example we are using the Astah UML Modelling tool. If you use another supported UML tool the required steps are slightly different. But if you are familiar with your UML tool it should be no problem to follow the tutorial and create the model on your own. In the appendix you will find hints on how to draw state diagrams for all the supported tools. It is recommended to have a quick look over the section that covers your tool. In addition the examples folder of your installation contains models for all supported tools (e.g. Enterprise Architect, UModel . . . ).

Figure 1: Fictitious microwave oven. With a wheel the cooking time can be adjusted between 0 – 60 seconds. The power can be set to high (II) or low (I).

The oven controller should be able do the following things:

Cooking time can be adjusted using a wheel between 0s and 60s.
Cooking starts if the cooking time is larger than zero. And the door is closed.
If the door is opened during cooking the microwave generator is switched off. Cooking time stops.
Cooking continuous if the cooking time is not over and the door is closed again
Cooking stops if the cooking time is over or the time is adjusted to zero.
Cooking time and power can be changed at any time.

Drawing the State Machine Diagram

This example shows several UML state machine elements that make up a state machine. It is enough to generate production ready code out of it. Please note that the design presented here is not the only possible solution for the given requirements. Also some functions of a real microwave oven – e.g. control of a lamp in the oven – are still missing.

Figure 2: Complete state machine design of the microwave oven. All necessary actions, guards, entry and exit code were added. The model was created with Astah. It is running on Windows and MacOS. One of the nice new features is a free plugin that shows you a state transition table of the state machine model. It gives you a quick overview of where you have modelled state transitions from and to. And where transitions might be missing.

Creating Code

It is assumed you have Java and clang installed. For a check if everything is installed correctly open a command window and change the working directory to this folder. Then type in the following commands.

C:\>java −version
java -version
java version "13.0.2" 2020-01-14
Java(TM) SE Runtime Environment (build 13.0.2+8)
Java HotSpot(TM) 64-Bit Server VM (build 13.0.2+8, mixed mode, sharing)

Check that you have a compiler installed (call clang -v). Otherwise install the developer tools for macOS.

Your output should look similar. Details might differ depending on your installed program versions. Now change to the ready made example in the examples folder. Depending on your installation change to the following examples folder:

your path\sinelaboreRT4.1\examples\microwave_handbook_astah_win32

Type in make clean to first remove existing built results. Then type in make to build everything.

make
java -cp ../../bin/*:../*:/Applications/astahprofessional/astahprofessional.app/Contents/Java/* codegen.Main -l cx -v -p ASTAH -o oven -t "final:oven:machine"  oven_model.asta
Verbose mode on
Command line parsing success!
Open project: oven_model.asta
Starting robustness tests of state machine ...
State names: .............. 
Machine hierarchy: ........ 
Machine height = 2
Transitions: .............. 
Default states: ........... 
Final states: ............. 
Choices: .................. 
No. of children in composites: ... 
Connectivity of states: ...
M1054: State Error has no outgoing transitions which indicates a dead end -> check your design.
Can't find the License.txt file or invalid file. Codegen is running in demo mode
Expected license file location: /Users/pmueller/develop/sinelabore/statemachine generator/Cadifra CodeGen/distribution_folder/sinelaboreRT4.1/bin/License.txt
Running in demo mode!
gcc -Wall -g -I. main.c -c -o main.o
java -cp ../../bin/*:../*:/Applications/astahprofessional/astahprofessional.app/Contents/Java/* codegen.Main -A -l cx -v -p ASTAH -o oven -t "final:oven:selftest"  oven_model.asta
Verbose mode on
Command line parsing success!
Parsing successfully finished.
Checking nodes ...
Checking for unique node names
Merging actions TestMicrowave and TestLamp
Merging actions a75992a1_3417_452d_8b54_1302dc8128b7 and TestSomethingElse
gcc -Wall -g -I. oven.c -c -o oven.o
gcc -Wall -g -I. oven_hlp.c -c -o oven_hlp.o
gcc -Wall -g -I. oven_selftest.c -c -o oven_selftest.o
gcc  -o oven.exe main.o oven.o oven_hlp.o oven_selftest.o

The oven binary should be built successfully now. Start the program and type several times + ti increment the cooking timer. Then press c to close the door. Watch what happens. Test the other events you can fire.

It is now recommended to start your UML editor again. And play with the state diagram. Look into the generated code to get familiar with the many possibilities the code generator offers.

Some additional notes:

The code generator can also generate code from activity diagrams. The example also contains an activity diagram for the self test algorithm (basic, just as example).
The code generator also supports the generation from the Astah SysML tool.
Astah is a very nice cross platform tool not only available for macOS. Try it out if you have not used it so far.

~~DISCUSSION|Leave your comments~~

[Windows, Clang, Astah, UMLTool]

Getting started on Windows with Visual Studio and Astah

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 May 2024 20:40:58 +0000

Getting started on Windows with Visual Studio and Astah

All files for this tutorial are available in this folder: examples/microwave_visual_studio_c and available here as zip file.

A Microwave Oven

Figure 1: Simplified microwave oven. With a wheel the cooking time can be adjusted between 0 – 60 seconds. The power can be set to high (II) or low (I).

The oven controller should be able do the following things:

Cooking time can be adjusted using a wheel between 0s and 60s.
Cooking starts if the cooking time is larger than zero. And the door is closed.
If the door is opened during cooking the microwave generator is switched off. Cooking time stops.
Cooking continuous if the cooking time is not over and the door is closed again
Cooking stops if the cooking time is over or the time is adjusted to zero.
Cooking time and power can be changed at any time.

Drawing the State Machine Diagram

To fulfil the requirements a hierarchical state machine was designed. Therefore events that should be handled from every state must only be modelled once on the outer (parent) state.

Creating Code

It is assumed you have Java and the Visual Studio installed on your PC. For a check whether everything is installed correctly open a command window and change the working directory to this folder. Then type in the following commands.

C:\>java −version
java -version
java version "13.0.2" 2020-01-14
Java(TM) SE Runtime Environment (build 13.0.2+8)
Java HotSpot(TM) 64-Bit Server VM (build 13.0.2+8, mixed mode, sharing)

Your output should look similar. Details might differ depending on your installed java versions. Now change to the ready made example in the examples folder. Depending on your installation change to the following examples folder:

cd "your path\sinelaboreRT4.3\examples\microwave_visual_studio_c"

To recreate the code open a command window and start the generation batch file. Check whether the paths inside the script are ok for your installation. Most probably you have to adjust one or the other path. Your output should be similar:

Verbose mode on
Command line parsing success!
Parsing successfully finished.
Checking nodes ...
Checking for unique node names
Merging actions TestMicrowave and TestLamp
Merging actions bdc3d21b_a5c3_4ec5_b4b1_e9fd41b68d98 and TestSomethingElse
Verbose mode on
Command line parsing success!
Open project: oven_model.asta
Starting robustness tests of state machine ...
State names: ..............
Machine hierarchy: ........
Machine height = 2
Transitions: ..............
Default states: ...........
Final states: .............
Choices: ..................
No. of children in composites: ...
Connectivity of states: ...
M1054: State Error has no outgoing transitions which indicates a dead end -> check your design.
Can't find the License.txt file or invalid file. Codegen is running in demo mode
Expected license file location: /C:/sinelaboreRT4.3/bin/License.txt
Running in demo mode!

Double click on the sln file to load the project with Visual Studio. It is a C++ console project. The files generated from the UML state machine and the activity diagram are all stored in the folder called generated. A simulation of a timer and the microwave hardware is provided in helpers folder.

Next compile the solution in Visual Studio. There should be no compile errors.

Figure 3: Visual Studio Console Project. The batch file is used to create the code from the UML models.

The oven exe should be built successfully now. Start the program and type several times + to increment the cooking timer. Then press c to close the door. Watch what happens. Test the other events you can fire.

It is now recommended to start your UML editor again. And play with the state diagram. Look into the generated code to get familiar with the many possibilities the code generator offers.

Figure 4: Executing the built oven simulation.

Some additional notes:

The code generator can also generate code from activity diagrams. The example also contains an activity diagram for the self test algorithm (basic, just as example).

~~DISCUSSION:closed|Leave your comments~~

[Windows, Astah, Visual, Studio]

Getting started on Windows with Cadifra and MinGW

anonymous@undisclosed.example.com (Anonymous) — Sat, 05 Jun 2021 14:40:33 +0000

Getting started on Windows with Cadifra and MinGW

All files for this tutorial are available in this folder: examples/microwave_handbook_cadifra

A Microwave Oven

In this section we create the model of a simple microwave oven using a state machine diagram. A microwave oven was chosen because it is self-explanatory and not too complex to model. To keep this example as simple and clear as possible the hardware interaction routines are excluded. The following figure 1 shows the hardware of our fictitious microwave oven. For this example we are using the Cadifra UML editor. If you use another supported UML tool the required steps are slightly different. But if you are familiar with your UML tool it should be no problem to follow the tutorial and create the model on your own. In the appendix you will find hints on how to draw state diagrams for all the supported tools. It is recommended to have a quick look over the section that covers your tool. In addition the examples folder of your installation contains models for all supported tools (e.g. Enterprise Architect, UModel . . . ).

Figure 1: Fictitious microwave oven. With a wheel the cooking time can be adjusted between 0 – 60 seconds. The power can be set to high (II) or low (I).

The oven controller should be able do the following things:

Cooking time can be adjusted using a wheel between 0s and 60s.
Cooking starts if the cooking time is larger than zero. And the door is closed.
If the door is opened during cooking the microwave generator is switched off. Cooking time stops.
Cooking continuous if the cooking time is not over and the door is closed again
Cooking stops if the cooking time is over or the time is adjusted to zero.
Cooking time and power can be changed at any time.

Drawing the Initial Diagram

To start designing a state machine diagram, you first have to start the Cadifra UML editor and select the state machine mode either from the tool bar or from the menu entry Diagram→State. Now you can draw states and transitions. Right click to the drawing area to select the state chart element you want to use. Create step by step the complete start chart. The next figure shows an initial diagram fulfilling the above requirements. You can either draw it yourself or load it from the folder example1 located in the installation directory.

Figure 2: First state machine design of the microwave oven. Only states and events are modelled yet.

Such an initial design is already useful. It can be used to discuss (e.g. with customers) if the requirements are fulfilled and it reacts to all events as expected. At this stage often unclear points in the the specification can be identified. E.g. in our design a user has to open the door once after the cooking time is over before cooking can be started again. This behavior is not explicitly specified in the requirements. It might be acceptable but it is also possible to go directly to state idle instead. Our initial design is not optimal as you can easily see. Requirement six (power and cooking time can be adjusted at any time) leads to a lot of similar state transitions. To avoid this the design can be changed into a hierarchical one.

The hierarchical version

To convert the existing design into a hierarchical one move the existing states into a new parent state. The previous states are now children of the new state called Super. The power and time related events are now handled by the outer state. Please note that the outer state is a history state. This is necessary because we want to go back to the last inner state after event processing of events handled by the outer state. So far the machine can receive events and change state as reaction. But some important details are still missing. For example a close door event in state idle causes a state change to cooking even if the cooking time was not set to a value ≠ zero. This is in opposite to requirement two. To avoid a state change a guard must be added or alternatively a choice as done here. Furthermore action and entry/exit code is still missing all over the diagram. An additional Error state was added too. It is entered if the hardware self test failed after power on. The next figure 3 shows the final state machine design. Functions with prefix timer are helper functions providing timer functionality. Functions with prefix oven are functions related to power control. See next section for further details. In this example we touched the most basic design elements of a state charts. In the next section we focus on code generation and execution of our design on a PC. Please note that the design presented here is not the only possible solution for the given requirements. Also some functions of a real microwave oven – e.g. control of a lamp in the oven – are still missing.

Figure 3: Complete state machine design of the microwave oven. All necessary actions, guards, entry and exit code was added.

Creating Code

It is assumed you have Java and MinGW (a gcc compiler for Windows) installed. For a check if everything is installed correctly open a command window and change the working directory to this folder. Then type in the following commands.

C:\>java −version
java version "1.8.0_231"
Java(TM) SE Runtime Environment ( build 1.8.0_231−b11)
Java HotSpot(TM) 64−Bit Server VM ( build 25.231−b11 , mixed mode)

Add the bin folder of MinGW to your path and check if the compiler can be called now.

C:\>path %path%;C:\MinGW\bin C:\>mingw32−gcc
mingw32−gcc: fatal error: no input files
compilation terminated .

Your output should look similar. Details might differ depending on your installed program versions. Now change to the ready made example in the examples folder. I assume that the code generator is directly installed on c:\.

C:\>cd c:\sinelaboreRT4.1\examples\microwave_handbook_cadifra_win32

Type in mingw32-make clean to first remove existing built results. Then type in mingw32-make to build everything.

mingw32-make
java -cp "../../bin/*" codegen.Main -p CADIFRA -p Cadifra -l cx -doxygen -o oven first_example_step3.cdd
Create inline doxygen of state machine function
A linked note starts not with 'Compartment' and is therefore ignored
Starting robustness tests of state machine ...
State names: ..............
Machine hierarchy: ........
Machine height = 2
Transitions: ..............
Default states: ...........
Final states: .............
Choices: ..................
No. of children in composites: ...
Connectivity of states: ...
M1054: State Error has no outgoing transitions which indicates a dead end -> check your design.
Can't find the License.txt file or invalid file. Codegen is running in demo mode
Expected license file location: ../../bin/License.txt
Running in demo mode!
gcc -Wall -g main.c -c -o main.o
gcc -Wall -g oven_hlp.c -c -o oven_hlp.o
gcc -Wall -g oven.c -c -o oven.o
gcc  -o oven main.o oven_hlp.o oven.o

C:\sinelaboreRT4.1\examples\microwave_handbook_cadifra_win32>

The oven.exe file should be built successfully now. Start the program and type several times + ti increment the cooking timer. Then press c to close the door. Watch what happens. Test the other events you can fire.

It is now recommended to start the Cadifra UML editor again. And play with the state diagram. Look into the generated code to get familiar with the many possibilities the code generator offers.

~~DISCUSSION|Leave your comments~~

[Windows, MinGW, Cadifra]

Generate production quality code from state diagrams created with DrawIO Desktop

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 May 2024 20:41:36 +0000

Generate production quality code from state diagrams created with DrawIO Desktop

SinelaboreRT generates readable and maintainable code from hierarchical UML state machines created with DrawIO. With its unique features SinelaboreRT covers well the requirements of embedded real-time and low power application developers. With its other language backends it is also a perfect tool for developers of server or desktop applications.

Key Features:

Automated robustness checks before code generation
No run-time environment needed
Can be used with any CPU and with or without OS/RTOS
Code generation especially for embedded real-time and high availability systems.
Fits well in different system designs (foreground/background, RTOS-based …)
No gap between design and code
Support for automatic test-case generation
Simulation in interactive or batch mode.
Optionally generating trace code
Generated code creates no trouble when using static code checkers

How to get started ?

Download the code generator and use the DrawIO microwave example in the examples folder. It shows a fully functional example of a microwave oven in C. Make changes in the model, re-create the state machine code and then compile/run the example again. This is the fastest way to learn how to use the code generator. To recreate the code from the model file you need a Posix like development environment.

An example command like to generate C-code from a model called oven looks like this: java -cp “pathToCodegenJarFolder/*” codegen.Main -p drawio -l cx -o oven oven.drawio

Only special elements from the UML palette are supported from the parser. Below a list of supported elements is shown and an image where to find them.

Supported State Machine Elements

The supported elements are:

Normal state
Hierarchical state
Flat / deep history (appending (H) and (H*) in the state name)
Final state
Initial state
(Signal-)Events with event name, guard and action – Initial and final pseudo-states
Comment
Choice

How to

Connecting transitions to states

Start drawing a transition using the arrow elements on a state. Make sure the transition starts and ends on the light green circles that appear when you hover over the state borders. A nice tutorial is available here: https://www.drawio.com/doc/faq/connectors

Setting guards on the outgoing transitions of choices

Delete the default text of the choice element. Then double click on the transition and enter the guard text. Don't forget the square brackets.

Adding events/guards/actions to a transition

Double click on the transition and add the event, optionally a guard in square brackets and optionally the action code which is introduced by a slash. Example: ev1[i==4]/printf(“i=4”);

How can I selected the diagram in my model file?

Use the command line parameter -t. Here is an example how to select diagram oven from the model file: -t oven. If no diagram is specified (e.g there is only one) the first diagram found in the model file is taken.

How to add substates?

Delete the text of the composite state and add the substates within the empty field. Unfortunately there is no option the have enty/exit/do code in a composite state and child states. In this case use a comment to specific the text of the composite state as shown in the picture above.

How can I set include files for the generated state machine code file?

Use an unconnected comment as shown above starting with header: in the first line.

Noteworthy per operating system

anonymous@undisclosed.example.com (Anonymous) — Mon, 19 Dec 2022 09:53:27 +0000

Noteworthy per operating system

All systems (Windows, Mac, Linux ...)

Usage of the code generator from the command line is most flexible. Integration in Makefiles or the like is super easy. A call from the command line looks like:
java -cp “~/sinelaboreRT5.2/bin/*” codegen.Main …

Mac

A dmg file is provided. See Download for more information.

Windows

Windows users can use the code generator in two ways.

Method 1: Install a Windows executable which wraps the Java jar file. An installer is available in the bin folder of the download package. A double click on the installed executable opens the built in editor with an empty project. Right clicking a project file which was created previously with the integrated editor opens this project. Due to the fact that no configuration file is known at this point it is recommended to put a codegen.cfg file in the users home directory which at least contains the parameter DotPathWin.
Example: DotPathWin=“C:\\Graphviz-2.44.1\\bin\\dot.exe”

Method 2: Using the codegen.jar file directly and call it with the java.exe installed on your system.
Example: c:\jdk-11\bin\java.exe -cp “c:/sinelaboreRT5.2/bin/*” codegen.Main …

Generate production quality code from state diagrams created with StarUML

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 May 2024 20:41:27 +0000

Generate production quality code from state diagrams created with StarUML

The StarUML parser is work in progress. If you are interested in this feature send us a mail expressing your interest and specific needs.

SinelaboreRT generates readable and maintainable code from hierarchical UML state machines. With its unique features and the C code generator the tool covers well the requirements of embedded real-time and low power application developers. With its C++, Python and Java backend it is also a perfect tool for developers of server or desktop applications.

Key Features:

Automated robustness checks before code generation
No run-time environment needed
Can be used with any CPU and with or without OS/RTOS
Code generation especially for embedded real-time and high availability systems.
Fits well in different system designs (foreground/background, RTOS-based …)
No gap between design and code
Support for automatic test-case generation
Simulation in interactive or batch mode.
Optionally generating trace code
Generated code creates no trouble when using static code checkers

Drawing the State Machine Diagram

StarUML allows efficient drawing of state diagrams as part of a class. The following example state diagram shows the features that are supported from the code generator right now.

Creating Code

It is assumed you have a recent Java version installed e.g. on a Mac.

java --version
openjdk 17-ea 2021-09-14
OpenJDK Runtime Environment (build 17-ea+29-2576)
OpenJDK 64-Bit Server VM (build 17-ea+29-2576, mixed mode, sharing)

To generate code first export your model to XMI using “File → Export → XMI”. Then specify StarUML as modelling tool (-p struml) as well as the path to the state diagram inside the model file (-t “Model:class1” ). The command line to generate C-code looks like as follows:

java -cp "/path to codegen jar file/*" codegen.Main -l cx -p StarUML -o testcase -t "Model:class1"  testcase.xmi

This generates C-code from the specified state machine diagram.

Supported State Machine Elements

The code-generator supports a relevant subset of the design elements provided by Magic Draw. The supported elements are:

Hierarchical states
(Signal-)Events with event name, guard and action
Initial and final pseudo-states
History states (deep, flat)
Choices

Download the demo version and try it right now. It includes many other examples.

StarUML Draw HowTo

I'm not able to define header code as specified in the header comment

StarUML unfortunately does not export linked comments to the XMI file. Therefore specify the comment in the configuration file. Example

AdditionalMachineImplementationInclude=#include <stdint.h>\n#include "testcase_ext.h"\n#include "testcase.h"\n#include <stdio.h>\nextern TESTCASE_EVENT_T msg;\n\n

[UMLTool]

Getting started on Windows with Altova UModel and MinGW

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 May 2024 20:41:18 +0000

Getting started on Windows with Altova UModel and MinGW

All files for this tutorial are available in this folder: examples/microwave_handbook_umodel_win32

A Microwave Oven

Figure 1: Fictitious microwave oven. With a wheel the cooking time can be adjusted between 0 – 60 seconds. The power can be set to high (II) or low (I).

The oven controller should be able do the following things:

Cooking time can be adjusted using a wheel between 0s and 60s.
Cooking starts if the cooking time is larger than zero. And the door is closed.
If the door is opened during cooking the microwave generator is switched off. Cooking time stops.
Cooking continuous if the cooking time is not over and the door is closed again
Cooking stops if the cooking time is over or the time is adjusted to zero.
Cooking time and power can be changed at any time.

Drawing the State Machine Diagram

To fulfil the requirements a hierarchical state machine was designed. Therefore events that should be handled from every state must only be modelled once on the outer (parent) state.

Figure 2 Complete state machine design of the microwave oven. All necessary actions, guards, entry and exit code were added.

Creating Code

It is assumed you have Java and the MinGW compiler is installed. For a check if everything is installed correctly open a command window and change the working directory to this folder. Then type in the following commands.

C:\>java −version
java -version
java version "13.0.2" 2020-01-14
Java(TM) SE Runtime Environment (build 13.0.2+8)
Java HotSpot(TM) 64-Bit Server VM (build 13.0.2+8, mixed mode, sharing)

Check that you have a compiler installed. Add the bin folder of MinGW to your path and check if the compiler can be called now.

C:\>path %path%;C:\MinGW\bin 
C:\>mingw32−gcc
mingw32−gcc: fatal error: no input files
compilation terminated .

your path\sinelaboreRT4.1\examples\microwave_handbook_umodel_win32

Type in mingw32-make clean to first remove existing built results. Then type in mingw32-make to build everything.

mingw32-gcc.exe -Wall -g oven_hlp.c -c -o oven_hlp.o
mingw32-gcc.exe -Wall -g oven_selftest.c -c -o oven_selftest.o
java -cp "../../bin/*" codegen.Main -p UModel -l cx -t "MicrowaveOven:MachineClass" -doxygen -o oven oven.xmi
Create inline doxygen of state machine function
Starting robustness tests of state machine ...
State names: ..............
Machine hierarchy: ........
Machine height = 2
Transitions: ..............
Default states: ...........
Final states: .............
Choices: ..................
No. of children in composites: ...
Connectivity of states: ...
M1054: State Error has no outgoing transitions which indicates a dead end -> check your design.
Can't find the License.txt file or invalid file. Codegen is running in demo mode
Expected license file location: /Y:/develop/sinelabore/statemachine generator/Cadifra CodeGen/distribution_folder/sinelaboreRT4.1/bin/License.txt
Running in demo mode!
java -cp "../../bin/*" codegen.Main -p UModel -A -l cx -t "MicrowaveOven:MachineClass" -o oven oven.xmi
Checking nodes ...
Checking for unique node names
mingw32-gcc.exe -Wall -g oven.c -c -o oven.o
mingw32-gcc.exe -Wall -g main.c -c -o main.o
mingw32-gcc.exe  -o oven oven_hlp.o oven_selftest.o oven.o main.o

The oven exe should be built successfully now. Start the program and type several times + ti increment the cooking timer. Then press c to close the door. Watch what happens. Test the other events you can fire.

It is now recommended to start your UML editor again. And play with the state diagram. Look into the generated code to get familiar with the many possibilities the code generator offers.

Some additional notes:

The code generator can also generate code from activity diagrams. The example also contains an activity diagram for the self test algorithm (basic, just as example).

~~DISCUSSION:closed|Leave your comments~~

[Windows, Altova, UModel, MinGW]