Differences

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

--- en:iot-open:practical:software:admins [2024/01/27 21:53] – [Admins's Guide] pczekalski
+++ en:iot-open:practical:software:admins [2025/03/11 11:24] (current) – [Admins's Guide] pczekalski
@@ Line 1: / Line 1: @@
 ====== Admins's Guide ======
-<todo @pczekalski>Do an admin's guide</todo>
 The system has two kinds of administrators: the Super Admin, a built-in account, and any number of Laboratory Admins.
 To understand activities and relations, it is essential to recognise system-building components (figure {ref>vrelsoftware2}).
@@ Line 39: / Line 38: @@
   - Compiler service uses a single source file on the input, which is PlatformIO-based. Thus, all source codes constituting a project are single cpp (or other) files + platformio.ini files.
-==== Device configuration ====
+==== Admin: device configuration ====
-The device supports several configuration parameters, many of which may be redundant or unnecessary, to ensure flexibility among different devices.
+Device configuration is the most complex part of the administration process. It requires the correct configuration of the end node proxy service regarding the specification of the target IoT device it manages. It is a compilation service (figure {{ref>vrelsoftware2}}) that executes compilation commands and execution.\\
-Commands to compile and upload firmware (or configuration) are Admin-defined. Besides common configuration parts such as name, location, and description, there are sections for:
+The device configuration supports several configuration parameters, many of which may be redundant or unnecessary, to ensure flexibility among different IoT hardware.
+Commands to compile and upload firmware (or configuration) are Admin-defined. Besides common configuration parts such as name, location, and description, there are obligatory sections for:
   * Device reset (reboot, restart)
-  * Code compilation
+  * Commands copying from the frontend/backend to the compiler service: define commands that transfer files to the compilation space. The defaults are for PlatformIO:
-  * Code Execution (i.e. firmware upload)
+    * copies ''platformio.ini'' to the root of the project,
-<note tip>Aforementioned actions can have more than one command, and each command can be an SSH or CMD (bash) command.</note>
+    * copies ''main.cpp'' to ''src'' subfolder.
+  * Code compilation, including check of the success with standardised return signalling to the system:
+    * remember to remove previous compilation results before subsequent compilation so that if compilation fails, the existing compiled code won't be mistaken for the new one.
+  * Verification of the successful compilation - enables Upload button - the command should check if compilation was successful and return 1 otherwise 0.
+  * Code execution (i.e. firmware upload)
+<note tip> The Aforementioned actions can have more than one command, and each command can be an SSH or CMD (bash) command.</note>
+<note tip>There are wildcards that represent some critical information, e.g. source file name, target location, etc. Those can be used in commands and passed as parameters to the external scripts that can be executed (CMDs).</note>

en/iot-open/practical/software/admins.1706392395.txt.gz · Last modified: 2024/01/27 21:53 by pczekalski