| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| en:iot-open:practical:software:users [2025/08/31 16:26] – [Booking a device] pczekalski | en:iot-open:practical:software:users [2026/05/01 10:16] (current) – [User's Guide] pczekalski |
|---|
| ====== User's Guide ====== | ====== User's Guide ====== |
| Students book a device (or multiple devices) exclusively. Each device has specific hardware and programming features, which are provided in the documentation.\\ | Students book a device (or multiple devices) exclusively. Each device has specific hardware and programming features, which are provided in the documentation.\\ |
| There is usually a limited time for device booking, e.g. 2 hours per booking. | There is usually a time limit for device bookings, e.g., 2 hours per booking. |
| Students author the code in the web-based editor; depending on the platform, this may also require authoring some configuration files (e.g., ''platformio.ini'', ''makefile'', etc.).\\ | Students author the code in the web-based editor; depending on the platform, this may also require authoring some configuration files (e.g., ''platformio.ini'', ''makefile'', etc.). Refer to the technical specification for the particular laboratory nodes - it is highly contextual.\\ |
| Once the code is ready, it can be compiled, and if the compilation is successful, it can be uploaded to the device.\\ | Once the code is ready, it can be compiled, and if the compilation is successful, it can be uploaded to the device.\\ |
| Results can be observed via the web camera, presenting device close to real time.\\ | Results can be observed via the web camera in near real time. Some nodes will also provide other interaction capabilities, usually via a bottom-right part of the screen, where documentation is integrated.\\ |
| |
| Several instances of this software are implemented across consortium partners (details are on [[https://iot-open.eu|IOT-OPEN.EU and IOT-OPEN.EU Reloaded Main Page]], but perhaps the one you may want to start from is an instance implemented in SUT, shared with TalTech, itSilesia and ITT Group: [[https://iot.aei.polsl.pl|SUT's VREL NextGen]]. | Several instances of this software are implemented across consortium partners (details are on [[https://iot-open.eu|IOT-OPEN.EU and IOT-OPEN.EU Reloaded Main Page]], but perhaps the one you may want to start from is an instance implemented in SUT, shared with TalTech, ITsilesia, and ITT Group: [[https://iot.aei.polsl.pl|SUT's VREL NextGen]]. |
| |
| ===== How to Start ===== | ===== How to Start ===== |
| - Log in to the system. | - Log in to the system. |
| - Click Bookings button, figure {{ref>yb3}}. | - Click Bookings button, figure {{ref>yb3}}. |
| - Select the device from the list. Note that you may have access to multiple laboratories, devices, and technologies, and each device represents specific features, so check carefully with documentation and scenarios you will implement and what hardware components you need for your lab work. In case of doubt, contact the supervisor. A sample list with ESP32 laboratory devices and STM32 laboratory devices is present in the figure {{ref>yb4}}. | - Select the device from the list. Note that you may have access to multiple laboratories, devices, and technologies. Each device represents specific features, so check carefully with the documentation and scenarios you will implement to determine the necessary hardware components for your lab work. In case of doubt, contact the supervisor. A sample list with ESP32 laboratory devices is present in the figure {{ref>yb4}}. |
| - Select the date and time; you can move among dates and book a device in advance! Respect other students, and do not overbook more than needed or instructed {{ref>yb5}}. | - Select the date and time; you can move among dates and book a device in advance! Respect other students and refrain from overbooking more than necessary or as instructed. {{ref>yb5}} |
| - Once booked, switch back to "My Devices" and select a device (figure {{ref>yb6}}) - you can work only during the booked period, and you will be logged off automatically! | - Once booked, switch back to "My Devices" and select a device (figure {{ref>yb6}}) - you can work only during the booked period, and you will be logged off automatically! |
| <todo @pczekalski>Add screens of booking</todo> | <figure yb3> |
| | {{ :en:iot-open:practical:software:screenshot_from_2025-08-31_15-52-28.png?600 |Device booking process step 1 - go to the list of available devices}} |
| | <caption>Devices menu - empty booking list</caption> |
| | </figure> |
| | <figure yb4> |
| | {{ :en:iot-open:practical:software:screenshot_from_2025-08-31_15-52-40.png?600 |Device booking process step 2 - choose a device to book}} |
| | <caption>Available devices</caption> |
| | </figure> |
| | <figure yb5> |
| | {{ :en:iot-open:practical:software:screenshot_from_2025-08-31_15-53-07.png?600 |Device booking process step 3 - choose booking time}} |
| | <caption>Book the device for a specific period</caption> |
| | </figure> |
| | <figure yb6> |
| | {{ :en:iot-open:practical:software:screenshot_from_2025-08-31_15-53-51.png?600 |}} |
| | <caption>List of bookings</caption> |
| | </figure> |
| |
| | <note>When the code editing icon is greyed out (<>) as in the figure {{ref>yb6}}, it means that your booking time has passed or it is in advance.</note> |
| |
| |
