Merge pull request #59 from siemens/58-add-tia-screenshots-to-the-docu-for-the-sofwareunits-typed-libraries-and-hw-from-excel-examples

docs: Add TIA-Screenshots to the docu for the 'SofwareUnits', 'Typed …

Author: ClaudiusR

MAC_use_cases/AdditionalContent/HardwareGenerationExcelBased.xlsx

@@ -2,7 +2,7 @@
 <package>
   <metadata>
     <id>MAC_use_cases</id>
-    <version>1.0.9238-pre20250417091804</version>
+    <version>1.0.9243-pre20250422072413</version>
     <title>MAC_use_cases</title>
     <authors>SIEMENS AG</authors>
     <projectUrl>http://equipmentmodule.info/</projectUrl>

MAC_use_cases/Images/CreateInstanceDBFromTypedBlock.png

@@ -18,6 +18,7 @@ public class HardwareGenerationExcelBased
 {
     /// <summary>
     ///     Reads device information from a specified Excel file.
+    ///     \image html ExampleExcelFile.png
     /// </summary>
     /// <param name="filePath">The full path to the Excel file containing device information.</param>
     /// <returns>A list of DeviceInfo objects containing the parsed device information.</returns>
@@ -141,6 +142,7 @@ private static string GetCellValueAsString(Excel.Range cell)
 
     /// <summary>
     ///     Creates new devices in the TIA Portal project based on information from an Excel sheet.
+    ///     \image html CreateNewDevicesFromExcelSheet.png
     /// </summary>
     /// <param name="module">The MAC use cases module instance.</param>
     /// <param name="tiaProject">The target TIA Portal project.</param>

MAC_use_cases/Images/CreateNewDevicesFromExcelSheet.png

@@ -1,4 +1,4 @@
-using Siemens.Automation.ModularApplicationCreator.Tia.Helper.Create_XML_Block.XmlBlocks.BlockFrames;
+using Siemens.Automation.ModularApplicationCreator.Tia.Helper.Create_XML_Block.XmlBlocks.BlockFrames;
 using Siemens.Automation.ModularApplicationCreator.Tia.Openness;
 using Siemens.Engineering.Hmi;
 using Siemens.Engineering.Library.MasterCopies;
@@ -24,6 +24,14 @@ public static DataBlock CreateInstanceDataBlock(MAC_use_casesEM module, FBMaster
         return module.ResourceManagement.CreateInstanceDb(masterCopy, instanceName, target.Blocks);
     }
 
+    /// <summary>
+    ///     This function creates an instance DB in the target folder (folder under program blocks)
+    ///     \image html CreateInstanceDBFromTypedBlock.png
+    /// </summary>
+    /// <param name="module">The Module</param>
+    /// <param name="libraryType">A master copy of the typed block you want to create an instance DB of</param>
+    /// <param name="instanceName">Name of the instance</param>
+    /// <param name="target">The folder under program blocks in which the DB is created</param>
     public static DataBlock CreateInstanceDataBlock(MAC_use_casesEM module, FBLibraryType libraryType,
         string instanceName, BlockGroup target)
     {
@@ -32,7 +40,7 @@ public static DataBlock CreateInstanceDataBlock(MAC_use_casesEM module, FBLibrar
 
 
     /// <summary>
-    ///     This function can also creates an instance DB in the target folder (folder under program blocks)
+    ///     This function can also create an instance DB in the target folder (folder under program blocks)
     ///     \image html CreateInstanceDB_via_XmlInstDB.png
     /// </summary>
     /// <param name="module">The Module</param>

MAC_use_cases/Images/ExampleExcelFile.png

@@ -1,4 +1,4 @@
-using Siemens.Automation.ModularApplicationCreator.Tia.Openness;
+using Siemens.Automation.ModularApplicationCreator.Tia.Openness;
 using Siemens.Automation.ModularApplicationCreator.Tia.Openness.SoftwareUnit;
 
 namespace MAC_use_cases.Model.UseCases;
@@ -7,6 +7,7 @@ public class SoftwareUnits
 {
     /// <summary>
     ///     Retrieves an existing software unit or creates a new one if it doesn't exist in the specified PLC device.
+    ///     \image html GetOrCreateSoftwareUnit.png
     /// </summary>
     /// <param name="plcDevice">The PLC device where the software unit should be located or created</param>
     /// <param name="myUnitName">The name of the software unit to get or create</param>
@@ -23,6 +24,7 @@ public static ISoftwareUnit GetOrCreateSoftwareUnit(PlcDevice
 
     /// <summary>
     ///     Retrieves the safety software unit from the specified PLC device.
+    ///     \image html GetSafetySoftwareUnit.png
     /// </summary>
     /// <param name="plcDevice">The PLC device containing the safety software unit</param>
     /// <returns>An interface to the safety software unit</returns>