67 guidance needed using module essentials on mac (#71)

* feat: add module essentials page

* docs: add getting started

* docs: add some pics for module essentials

* docs: fix versioning terminology and improve architecture section

* docs: fix typo in module architecture description

* fix: solve conflicts

---------

Co-authored-by: Daniel Schmitt <dsschmitt@siemens.com>
Co-authored-by: dssAutomation <148949458+dssAutomation@users.noreply.github.com>

Author: HamzaAdlane-Siemens

Doxyfile

@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = MAC_use_cases/Model ./docs/mainpage.md
+INPUT                  = MAC_use_cases/Model ./docs/mainpage.md ./docs/moduleEssentialsPage.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

MAC_use_cases/Images/Architecture.png

@@ -13,7 +13,7 @@
     <AssemblyName>MAC_use_cases</AssemblyName>
     <TargetFrameworkVersion>v4.8</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
-    <langVersion>8.0</langVersion>
+    <langVersion>latest</langVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
     <DebugSymbols>true</DebugSymbols>
@@ -89,6 +89,12 @@ where to where -->
   in MPFProj12\ProjectNode.cs, ProcessFiles.
   -->
   <ItemGroup>
+    <Compile Include="Model\ModuleEssentials\Base\BaseModelParameterOwner.cs" />
+    <Compile Include="Model\ModuleEssentials\Base\BaseParameter.cs" />
+    <Compile Include="Model\ModuleEssentials\Base\BaseParameterWithPredefinedTags.cs" />
+    <Compile Include="Model\ModuleEssentials\Example\Parameter\Parameter_IsVirtualAxis.cs" />
+    <Compile Include="Model\ModuleEssentials\Example\TechnologyObjectDataModel.cs" />
+    <Compile Include="Model\ModuleEssentials\Example\TechnologyObjectViewModel.cs" />
     <Compile Include="Model\UseCases\HardwareGenerationExcelBased.cs" />
     <Compile Include="TiaImports\CustomLibraryClasses\Lib_Screen_1.cs" />
     <Compile Include="TiaImports\CustomLibraryClasses\Lib_MAC_use_cases_custom.cs" />
@@ -188,6 +194,9 @@ where to where -->
       <Version>20.1.6</Version>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="Siemens.ModularApplicationCreator.ControlModules.ModuleEssentials">
+      <Version>19.0.3</Version>
+    </PackageReference>
     <PackageReference Include="Siemens.ModularApplicationCreator.Core">
       <Version>20.1.6</Version>
       <PrivateAssets>all</PrivateAssets>

MAC_use_cases/Images/ModuleEssentials.png

@@ -12,6 +12,7 @@
     <dependencies>
       <group targetFramework=".NETFramework4.8">
         <dependency id="Newtonsoft.Json" version="13.0.3" />
+        <dependency id="Siemens.ModularApplicationCreator.ControlModules.ModuleEssentials" version="19.0.3" />
       </group>
     </dependencies>
     <tags>MODULARAPPLICATIONCREATOR EQUIPMENTMODULE TIA-V19.0 FAILSAFE_CPU_REQUIRED</tags>
@@ -42,6 +43,7 @@
     <contentFiles>
       <files include="any/net48/AdditionalContent/HardwareGenerationExcelBased.xlsx" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/AddLibrary.png" buildAction="Content" copyToOutput="false" />
+      <files include="any/net48/Images/Architecture.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/ClassExplanation.PNG" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/CodeExplanation.PNG" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/ConfigureTO.png" buildAction="Content" copyToOutput="false" />
@@ -68,6 +70,8 @@
       <files include="any/net48/Images/GetSafetySoftwareUnit.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/LocalizationXamlResourceDictionary.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/LogMessage.png" buildAction="Content" copyToOutput="false" />
+      <files include="any/net48/Images/ModuleEssentials.png" buildAction="Content" copyToOutput="false" />
+      <files include="any/net48/Images/ModuleEssentialsControlBinding.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/MultiInstanceFB.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/OpenLibrary.png" buildAction="Content" copyToOutput="false" />
       <files include="any/net48/Images/OpenTiares.png" buildAction="Content" copyToOutput="false" />

MAC_use_cases/Images/ModuleEssentialsControlBinding.png

@@ -1,3 +1,4 @@
+using MAC_use_cases.Model.ModuleEssentials.Example;
 using System.Collections.ObjectModel;
 using MAC_use_cases.Model.UseCases;
 using MAC_use_cases.ViewModel;
@@ -41,6 +42,7 @@ public MAC_use_casesEM()
             InitAfterFirstCreationOrDeserialization();
 
             MyTo = new TechnologyObjectClass(this);
+            MyEssentialTechnologyObjectViewModel = new TechnologyObjectViewModel(new TechnologyObjectDataModel(this));
         }
 
         // <auto-generated>
@@ -55,6 +57,7 @@ public MAC_use_casesEM(JsonConstructorMarker nullObj)
             InitAfterFirstCreationOrDeserialization();
 
             MyTo = new TechnologyObjectClass(this);
