Wiki source code of Arduino and SCCharts

Last modified by Alexander Schulz-Rosengarten on 2023/09/11 16:17
Show last authors
1 = Program Arduino with SCCharts =
2
3
4
5 {{toc minLevel="2"/}}
6
7 ----
8
9 == Overview ==
10
11 Arduino is a project and community wich creates open-source software and open-source hardware. The Arduino boards and software are well suited for novices and expierenced programmers alike to create digital devices. In the following we will see how to develop applications for the Arduino boards using SCCharts together with the [[Arduino Eclipse Plugin>>url:http://eclipse.baeyens.it/||shape="rect"]]. Therefore we will first download and setup the development environment and afterwards create and upload a small example project.
12
13 If you want to learn the SCCharts langugage first, you can follow these links:
14
15 * [[Introduction to SCCharts>>doc:KIELER.SCCharts (DeprecatedHistorical Documentation & Features).SCCharts (pre 1\.0).WebHome]]
16 * [[The Textual SCCharts Language SCT>>doc:KIELER.SCCharts (DeprecatedHistorical Documentation & Features).SCCharts (pre 1\.0).Textual SCCharts Language SCT.WebHome]]
17 * [[SCCharts Examples>>doc:KIELER.TO DELETE.Examples.WebHome]]
18
19 ----
20
21 == Download and Configure KIELER ==
22
23 == ==
24
25 Download and unpack the nightly build of KIELER for your OS. It is available at the [[doc:KIELER.Overview.Downloads.WebHome]] page.\\
26
27 **Note:** Java 1.8 is needed on all operating systems. With Java 1.7 not all plugins of KIELER will be loaded.
28
29 === The Arduino Eclipse Plugin ===
30
31 There is an Eclipse plugin for Arduino, which makes it easy to create and deploy projects and to use the IDE features of the C/C++ Development Tools (CDT) when programming Arduino.
32
33 You have to install the plugin manually via **Help > Install new Software... **. Use the following update site: [[http:~~/~~/eclipse.baeyens.it/update/V4/nightly>>url:http://eclipse.baeyens.it/update/V4/nightly||shape="rect"]]
34
35 The installation might take a few minutes because it will install the Arduino Tools as well as required software such as the CDT. Furthermore it will download the newest version of the Arduino software and libraries.
36
37 ----
38
39 == Creating an Example Project ==
40
41 The following shows how to create a project, which will turn an LED on and off repeatedly.
42
43 === Create a new project: ===
44
45 1. Choose //File > New > Project > KIELER SCCharts > SCCharts Project//
46 1. In the project creation wizard that opens, select //Arduino// as environment and hit //finish//
47 1. The project wizard from the Arduino Eclipse Plugin opens. Set the project name to //Blinky// and click //next//.
48 1. Set the configuration for your Arduino board. In the field //Upload Protocol// select //Default//.
49 These settings can be changed later in the project preferences (Right click on project > Preferences > Arduino)
50 1. Click //finish//.
51 1. The project is created and the model file is opened in an editor (This might take a few seconds).
52
53 === Edit the model: ===
54
55 Change the contents of the model file to the following code and save it.
56
57 {{code language="sct" theme="Eclipse" title="Floodlight.sct"}}
58 scchart BlinkyModel {
59
60 @Wrapper Clock, 500
61 input bool clock;
62
63 @Wrapper DigitalWrite, 13
64 output bool light;
65
66 initial state lightOff
67 --> lightOn with clock / light = true;
68
69 state lightOn
70 --> lightOff with clock / light = false;
71 }
72 {{/code}}
73
74 This model will start in the state lightOff. If the variable //clock// is true, it will switch its state, going from off to on and from on to off. Thereby it sets the light variable so that the led will blink.
75
76 The annotations on the input and output variable are used to define which wrapper code is used to set / read them. **@Wrapper Clock, "500"** will set the input variable to true for one tick every 500ms. **@Wrapper DigitalWrite, "13"** will set pin 13 to HIGH if the variable is true and to LOW if it is false. We assume that an **LED is connected** to the Arduino board on **pin 13**.
77
78 The available wrapper code snippets are defined in the //assets// directory of the project in ftl files (FreeMarker template files). In the default configuration of a new SCCharts project for Arduino, the file //main.ftl// is processed to create the entry point of the program. Thus it includes other templates containing the available code snippets. The table below gives an overview of the available wrapper code snippets.
79
80 **Note: **To view ftl files with highlighting, you may want to install the //FreeMarker IDE// feature from the JBoss Tools. However, this is not necessary to work with KIELER. JBoss Tools is available in the Eclipse Market Place and via update site. The update site for stable releases is [[http:~~/~~/download.jboss.org/jbosstools/neon/stable/updates/ >>url:http://download.jboss.org/jbosstools/neon/stable/updates/||rel="nofollow" shape="rect" class="external-link"]]. Note that only the //FreeMarker IDE// feature is required (Abridged JBoss Tools > FreeMarker IDE).**
81 **
82
83 === Build the project: ===
84
85 After the modeling is done, the project can be built. Select //Project > Build Project//. This will create a new folder //kieler-gen// with the compiled model file. Further the wrapper code for the model is processed. After the build finished sucessfully, the ino file for the project has been updated with the new wrapper code for the model, and thus the project can be deployed to the Arduino board. The Eclipse Arduino Plugin provides an upload button for this task in the toolbar.
86
87 ==== Excluding the simulation folder from the CDT build ====
88
89 A simulation of models is created as part of a build inside //kieler-gen/sim/bin//. The files inside the //sim// folder are compiled separately and should not be compiled using the CDT. Otherwise errors will occur, for example because every simulation has its own main function and the CDT expects only one for the project.
90
91 Thus the folder //kieler-gen/sim// has to be excluded from the CDT build. Therefore select the folder and do Right Click > Resource Configurations > Exclude From Build.
92
93 === Simulating the model ===
94
95 To use the simulation inside the folder //kieler-gen/sim/bin//, first change to the Simulation Perspective, which provides new buttons in the toolbar. The executables in the //bin// folder can then be launched via //Right Click > KIELER Simulation//. The output of a running simulation can be seen in the Data Pool View.
96
97 === Available Wrapper Code Snippets ===
98
99 There are several wrapper code snippets that can be used as annotations on input and output variables in the model file. These snippets are inserted in the main file template as part of the project launch. The available snippets are listed below.
100
101 (% class="wrapped" %)
102 |=(((
103 Snippet Name and Parameters
104 )))|=(((
105 Description
106 )))|=(((
107 Use on
108 )))|=(% colspan="1" %)(% colspan="1" %)
109 (((
110 Variable type
111 )))|=(((
112 Remark
113 )))|=(% colspan="1" %)(% colspan="1" %)
114 (((
115 Defined in File
116 )))
117 |(% colspan="1" %)(% colspan="1" %)
118 (((
119 **Clock,** milliseconds
120 )))|(% colspan="1" %)(% colspan="1" %)
121 (((
122 Sets a variable to true if the time in milliseconds passed.
123 )))|(% colspan="1" %)(% colspan="1" %)
124 (((
125 input
126 )))|(% colspan="1" %)(% colspan="1" %)
127 (((
128 bool
129 )))|(% colspan="1" %)(% colspan="1" %)
130 (((
131 See also ResetClock.
132 )))|(% colspan="1" %)(% colspan="1" %)
133 (((
134 timing.ftl
135 )))
136 |(% colspan="1" %)(% colspan="1" %)
137 (((
138 **ResetClock,** clockVariableName, autoFalse
139 )))|(% colspan="1" %)(% colspan="1" %)
140 (((
141 Resets a clock, such that the full time intervall of the clock has to elapse, before the clock will be set to true again.
142
143 If autoFalse is true, the reset variable will be set to false automatically.
144 )))|(% colspan="1" %)(% colspan="1" %)
145 (((
146 output
147 )))|(% colspan="1" %)(% colspan="1" %)
148 (((
149 bool
150 )))|(% colspan="1" %)(% colspan="1" %)
151 (((
152 autoFalse is true per default.
153 )))|(% colspan="1" %)(% colspan="1" %)
154 (((
155 timing.ftl
156 )))
157 |(% colspan="1" %)(% colspan="1" %)
158 (((
159 **Time**
160 )))|(% colspan="1" %)(% colspan="1" %)
161 (((
162 Reads the elapsed time since program start in milliseconds.
163 )))|(% colspan="1" %)(% colspan="1" %)
164 (((
165 input
166 )))|(% colspan="1" %)(% colspan="1" %)
167 (((
168 unsigned
169 )))|(% colspan="1" %)(% colspan="1" %)
170 (((
171 \\
172 )))|(% colspan="1" %)(% colspan="1" %)
173 (((
174 timing.ftl
175 )))
176 |(% colspan="1" %)(% colspan="1" %)
177 (((
178 **TickDuration,** targetInMilliseconds
179 )))|(% colspan="1" %)(% colspan="1" %)
180 (((
181 Delays the execution until the tick loop takes at least as long as the given target duration.
182
183 The input variable is set to the actual tick loop duration.
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 input
187 )))|(% colspan="1" %)(% colspan="1" %)
188 (((
189 unsigned
190 )))|(% colspan="1" %)(% colspan="1" %)
191 (((
192 Should be used on the very first input variable in the model, so that waiting is the last action in the tick loop.
193 )))|(% colspan="1" %)(% colspan="1" %)
194 (((
195 timing.ftl
196 )))
197 |(% colspan="1" %)(% colspan="1" %)
198 (((
199 **Delay
200 **
201 )))|(% colspan="1" %)(% colspan="1" %)
202 (((
203 Lets the program delay the time in milliseconds of the variable value.
204 )))|(% colspan="1" %)(% colspan="1" %)
205 (((
206 output
207 )))|(% colspan="1" %)(% colspan="1" %)
208 (((
209 unsigned
210 )))|(% colspan="1" %)(% colspan="1" %)
211 (((
212 \\
213 )))|(% colspan="1" %)(% colspan="1" %)
214 (((
215 timing.ftl
216 )))
217 |(% colspan="1" %)(% colspan="1" %)
218 (((
219 **SerialRate,** baud**
220 **
221 )))|(% colspan="1" %)(% colspan="1" %)
222 (((
223 Sets the baud rate for communication. This is done only in the initilization, not in the loop.
224 )))|(% colspan="1" %)(% colspan="1" %)
225 (((
226 output
227 )))|(% colspan="1" %)(% colspan="1" %)
228 (((
229 unsigned
230 )))|(% colspan="1" %)(% colspan="1" %)
231 (((
232 \\
233 )))|(% colspan="1" %)(% colspan="1" %)
234 (((
235 print.ftl
236 )))
237 |(% colspan="1" %)(% colspan="1" %)
238 (((
239 **Print**
240 )))|(% colspan="1" %)(% colspan="1" %)
241 (((
242 Prints a string variable if the string is not 0.
243 )))|(% colspan="1" %)(% colspan="1" %)
244 (((
245 output
246 )))|(% colspan="1" %)(% colspan="1" %)
247 (((
248 string
249 )))|(% colspan="1" %)(% colspan="1" %)
250 (((
251 \\
252 )))|(% colspan="1" %)(% colspan="1" %)
253 (((
254 print.ftl
255 )))
256 |(((
257 **DigitalWrite,** pin
258 )))|(((
259 Sets the pin value to HIGH if the variable is true and to LOW otherwise.
260 )))|(((
261 output
262 )))|(((
263 bool
264 )))|(((
265 \\
266 )))|(((
267 read_and_write.ftl
268 )))
269 |(((
270 **DigitalRead,** pin
271 )))|(((
272 Sets the variable value to the pin state (HIGH or LOW).
273 )))|(((
274 input
275 )))|(((
276 bool
277 )))|(((
278 \\
279 )))|(((
280 read_and_write.ftl
281 )))
282 |(((
283 **Analog**Write, pin
284 )))|(((
285 Sets the voltage of the given analog IO pin via pulse-width modulation (PWM). Integers from 0 to 1023 are linearly mapped to an pseudo voltage from 0V to 5V.
286 )))|(((
287 output
288 )))|(((
289 int
290 )))|(((
291 \\
292 )))|(((
293 read_and_write.ftl
294 )))
295 |(% colspan="1" %)(% colspan="1" %)
296 (((
297 **AnalogRead,** pin
298 )))|(% colspan="1" %)(% colspan="1" %)
299 (((
300 Reads the value of the given analog IO pin. Voltage from 0V to 5V is linearly mapped to an integer value from 0 to 1023.
301 )))|(% colspan="1" %)(% colspan="1" %)
302 (((
303 input
304 )))|(% colspan="1" %)(% colspan="1" %)
305 (((
306 int
307 )))|(% colspan="1" %)(% colspan="1" %)
308 (((
309 \\
310 )))|(% colspan="1" %)(% colspan="1" %)
311 (((
312 read_and_write.ftl
313 )))
314
315 ----
316
317 == Using the Serial Monitor ==
318
319 The Arduino Eclipse Plugin has a Serial Monitor (Window > Show View > Other > Arduino > Serial monitor view). Here you can open connections to serial ports and read and write to them.
320
321 To open a connection, click the plus button and select the serial port you want to conenct to as well as the serial rate that is used to transmit data. Click //OK.//
322
323 The output of all open connections will be combined in the text editor.
324
325 [[image:attach:Screenshot_20160509_125654.png]]
326
327 ----
328
329 == Problem Solving ==
330
331 The following presents typical issues and how to solve them.
332
333 (% class="wrapped" %)
334 |=(((
335 Issue
336 )))|=(((
337 Typical Error Messages
338 )))|=(((
339 Description
340 )))|=(((
341 Solution
342 )))
343 |(((
344 The upload protocol is not set
345 )))|(((
346 avrdude: Error: Could not find USBtiny device (0x1781/0xc9f)
347 )))|(((
348 You launch a project and there is no different behaviour on your Arduino device, although there are changes in code.
349
350 You try to launch the project and compilation finishes successful. However The upload fails because the upload protocol is not correctly configured.
351 )))|(((
352 Go to the project properties and select //Default// in the field //Upload Protocol// (Right click on project > Properties > Arduino > Arduino Board Selection)
353 )))
354 |(% colspan="1" %)(% colspan="1" %)
355 (((
356 The sim folder is not excluded from the CDT build
357 )))|(% colspan="1" %)(% colspan="1" %)
358 (((
359 Problem markers on files inside the folder //kieler-gen/sim//
360 )))|(% colspan="1" %)(% colspan="1" %)
361 (((
362 The CDT tries to compile the simulation of models as part of a build, which causes problems.
363 )))|(% colspan="1" %)(% colspan="1" %)
364 (((
365 Select the sim folder and do Right Click > Resource Configurations > Exclude From Build
366 )))