STARS (State Autocoding for Real time Systems) is an innovative software tool designed to streamline and optimize the development of embedded real-time applications. Leveraging state-of-the-art autocoding technology, Stars transforms state-machine models into efficient, reliable, and maintainable code, suitable for a wide range of applications. Developed with a focus on user-friendliness and versatility, it supports multiple modeling tools and generates code in C or C++ and specifically generates code for two different frameworks - the F` framework and the Quantum Framework, addressing the diverse needs of developers and engineers. By automating the code generation process, Stars not only accelerates development cycles but also significantly reduces the potential for human error, ensuring higher quality and performance in the final product. Whether you are working on small-scale projects or complex embedded systems, Stars is engineered to enhance productivity and foster innovation in your development endeavors.
State machine models may be specified using any of these modeling tools:
1) MagicDraw Cameo Systems Modeler
2) Quantum Modeler
3) PlantUML text
The Autocoder processes the model into any one of the following:
1) C state machine code
2) C++ state machine code
3) F` component state machine code and F` FPP
4) Quantum Framework state machine code
This diagram highlights the input models (front end) and the autocoder products (back end)
This diagram highlights the design and process flow of the QM State Machine Autocoder:
-
Install the Python module:
pip install -r requirements.txt
-
Check that it all works by building and running the test models
make make ut
The Quantum Modeler tool is a free open source application for Windows, Linux or Mac that can be downloaded from: https://www.state-machine.com/#Downloads
The full users guide is here: https://www.state-machine.com/qm/bm_diagram.html
But the quick approach is to to open up an existing model ie Open up models/TestModels/simple/Simple.qm and just rename the model.
Otherwise this is the procedure:
- From the File pull down menu, select 'New Model'
- In the Model Template, select None
- In the Framework, select qpc
- Highlight 'model' in the Model Explorer, right click and Add Package
- Highlight 'package', right click and Add Class
- In the Property Editor, rename 'Class1' with the name of your state machine (ie 'MySm')
- In the Property Editor, in the superclass, select 'qpc::QHsm'
- In the Model Explorer, right click the named state machine (ie 'MySm:QHsm') and Add State Machine
- In the Model Explorer, double click the SM icon
- Expand the drawing canvas
- On right hand side, select the state icon, move to the canvas and click to drop it in.
Here are some examples of QM state machine models that are parsed correctly by this Autocoder:
For using the PlantUML, see the users guide:
Here are some examples of PlantUML state machine models that are parsed correctly by this Autocoder:
Simple.plantuml
Simple_Composite.plantuml
Cases.plantuml
Cameo.plantuml
Actions.plantuml
Complex_Junction.plantuml
Simple_Junction.plantuml
Multiple_Actions.plantuml
Arg_Actions.plantuml
Transitions.plantuml
String_Guards.plantuml
Simple_Junction.plantuml
Diagrams can be generated from PlantUML models:
Example:
For the Blinky model:
@startuml
[*] --> Off: /Bsp_Initialize()
state Off {
Off:Entry: Bsp_LED_TurnOff()
}
state On {
On:Entry: Bsp_LED_TurnOn()
}
Off --> On : TIMEOUT
On --> Off : TIMEOUT
@enduml
Issue the Command:
python -m plantuml Blinky.plantuml
Will generate the following graphic:
MagicDraw is not a free tool. If you have a license then you should also have the documentation.
MagicDraw is a complex tool and there are many ways to specify a state machine that looks correct but
will not be parsed correctly by this Autocoder. Here are some example models that do parse correctly:
- models/TestModels/simple/Simple.xml
- models/TestModels/simple_composite/Simple_Composite.xml
- models/TestModels/cases/Cases.xml
- models/TestModels/Cameo/Cameo.xml
- models/TestModels/actions/Actions.xml
- models/TestModels/complex_junction/Complex_Junction.xml
- models/TestModels/simple_junction/Simple_Junction.xml
- models/TestModels/multiple_actions/Multiple_Actions.xml
- models/TestModels/arg_actions/Arg_Actions.xml
- models/TestModels/transitions/Transitions.xml
- models/TestModels/string_guards/String_Guards.xml
- models/TestModels/simple_junction/Simple_Junction.xml
F` is an open source Component Flight Software framework which can be downloaded from: https://github.com/nasa/fprime
The interface between a state machine that is generated with the F` backend is as follows:
If SignalGen is an F` component and Simple is the state-machine, then the autocoder will
generate an interface class called SimpleIf and a class called Simple. The relationships are
illustrated in this diagram:
This relationship allows the state machine implementation functions to be defined in the implementation component class.
Here is the component header class that shows the interface.
In this example Simple_s1Entry() is a state machine implementation function.
class SignalGen : public SimpleIf {
public:
Simple sm;
SignalGen() : sm(this) {}
void init();
void Simple_s1Entry() override;
};
The Python state-machine Autocoder command syntax:
usage: Stars.py [-h] [-backend {c,qf,c++,fprime}] [-model MODEL] [-noImpl] [-noSignals] [-namespace NAMESPACE] [-debug] [-smbase]
State-machine Autocoder.
switch |
argument |
deescription |
-h, --help |
show this help message and exit |
|
-backend |
c, qf, c++, fprime |
back-end code to generate |
-model |
MODEL |
QM state-machine model file: <model>.qm |
-noImpl |
Don’t generate the Impl files |
|
-noSignals |
Don’t generate the Signals header file |
|
-namespace |
NAMESPACE |
Fprime namespace |
-debug |
prints out the models |
|
-smbase |
Generates the component state-machine base class |
cd autocoder
./Stars.py -backend c++ -noImpl -model ../models/Blinky/Blinky.plantuml
./Stars.py -backend fprime -noImpl -namespace BLINKY -model ../models/Blinky/Blinky.plantuml
./Stars.py -backend fprime -noImpl -namespace BLINKY -model ../models/Blinky/Blinky.xml
./Stars.py -smbase
For other examples see:
The test harness provides the capability to test a state machine model by setting guard states and sending events.
A graphical rendering of the state machine is updated to animate the state machine.
