Wiki source code of Tutorial 02: SCCharts

Version 2.1 by Soeren Domroes on 2019/01/28 13:51
Show last authors
1
2
3 {{toc/}}
4
5 (((
6 = Preliminaries =
7
8 == SCCharts: ==
9
10 (% style="margin-left: 30.0px;" %)
11 These slides are a good starting point to get accustomed with SCCharts:
12
13 *
14 ** Lecture 11, Synchronous Languages WS16: [[https:~~/~~/www.informatik.uni-kiel.de/~~~~rvh/ws16/v-synch/lectures/lecture11-handout4.pdf>>url:https://www.informatik.uni-kiel.de/~~rvh/ws16/v-synch/lectures/lecture11-handout4.pdf||shape="rect"]]
15
16 (% style="margin-left: 30.0px;" %)
17 It might be a good idea to also have a bit of a deeper understanding to what is going on behind the scenes of SCCharts. Therefore you might want to read up on the lower levels of the language:
18
19 *
20 ** Lecture 12, Synchronous Languages WS16: [[https:~~/~~/www.informatik.uni-kiel.de/~~~~rvh/ws16/v-synch/lectures/lecture12-handout4.pdf>>url:https://www.informatik.uni-kiel.de/~~rvh/ws16/v-synch/lectures/lecture12-handout4.pdf||shape="rect"]]
21 ** Lecture 13, Synchronous Languages WS16: [[https:~~/~~/www.informatik.uni-kiel.de/~~~~rvh/ws16/v-synch/lectures/lecture13-handout4.pdf>>url:https://www.informatik.uni-kiel.de/~~rvh/ws16/v-synch/lectures/lecture13-handout4.pdf||shape="rect"]]
22 ** Lecture 14, Synchronous Languages WS16: [[https:~~/~~/www.informatik.uni-kiel.de/~~~~rvh/ws16/v-synch/lectures/lecture14-handout4.pdf>>url:https://www.informatik.uni-kiel.de/~~rvh/ws16/v-synch/lectures/lecture14-handout4.pdf||shape="rect"]]
23
24 (% style="margin-left: 30.0px;" %)
25 Additional information about SCCharts within KIELER can be found here:
26
27 *
28 ** PLDI Artifact submission: [[doc:KIELER.PLDI'14 Artifact on SCCharts]]
29
30 (% style="margin-left: 30.0px;" %)
31 There is also a Technical Report about the last Railway Project and the changes to SCCharts that originated there. You might want to read that too.
32
33 *
34 ** SCCharts: The Railway Project Report: [[Technical Report 1510>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/papers/report-1510.pdf||shape="rect"]]
35
36 == KIELER: ==
37
38 (% style="margin-left: 30.0px;" %)
39 You need a working copy of KIELER. If you participated in the last lecture about Synchronous Languages you probably already have one.
40 If you have a version for LEGO Mindstorms you might have a 32bit version, even if you are working on a 64bit machine. For our project you can use the 64bit version and use the full potential of your machine.
41 So, what I am saying is: You might want to make sure you have the proper version.
42
43 (% style="margin-left: 30.0px;" %)
44 If you need a new installation you should use our [[SCCharts Release Candidate 0.12>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/files/release_sccharts_0.12.0/||shape="rect"]]. There will be a final release soon^^(really!)^^, but for the moment just use this one.
45
46 == Key: ==
47
48 (% style="margin-left: 30.0px;" %)
49 You can get a key for the Railway lab. Sadly, we don't have a key for everybody so you have to distribute the keys in a sensible manner.
50
51 (% style="margin-left: 30.0px;" %)
52 If you think you need a key come by at Room 1112. Make sure you read and understand the "[[Hausordnung>>url:http://www.uni-kiel.de/sy/mitteilungen/hausordnung.pdf||shape="rect"]]".
53
54 = Tasks =
55
56 == T2A1: Important Thoughts ==
57
58 1. What are the difference between Extended SCCharts and Core SCCharts. Make sure you know that.
59 1. What advantages has the Core SCCharts normalization? It has to be something sensible or we wouldn't do it, right? RIGHT?
60 1. Which constraints influence the ordering of a schedule? What combinations can you think of that make a model unschedulable?
61
62 == T2A2: Checking you SCCharts Installation ==
63
64 \\
65
66 (% style="margin-left: 30.0px;" %)
67 === a) Create a model ===
68
69 \\
70
71 (% style="margin-left: 60.0px;" %)
72 Model the following SCChart using the textual SCChart language (*.sct).
73
74 (% style="margin-left: 60.0px;" %)
75 [[image:attach:RPST2.Tutorial 02: SCCharts@tutorial2.png]]
76
77 (% style="margin-left: 60.0px;" %)
78 The SCChart describes a simple railway station controller. Initially the track is powered with 60 units to allow any train standing on this platform to begin its journey. (We assume the train stands beyond contact0 and will not trigger it in the beginning.) Subsequently, the platform of this station slows down any train entering the station (indicated by {{code language="none"}}contact0{{/code}}) and stops it when it passes {{code language="none"}}contact1{{/code}}. After 5 seconds it may proceed its journey.
79
80 (% style="margin-left: 30.0px;" %)
81 === b) Transform that model ===
82
83 (% style="list-style-type: none;background-image: none;" %)
84 \\
85
86 *
87 ** Transform all extended features of the SCChart to core variants. Inspect the generated model and make sure that is still has the same semantics.
88 ** Normalize your SCChart. Make sure it is still valid. If you realize that the semantics changed, run through the streets screaming. Than write a ticket in our [[JIRA>>url:https://rtsys.informatik.uni-kiel.de/jira/secure/MyJiraHome.jspa||shape="rect"]] so we can fix it.\\
89 ** Convert the SCChart into its SCG representation. Inspect the SCG and search for potential problems.
90
91 (% style="margin-left: 30.0px;" %)
92 === c) Simulation ===
93
94 * In order to generate executable code for the station controller, some potential problems need to be fixed. Fix these.
95 * Simulate the fixed model with KIELER. Feel the joy of having accomplished these tedious tasks.
96
97 (% style="margin-left: 30.0px;" %)
98 === d) Code Generation ===
99
100 * Use KIELER to generate some C-Code from the model and save the code somewhere.
101 * Find the generated code on your machine and have a look at it.
102 * Think about whether you like the code or not.
103 * Think about whether you understand the code or not. If not, try to understand it and repeat this point.
104
105 \\
106
107 == T2A3: Let's go to the PROM ==
108
109 (% style="margin-left: 30.0px;" %)
110 === a) What is PROM? ===
111
112 (% style="margin-left: 60.0px;" %)
113 To interact with the harsh and dangerous environment, SCCharts features PROject Management (PROM). To understand what it does, you want to read up on [[PROM>>url:https://rtsys.informatik.uni-kiel.de/confluence/pages/viewpage.action?pageId=13762626||shape="rect"]]. If you are still unsure how it works, ask around in your group. Maybe you will find someone who can explain it in more detail.
114
115 (% style="margin-left: 30.0px;" %)
116 === b) Create a PROM project ===
117
118 * Start by creating a new SCCharts project. As an Environment you can use Generic Java. Mentally store your projectname in $$proj_name$$.Do not switch to the Java Perspective when asked. If you changed to the Java Perspective by accident, change back to the SCCharts modelling perspective.
119 * In your new project create a new folder called "snippets" next to the src folder. Download [[this file>>attach:RPST2.Tutorial 02: SCCharts@print.ftl]] and place it in the new folder.
120 * (((
121 In the src folder create a new file called $$proj_name$$Main.ftl. Place the following code in the new file:
122
123 {{code language="java"}}
124 public class ${file_name} {
125 // Instantiate SCChart
126 public static ${model_name} scchart = new ${model_name}();
127
128 public static void main(String[] args) {
129
130 // Init Annotations
131 ${inits}
132
133 // Init SCChart
134 System.out.println("running...");
135 scchart.reset();
136
137 // Tick loop
138 while(true){
139
140 // Update input annotations
141 ${inputs}
142
143 // Tick
144 scchart.tick();
145
146 // Update output annotations
147 ${outputs}
148
149 }
150 }
151 }
152 {{/code}}
153 )))
154
155 === c) Build a model ===
156
157 *
158 ** Create some logic in the generated SCChart. You can use the Print snippet to write text to the commandline. Feel free to add additional snippets. Just be creative and build some useless stuff.
159
160 (% style="margin-left: 30.0px;" %)
161 === d) Run the SCChart ===
162
163 *
164 ** Try to run the SCChart by clicking //Run as// → //KiCo Compilation//.
165 ** There will propably be some kind of error. These should be fixable by adjusting the Launch Configuration:
166 *** At the //Main// tab set the //Main file// to **src/$$proj_name$$Main.ftl**
167 *** At the //Compilation// tab set the //Input File// to **${main_path}** and the //Snippets directory// to **snippets**
168 *** At the //Execute// tab set the //Associated Launch Shortcut// to **Java Application**
169 ** Try again to run the SCChart. It should hopefully work now.
170
171 == T2A4: Referencing other stuff ==
172
173 (% style="margin-left: 30.0px;" %)
174 When working as a big team it might be sensible to split the models into smaller parts. (Well there are other good reasons too, but never mind)
175
176 (% style="margin-left: 30.0px;" %)
177 Play around a bit with the referencing feature. There is some documentation in the technical report above.
178
179 (% style="margin-left: 30.0px;" %)
180 Just a small outline what you need to do:
181
182 *
183 ** Create an SCChart that you want to reference. Call it SmallChart (Or anything else, but I will use this name throughout this example). The filename is not important here, just the name in the scchart declaration.
184 ** In SmallChart create some input and/or output variables like "input bool foo" or "output bool bar".
185 ** Create a second SCChart in the same project. Call it Large Chart (Or anything else ...)
186 ** In LargeChart create a state and refer to SmallChart.
187 The general syntax to reference an SCChart is
188
189 {{code}}
190 state <name> references <OtherSCChart> bind <VariableInOtherSCChart> to <VariableInThisSCChart>, <VariableInOtherSCChart> to <VariableInThisSCChart>, ...;
191 {{/code}}
192
193 (% style="margin-left: 30.0px;" %)
194 **Beware:** There seems to be a bug regarding the name resolution. If you have multiple SCChart projects open in the workspace, the referencing might break. You can just close all the projects that you don't need at the moment. Then it should be fine.
195
196 == T2A5: Railway and SCCharts (Bonus) ==
197
198 (% style="margin-left: 30.0px;" %)
199 Build a small controller that uses the Railway C-API and controls a train. (Maybe just do the same controller as in Tutorial 1). You propably need to read up on hostcode for that one. In the final controller you should not really use hostcode directly, so this is kind of extra work for the moment.
200
201 \\
202 )))

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage