itemiscreate / examples

YAKINDU Statechart Tools examples

Welcome to the YAKINDU Statechart Tools Examples Repository!

This repository is hosting examples for YAKINDU Statechart Tools.

With YAKINDU Statechart Tools, you can easily create complex systems in a visual way. Simulate and test your system’s behavior already while you are modeling. Code generators translate your state machine into high-quality source code for different target platforms.

You can browse all examples on our website.

Using the Example Wizard, which is available in YAKINDU Statechart Tools since release 2.7, clones this repository to your local disk and so that you can explore the examples easily.

If you think you have a good example as well, feel free to submit is by creating a pull request! Your contributions are very much appreciated!

More information is available in the Examples Repository Wiki.

examples's Issues

Rework description for traffic light with SCTUnit

• Put more emphasize on SCTUnit: add test case in description, show coverage view, describe how to generate junit tests and how to run them
• Remove requirement for mockito (the library is checked in)
• Remove build problem issue description (I had no error marker after import)

Add mandatory attribute "description" to metadata

Remove .zip-file from example ArduinoFSM

As soon as itemisCREATE/statecharts#744 is done, update the instructable to instruct users to checkout the project ArduinoFSM via the example wizard, and remove the zip file.

Add branch for v4 examples

Document last stage of the light switch example

Mirror example repository on the website

The examples in the example repository should be mirrored on the YAKINDU Statechart Tools website so that users can browse and download them without having to run the IDE and the example wizard.

CSS for header numbers in examples seems to be broken

Or maybe it counts in binary? ;)

Add main for C++ Coffee Machine

Light switch example series: images should include definition section

The example refers to e.g. variables and interfaces in the definition section. The latter should therefore be included in the images.

Document examples

Document example wizard

Document metadata.json in the wiki

