Differences

This shows you the differences between two versions of the page.

--- en:iot-open:practical:hardware:sut:labscenariotemplate [2024/02/25 16:12] – created pczekalski
+++ en:iot-open:practical:hardware:sut:labscenariotemplate [2024/03/22 10:45] (current) – [Project information] pczekalski
@@ Line 1: / Line 1: @@
+This is a template for the single hands-on lab scenario description for IoT-OPEN.EU Reloaded, WP5.
+This document provides a scenario template (hands-on lab) and should be linked from the laboratory description document [[en:iot-open.eu:io3:labactivitytemplate]].
+<note important>Use it as a copy-paste. Do not edit this file, please!</note>
+<note important>Italic text below should be replaced with yours. The italic text below lets you easily find out what chapters are to be covered when creating a document - to distinguish it from your regular text.</note>
+<note warning>Paragraphs below (in regular, non-italic) should be left as is, eventually adapted if necessary. The project information section should be left as is.</note>
+Everything above this line (including this line) should be removed in the final version once copied.
+====== [Scenario Short Code]: [Scenario name] =====
+//Give a few words about this scenario. Provide some objectives and impact on the students. Give a short description and objectives.//
+===== Prerequisites =====
+//Provide prerequisite hardware/software/software libraries/skills if other than stated in the Laboratory description. Refer to other laboratory scenarios that users should be aware of, i.e. presenting a network message on the LCD screen should not focus on the method of handling LCD; rather, refer to the scenario (training) on how to handle LCD display. If none, remove it along with the header. Please note some information may be common for all scenarios (i.e. connectivity credentials or MQTT library credentials), so provide it at the laboratory description level, not at the scenario level. It is essential for easy updates.//
+===== Suggested Readings and Knowledge Resources =====
+//Provide links for suggested readings (i.e. book / dokuwiki links) for theoretical resources. Remove this section if not necessary.//
+===== Hands-on Lab Scenario =====
+==== Task to be implemented ====
+//Describe a task to be implemented by the scenario user.//
+==== Start ====
+//Write starting conditions, i.e. what to do in the beginning, what to pay attention to before beginning, how the mechanical part should look, etc.// Include needed compiler configuration, etc.
+==== Steps ====
+// Write some extra information if, i.e. some steps are optional; otherwise, cancel this paragraph (but do not remove the header).//
+=== Step 1 ===
+//Describe activities done in Step 1.//
+...
+=== Step n ===
+//Describe activities done in Step n.//
+==== Result validation ====
+//Provide some result validation methods for self-assessment.//
+===== FAQ =====
+This section is to be extended as new questions appear. \\
+When using the printed version of this manual, please refer to the latest online version of this document to obtain the valid and up-to-date list of the FAQ.
+//Provide some FAQs in the following form:\\
+**Question?**: Answer.
+//
+<WRAP noprint>
+===== Project information =====
+{{:en:iot-open:logo_iot_200_px.png?200|}}\\
+This Intellectual Output was implemented under the Erasmus+ KA2.\\
+Project IOT-OPEN.EU Reloaded – Education-based strengthening of the European universities, companies and labour force in the global IoT market.\\
+Project number: 2022-1-PL01-KA220-HED-000085090.
+**__Erasmus+ Disclaimer__**\\
+This project has been funded with support from the European Commission. \\
+This publication reflects the views of only the author, and the Commission cannot be held responsible for any use that may be made of the information contained therein.
+**__Copyright Notice__**\\
+This content was created by the IOT-OPEN.EU Reloaded consortium, 2022,2024.\\
+The content is Copyrighted and distributed under CC BY-NC [[https://en.wikipedia.org/wiki/Creative_Commons_license|Creative Commons Licence]], free for Non-Commercial use.
+<figure label>
+{{:en:iot-open:ccbync.png?100|}}
+</figure>
+</WRAP>