+            MyEssentialTechnologyObjectViewModel = new TechnologyObjectViewModel(new TechnologyObjectDataModel(this));
         }
 
         //-------------------------------------------
@@ -76,6 +79,12 @@ public ModuleEdge ModuleStart
         /// </summary>
         public TechnologyObjectClass MyTo { get; set; }
 
+        /// <summary>
+        /// Gets or sets the essential data model for the technology object (Example of using Module Essentials).
+        /// </summary>
+        [JsonIgnore]
+        public TechnologyObjectViewModel MyEssentialTechnologyObjectViewModel { get; set; }
+
         public bool IsGenerateHardwareChecked { get; set; } = false;
 
         public bool IsGenerateSafetyBlockChecked { get; set; } = false;
@@ -125,8 +134,8 @@ public override bool GenerateTiaPortal(TiaTemplateContext tiaTemplateContext, st
                     _plcDevice = GetPlcDevice(tiaTemplateContext);
                     break;
 
-                // Add equipment module specific code for each generation phase here, which is
-                // necessary before the ResourceManagement is called.
+                    // Add equipment module specific code for each generation phase here, which is
+                    // necessary before the ResourceManagement is called.
             }
 
             ResourceManagement.Generate(tiaTemplateContext, this, generationPhaseName);
@@ -246,6 +255,9 @@ public override bool GenerateTiaPortal(TiaTemplateContext tiaTemplateContext, st
                     CreateVariables.CreateTagInTagTable(myTagTable, "%I", "187", "0", "myTag_0", "Bool", "myTagComment");
                     CreateVariables.CreateTagInTagTable(mySoftwareUnitTagTable, "%I", "188", "0", "myTag_1", "Bool",
                         "myTagComment");
+                    this.MyEssentialTechnologyObjectViewModel.Model.AddTechnologicalObjectParams();
+                    this._plcDevice.TechnologicalObjects.GetOrCreateRootTO(MyEssentialTechnologyObjectViewModel.Model
+                        .TechObjectInfo, this);
 
                     if (IsGenerateHardwareChecked)
                     {

MAC_use_cases/MAC_use_cases.csproj

@@ -0,0 +1,33 @@
+using Newtonsoft.Json;
+using Siemens.Automation.ModularApplicationCreator.ControlModules.ModuleEssentials.Objects.EssentialParameterOwner;
+
+namespace MAC_use_cases.Model.ModuleEssentials.Base;
+
+public class BaseModelParameterOwner : EssentialParameterOwner
+{
+    [JsonIgnore] 
+    protected MAC_use_casesEM _module;
+
+    [JsonConstructor]
+    public BaseModelParameterOwner()
+    {
+
+    }
+
+    public BaseModelParameterOwner(MAC_use_casesEM module) : base(string.Empty)
+    {
+        _module = module;
+    }
+
+    protected override void setup()
+    {
+        base.setup();
+        CreateParameters();
+    }
+
+    protected virtual void CreateParameters()
+    {
+
+    }
+    // Add code here for validation, additional logic, or other functionality as needed.
+}

MAC_use_cases/MAC_use_cases.nuspec

@@ -0,0 +1,29 @@
+using Newtonsoft.Json;
+using Siemens.Automation.ModularApplicationCreator.ControlModules.ModuleEssentials.Enums;
+using Siemens.Automation.ModularApplicationCreator.ControlModules.ModuleEssentials.Objects.EssentialParameter;
+
+namespace MAC_use_cases.Model.ModuleEssentials.Base;
+
+public class BaseParameter : EssentialParameter
+{
+    [JsonConstructor]
+    public BaseParameter()
+    {
+
+    }
+    
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BaseParameter"/> class with the specified type, default value, and
+    /// position unit.
+    /// </summary>
+    /// <param name="type">The type of the parameter, which determines its essential characteristics.</param>
+    /// <param name="defaultValue">The default value assigned to the parameter. This value is used if no other value is provided.</param>
+    /// <param name="posUnit">The position unit for the parameter in the user interface. Defaults to <see cref="PositionunitForUI.None"/> if
+    /// not specified.</param>
+    public BaseParameter(EssentialParameterType type, string defaultValue, PositionunitForUI posUnit = PositionunitForUI.None) : base(null!, type, defaultValue, posUnit)
+    {
+
+    }
+
+    // Add code here for validation, additional logic, or other functionality as needed.
+}

MAC_use_cases/Model/MAC_use_casesEM.cs

@@ -0,0 +1,22 @@
+using Newtonsoft.Json;
+using Siemens.Automation.ModularApplicationCreator.ControlModules.ModuleEssentials.Objects.EssentialParameter;
+
+namespace MAC_use_cases.Model.ModuleEssentials.Base;
+
+
+public class BaseParameterWithPredefinedTags : EssentialParameterWithPredefinedTags,    IEssentialParameterWithPredefinedTags
+{
+    [JsonConstructor]
+    public BaseParameterWithPredefinedTags()
+    {
+
+    }
+
+    public BaseParameterWithPredefinedTags(string defaultValue) : base(defaultValue)
+    {
+
+    }
+
+    // Add code here for validation, additional logic, or other functionality as needed.
+
+}