SinelaboreRT - wiki:landing_pages

Cadifra Video Tutorial

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

Cadifra Video Tutorial

Part I

In this video we show how easy it is to use the sinelaboreRT code generator in combination with the Cadifra UML editor. We create a small state diagram. The diagram is then converted into C-code using the code generator. All development steps are shown.

Then a basic main.c file is used to send events to the state machine and execute it.

To follow the tutorial on your own download the demo version of sinelaboreRT and the Cadifra UML Editor from the download page. A C-compiler is needed (e.g. gcc) too to compile the C-code.

(5:17min)

Part II

In the second part of the video tutorial we extend the first example. S1 is changed into a composite state (i.e. a state with children). Two child states and several transitions are added too.

(5:40min)

Then the state machine C-code is generated again using the code generator. In the next step the main.c file is extended to send one of the new events to the machine.

Finally it is shown how to generate testcases from the state diagram. The automatically generated test cases provide a good basis for testing the state diagram.

Cadifra is a fast and lightweight UML Diagram Editor for Windows. It supports the following kinds of UML diagrams: Class, Object, Sequence, State and Use Case. Each diagram is stored in an own file. The SinelaboreRT codegen directly uses the state diagram model file. The state diagram editor is very good for designs with few hierarchy levels.

Generate production quality code from state diagrams created with Enterprise Architect

anonymous@undisclosed.example.com (Anonymous) — Sun, 04 Aug 2024 12:16:39 +0000

Generate production quality code from state diagrams created with Enterprise Architect

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

Watch the code generator in action

The following example shows how the code generator works by means of a simple microwave oven.

Requirements:

Cooking time can be adjusted from 0s and 60s.
Cooking starts if the cooking time is > 0s and the door is closed.
If the door is opened during cooking the microwave generator is switched off. The 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.

The sate machine below shows a possible solution.

To generate for example C code just export your model to XMI and call the code generator as follows:

java -jar codegen.jar -p EA -t "Model:Class Model:first_example_step3" -o oven first_example_step3.xml

After checking the model against a set of well-formedness rules (e.g. no double state names) the complete state machine code is generated.

Done!

Look into the generated files: oven.c oven.h oven_ext.h

In the examples folder you will find the complete code ready to be tested and expanded by you.

Supported State Machine Elements

The code-generator supports a subset of the design elements provided by Enterprise Architect. The supported elements are:

Hierarchical states
(Signal-)Events with event name, guard and action – Initial and final pseudo-states
History states (deep, flat)
Choices
Junctions
Constraints
Sub-machine states on various levels
Entry and exit pseudo-states
Regions on various levels

Find out more about the code generator

How sinelabore supports model based testing of state diagrams
How to interactively simulate your state diagram and generating trace code
Read section “Drawing State-Charts with Enterprise Architect” in the manual
How easy it is to add attributes and operations to the stateful class like shown below. Operations are mapped to C-functions. Attributes to members of the instance data of the state machine. This allows to add entry/exit code functions or other helper functions. Even the body code can be easily added with EA if you want. Presently attributes and operations are only generated in the C-backend.

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

Read the EA Howto for tips and tricks

Generate production quality code from state diagrams created with Magic Draw

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

Generate production quality code from state diagrams created with Magic Draw

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

Watch the code generator in action

The following example shows how the code generator works by means of a simple microwave oven.

Requirements:

Cooking time can be adjusted from 0s and 60s.
Cooking starts if the cooking time is > 0s and the door is closed.
If the door is opened during cooking the microwave generator is switched off. The 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.

The sate machine and the class diagram below shows a possible solution.

To generate for example C code call the code generator as follows:

java -cp "../../bin/*" codegen.Main-l cx -p md -t "Model:oven_package:oven" -o oven oven.xmi.xml

After checking the model against a set of well-formedness rules (e.g. no double state names) the complete state machine code is generated.

Done!

Look into the generated files:

oven.c oven.h oven_ext.h

In the examples folder you will find the complete code ready to be tested and expanded by you.

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
Junctions
Constraints

Find out more about the code generator

How sinelabore supports model based testing of state diagrams
How to interactively simulate your state diagram and generating trace code
Read section “Drawing State-Charts with Magic Draw” in the manual
How easy it is to add attributes and operations to the stateful class like shown below. Operations are mapped to C-functions. Attributes to members of the instance data of the state machine. This allows to add entry/exit code functions or other helper functions. Even the body code can be easily added with EA if you want. Presently attributes and operations are only generated in the C-backend.

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

Magic Draw HowTo

I don't see the on-entry/on-exit/do code in my state diagram

Since MD version 19 (at least recognised it there) it is necessary to copy your code to the body text. See example below:

Is it necessary to specify an action name for on-entry/on-exit/do code?

If there is text in the name fieled (as shown above) it will be considered for code generation. If the name field is left empty the body part is used for code generation. The body text can be longer than one line. An example is shown below.

Generate production quality code from state diagrams created with Modelio

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

Generate production quality code from state diagrams created with Modelio

SinelaboreRT generates readable and maintainable code from hierarchical UML state machines created with Modelio. With its unique features the tool covers well the requirements of embedded real-time and low power application developers. With its new C++ 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

Watch the code generator in action

The following example shows how the code generator works by means of a simple microwave oven.

Requirements:

Cooking time can be adjusted from 0s and 60s.
Cooking starts if the cooking time is > 0s and the door is closed.
If the door is opened during cooking the microwave generator is switched off. The 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.

The sate machine below shows a possible solution.

To generate for example C code just export your model to XMI and call the code generator as follows:

java -jar codegen.jar -p Modelio -t "Model:Class Model:first_example_step3" -o oven first_example_step3.xml

After checking the model against a set of well-formedness rules (e.g. no double state names) the complete state machine code is generated.

Done!

Look into the generated files: oven.c oven.h oven_ext.h

It is also possible to generate code from activity diagrams. As an example the selftest() function was modeled as activity diagram. It shows the supported node types and has no other function.

More complex examples to generate code from

Model with parallel regions.

Model with a sub-machine in state S2.

Supported state diagram features

Hierarchical states
Regions (CX language backend only)
Sub-machines in a top level state
(Signal-)Events with event name, guard and action
Initial and final pseudo-states
History states
Choices

Find out more about the code generator

How sinelabore supports model based testing of state diagrams
How to interactively simulate your state diagram and generating trace code

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

Modelio HowTo

What options should I use for exporting a XMI file in Modelio 3

Select the following options:

[Modelio]

Generate production quality code from state diagrams created with Eclipse Papyrus™

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

Generate production quality code from state diagrams created with Eclipse Papyrus™

SinelaboreRT generates readable and maintainable code from hierarchical UML state machines created with Eclipse Papyrus™. 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

Supported State Machine Elements

The code-generator supports a subset of the design elements provided by Eclipse Papyrus. The supported elements are:

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

In addition methods defined in the class are added to the generated state machine header. And attributes are added to the state machine instance data.

How to get started ?

Watch this Youtube video to get a QuickStart in generating C-code from Eclipse Papyrus™ state machine diagrams.

Download the code generator and use the Papyrus microwave example in the examples folder. It shows a fully functional example of a microwave simulation 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.

How to

Opaque Behaviour is not shown in the state diagram inside the states

Check in “Preferences → Papyrus → Diagrams → PapyrusUMLStateMachineDiagram Diagram → Transition and behaviour options” that Show number of lines for opaque expressions/behaviour has a value > 0.

How do I create an inner transition in a state

Create a self transition and set the kind property in the transition property dialog to internal.