• What data is needed?
• Is additional data allowed (also if it's of course not used - yet)
• What happens if data is missing?

Update examples after renaming setTimer

update examples https://github.com/Yakindu/sct/issues/134

Name "traffic light" example consistently

At some places the "traffic light" example is named "traffic light", at other places "traffic light waiting". It should be named "traffic light" consistently everywhere, i.e. names of models, files, classes, whatsoever – and of course in the documentation.

Open links in system browser

For some links in the description HTMLs we have problems opening them in the Example Wizard. This is especially the case for our own blog post. Nevertheless, we should open all links in an external browser as one usually wants to read additional information, or install software etc. which is better in a system browser than using the wizard.

Directory "arduino" should have a more specific name

The directory name "arduino" is too general.

.jason file should not be added to project

By using the example wizard, the .jason file will be added to the project, which is not needed.

Clean up current examples

• Uniform naming convention
• Images into images folder
• Metadata
• etc.

Inconsistent styling for PRO examples

Only coffee machine and sensor examples have a red PRO badge in the html description.

This should be consistent, either all or none should have this badge.

Digital watch: Change set_time to time_set to avoid conflicts with the getter and setter functions

see itemisCREATE/statecharts#1595

Additional metadata for examples

Examples should define additional optional metadata, like author, organization, version, license etc.

Incorrect project name in .project of coffee_machine_pro example

Should be "coffee_machine_pro" instead of "coffee_machine"

Add a comprehensive SCTUnit example

The getting started section should include a SCTUnit example, as they do for the code generators.

Code Generation examples

All pictures of the sgen file are different.

Replace with html code.

Add @SuperStep example for GettingStarted

Update example appearance

coffee_machine_pro segfaults

System: Ubuntu 64 Bit, gcc 5.4.0

!!!Hello Coffee!!!
general commands are:
(o) toggle on/off
(t) toggle state trace
(q) quit
-> [On]
o
[On] ->
-> [On.Welcome]
** Welcome to YAKINDU Coffee Maker **
-> [On.HeatingUp]
[On.HeatingUp] ->
* heating-> [On.WaitForChoice]
...............[On.WaitForChoice] ->

* choose:
(1) coffee
(2) espresso
(3) cappucino
(4) latte macchiato
(5) milk
-> [On.SaveEnergy]
2
[On.SaveEnergy] ->
Preparing espresso-> [On.ProcessRecipe.MakeMilk]
-> [On.ProcessRecipe.MakeCoffee.MillingBeans]
-> [On.ProcessRecipe.MakeCoffee.BrewCoffee]
....................[On.ProcessRecipe.MakeCoffee.BrewCoffee] ->
Speicherzugriffsfehler (Speicherabzug geschrieben)

[SCXML_Example] genmodel does not know statechart

example descriptions in SCT: no link hovering; no obvious way to access previous webpage after clicking on url

Some of the example descriptions contain external links, similar to Click *here* for additional information

• no link hovering is available there. That means, the user cannot figure out if that link contains potential interesting information without actually visiting the url.
• after clicking on such an url, its not obvious for some users, that you can go to the original page by pressing backspace.

Therefore, it might make sense to open such an url by default in the default webbrowser of the system. When we cannot do that, we should remove those external links and just write the URL out.

Change all mentions of "Traffic Light Waiting" to "Traffic Light"

Fix styling

improve trafficlight cpp example

https://github.com/Yakindu/examples/tree/master/org.yakindu.sct.examples.trafficlight.cpp

• make path consistent with project name
• index.html should contain explanations for QT.
• metadata.json should also contain notes about QT.
• improve index.html what the purpose of this example is
  • cpp code + c code generator

Document how to create and submit your own example

Add global CSS file for all example pages

The example wizard needs a global location for storing all css files

Cleanup 'examples/traffic_light_arduino'

as e.g. .elf is a binary format it isn't compareable well and mostly marked as changed when using git/eGit. in some circumstances it isn't possible to switch/rebase branches,

Further the whole folder 'traffic_light_arduino\Release' is a majorly platform dependant result and therefore should not be present in the repository.

missing language mapping in msp430 blinky pro example

needed, if blinky example is used in SCT and not CCS

Establish header and footer for index.html files

Consolidate examples by Tom Mens

Prof. Tom Mens from University of Mons, Belgium allowed us to add his examples to our example repository.

We need to check which examples make sense for us to add. We could add a project with his examples sorted by the youtube videos he uploaded.

Document how to manually download and use the examples repository

Problems during Installation in CCS6

see: https://groups.google.com/forum/#!topic/yakindu-user/02Gqb9sRYqM

Improve description texts

Following aspects can be checked:

• update screenshots to have pinned def section, syntax highlighting and proper resolution
• add short abstract to highlight what this example is demonstrating (similar to the getting started examples)
• check if we can improve some styling issues (make things look nicer)

Create/enhance a test plan

Feature request: Open index.html in browser on example checkout

It would be nice to have the description of an example available after checking it out. I do not think all users know that they need to open index.html. I guess they rather open the example wizard again to read the description; but this wizard is modal, so user experience is not that good.

It would be nice if after checkout of an example the system browser opens with the index.html, so you can have example and its description side by side.

Add description of mandatory attribute "description" to documentation

Move legacy examples here

The YAKINDU Statechart Tools documentation references some legacy examples that are no longer available in the referenced repositories, and even not all of those repositories do exist anymore.

These old examples have to be located and placed into the examples repository, so the documentation can properly reference them.

Refactor examples

TODO:

• use css style sheet (ycar example) for every project
• overall pinned as default
• implement SCTUnit for some examples
• create examples according to user docu
• use the same folder hierarchy -> src, srg-gen, test-gen, model
• delete all warnings out of the projects
• move swift example to labs

Possibly wrong description on Orthogonality example

The second screenshot in the Orthogonality example is possibly unreachable. Either the functionality needs to be changed or the image and text.

Add version information to examples

So that we can push the examples to features of newer versions without disturbing older versions.

Check multi sm examples for out event observable handling

[YCar-App] enhance documentation

Provide link and howto add Typescript-Generator.