Update chapters 1 + 2 (#8)

* Update chapters 1 + 2
* Remove link to internal (publicly not available) URL
* Update images and snippets to reflect the current state of the software
* Removed note to solve issue from current template
* Template-url parameter redundant
* Removed parameter from sample and example, as this should not be required
* Template and branch parameter removed
* Updated doc to fit current state
* Added note to ch.1 mentioning ADT specific branch
* Added note in ch.3 to explain separation of Attributes
* Function names and wording were brought into line with current ones
* Code snippets and description updated
* Missing explanation of used CLI parameters added
* Unified database helpsection entry
* Added missing braces in snippet
* Shortened explanation of CLI parameters
* Updated note to feature link to documentation of CLI
* Unified syntax for notes
* Added braces to IFs
* Added missing $ for command in chapter-2

---------

Co-authored-by: Philipp Steib <[email protected]>

Author: psteib

chapter-1-basics.md

@@ -44,9 +44,12 @@ only the `Assembling` step should be covered by MORYX. These information result
 in the following command:
 
 ```
-$ moryx new PencilFactory --steps Assembling --products GraphitePencil
+$ moryx new PencilFactory --steps Assembling --products GraphitePencil --branch adp
 ```
 
+> **Note** This training uses a simplified application template that is tailored to this scenario. It is provided by the --branch parameter here.
+> For real world applications you would probably omit --branch for a more advanced default setup or customize it to your needs (see [Moryx.Cli README](https://www.nuget.org/packages/Moryx.Cli#readme-body-tab) or moryx --help for more information).
+
 This should not only leave you with a solution `PencilFactory.sln` inside
 the new folder `PencilFactory`. It also does some initial configuration
 and ships empty databases. 
@@ -56,7 +59,7 @@ you run the app, you might need to [install licenses](#encountering-wupiexceptio
 
 Run the application (press `F5`).
 
-> *Note* Starting it for the first time will restore NuGet packages.That can 
+> **Note** Starting it for the first time will restore NuGet packages.That can 
 > take a few minutes.
 
 ![Application dashboard](./chapter-1/HomePageOfPencilApp.PNG)
@@ -103,7 +106,7 @@ From the details above, the `GraphitePencilType` needs
 You will find the `GraphitePencilType` among all other `<Product>Types` in the
 `PencilFactory` package within the `Products` folder.
 
-For properties to be shown in the UI, add the [EntrySerialize](https://github.com/PHOENIXCONTACT/MORYX-Framework/blob/dev/docs/articles/Core/Serialization/EntryConvert.md#entryserialize-attribute)
+Paste the following code and for properties to be shown in the UI, add the [EntrySerialize](https://github.com/PHOENIXCONTACT/MORYX-Framework/blob/dev/docs/articles/Core/Serialization/EntryConvert.md#entryserialize-attribute)
 attribute. For properties to be saved in the database, use the [DataMember](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.serialization.datamemberattribute?view=net-7.0) attribute.
 
 ``` cs
@@ -146,7 +149,7 @@ To create a product, you need to run the application now and head to the
 Click on the plus button to open the 'Product Importer' menu. This title may 
 sound a bit confusing, but it lets you add new products. 
 
-> *Note* The naming here comes from the fact, that you wouldn't necessarily add
+> **Note** The naming here comes from the fact, that you wouldn't necessarily add
 > products here, but 'import' them from other systems.
 
 ![New product](./chapter-1/create-product.png)
@@ -181,8 +184,8 @@ similar to the image below.
 
 ![Products list](./chapter-1/productList.PNG)
 
-Now you should have your products `100001-00 Brown Pencil GP-1B` and 
-`100002-00 Green Pencil GP-HB`. 
+Now you should have your products `100001-00 Green Pencil GP-1B` and 
+`100002-00 Brown Pencil BP-HB`. 
 The next challenge is to actually let a resource produce the pencils. So far there is 
 no script that describes how the pencils are produced. 
 Therefore, the next step is to model a resource after which we can create a **Recipe** and a 
@@ -219,12 +222,12 @@ Based on these requirements
 
 ### Add worker support
 
-The `AssemblingCell`, which you will find in `PencilFactory.Resources`, 
+The `AssemblingCell`, which you will find in `PencilFactory.Resources.Assembling`, 
 already has an instructor.
 
 ``` cs
 [ResourceReference(ResourceRelationType.Extension)]
-public IVisualInstructor Instructor { get; set; }
+public IVisualInstructor VisualInstructor { get; set; }
 ```
 
 `IVisualInstructor`
@@ -329,7 +332,7 @@ public override void StartActivity(ActivityStart activityStart)
     switch (activityStart.Activity)
     {
         case  AssemblingActivity activity:
-            VisualInstructor.Execute(Name, activityStart, CompleteInstruction);
+            VisualInstructor.Execute(Name, activityStart, InstructionCompleted);
             break;
     }
 }
@@ -341,7 +344,7 @@ have to implement `CompleteInstruction()`, that gets called, when an instruction
 has finished, i.e.: When a worker has finished their task.
 
 ```cs
-private void CompleteInstruction(int instructionResult, ActivityStart activity)
+private void InstructionCompleted(int instructionResult, ActivityStart activity)
 {
     var result = activity.CreateResult(instructionResult);
     _currentSession = result;
@@ -463,7 +466,9 @@ Now the production is running!
 That's it, you should now be able to let the pencils flow through the assembling
 cell.
 
-In order to see the visual instructions, go to the module `Worker Support` and select for VisualInstructor as Display
+In order to see the visual instructions, go to the module `Worker Support`.
+Select VisualInstructor as Display, if this is not already done by default.
+You can manually select it by clicking on the Settings icon at the top right.
 
 ![Select Display](./chapter-1/SelectDisplay.png)
 
@@ -487,3 +492,23 @@ They ship with developer licenses, that need to be activated:
 * Drag & Drop the `.WibuCmRau` files onto it
 
 ![Activate developer licenses](./chapter-1/drag-licenses.png)
+
+### Encountering database issues after setup section
+
+> Something went wrong on the server.
+
+> The connection to the server could not be established. Please check your network connection or try again later.
+
+If you encounter issues when opening Products or Resources for the first time at the end of the setup,
+consider checking the databases in the command center.
+There you may have to create the missing databeses.
+
+If the issue occurs during the APD at a later stage due to messing up the order of stps or making changes to classes, of existing entires, you may also need to delete the DB.
+#### Step 1: Open the Command Center
+![Open the Command Center](./chapter-1/commandCenter.png)
+
+#### Step 2: Check the databases and create missing ones
+![2. Check the databases and create missing ones](./chapter-1/commandCenterDB.png)
+
+#### Step 3: Reincarnate the failed services
+![3. Reincarnate the failed services](./chapter-1/commandCenterModules.png)

chapter-1/NewWorkplan.png

@@ -12,11 +12,11 @@ Common interfaces for drivers are `IMessageDriver<TMessage>` and `IInOutDriver`.
 * The `IInOutDriver` can read and write variables on a server. A typical protocol is OPC UA. 
 
 ## Simulated InOutDriver
-You will start with the ColorizingCell. Since the cell isn't finished yet, the manufacturer wants you to [simulate](https://git-ctvc.europe.phoenixcontact.com/moryx/moryx-simulation/-/blob/dev/docs/tutorials/how_to_simulate_my_production.md) the communication first. 
+You will start with the ColorizingCell. Since the cell isn't finished yet, the manufacturer wants you to simulate the communication first.
 
 Use the CLI to add the Colorizing step to the project.
 ```
-moryx add step Colorizing
+$ moryx add step Colorizing
 ```
 Now, in order to use simulation, add the package `Moryx.Drivers.Simulation` to the project `PencilFactory.Resources`.
 
@@ -31,7 +31,7 @@ For a protocol like that the `IInOutDriver` makes the most sense. Open the Color
 
 ```cs
 [ResourceRegistration]
-public class Colorizing : Cell
+public class ColorizingCell : Cell
 {
     private const string ProcessStart = "ProcessStart";
     private const string ProcessResult = "ProcessResult";
@@ -45,6 +45,7 @@ public class Colorizing : Cell
 ```
 
 In order to recognize, when an input changes, subscribe to that in  `OnInitialize` and when the driver is set. If you don't also subscribe to the event in the setter of the driver, you will always have to restart the system after changing the driver of a cell.
+Adjust the Driver variable and functions to match the following.
 
 ```cs
 private IInOutDriver<bool,bool> _driver;
@@ -57,7 +58,9 @@ public IInOutDriver<bool, bool> Driver
     {
         _driver = value;
         if (_driver != null)
+        {
             _driver.Input.InputChanged += OnInputChanged;
+        }
     }
 }
 ```
@@ -68,18 +71,21 @@ protected override void OnInitialize()
     ...
 
     if (_driver != null)
+    {
         _driver.Input.InputChanged += OnInputChanged;
+    }
 }
 ```
 
 
 
 In the method `OnInputChanged` you will check, if the value of `Ready` has changed. If it is true, send a `ReadyToWork` to the ProcessEngine.
+Replace the contents of the function with the following two code segments.
 
 ```cs
-private void OnInputChanged(object sender, InputChangedEventArgs e)
+private void OnInputChanged(object sender, InputChangedEventArgs args)
 {
-    if (e.Key.Equals(ReadyToWork) && _driver.Input[ReadyToWork] && !(_currentSession is ActivityStart))
+    if (args.Key.Equals(ReadyToWork) && _driver.Input[ReadyToWork] && !(_currentSession is ActivityStart))
     {
         var rtw = Session.StartSession(ActivityClassification.Production, ReadyToWorkType.Pull);
         _currentSession = rtw;
@@ -93,10 +99,10 @@ private void OnInputChanged(object sender, InputChangedEventArgs e)
 If the changed input is `ProcessResult`, read the result from the input and publish it as `ActivityCompleted`. Also set the input `ProcessStart` back to false, so that the physical cell is able to detect when to start the next process. If you don't reset the value of `ProcessStart`, the physical cell is not able to recognize the specific moment an activity should start. Some physical cells also only recognize rising or falling edges. Constant values would trigger nothing.
 
 ```cs
-private void OnInputChanged(object sender, InputChangedEventArgs e)
+private void OnInputChanged(object sender, InputChangedEventArgs args)
 {
     ...
-    else if (e.Key.Equals(ProcessResult) && _currentSession is ActivityStart activitySession)
+    else if (args.Key.Equals(ProcessResult) && _currentSession is ActivityStart activitySession)
     {
         _driver.Output[ProcessStart] = false;
         var processResult = _driver.Input[ProcessResult];
@@ -144,7 +150,7 @@ public override IEnumerable<Session> ControlSystemAttached()
 }
 ```
 
-Now you have to implement the driver. Create a new driver `SimulatedColorizingDriver` in the project `PencilFactory.Resources`, which is derived from `SimulatedInOutDriver<bool, bool>` and add the constants for the variable names. 
+Now you have to implement the driver. Create a new driver `SimulatedColorizingDriver` in the project `PencilFactory.Resources.Colorizing`, which is derived from `SimulatedInOutDriver<bool, bool>` and add the constants for the variable names. 
 
 ```cs
 [ResourceRegistration]
@@ -182,9 +188,13 @@ protected override void OnOutputSet(object sender, string key)
     {
         SimulatedInput.Values[ReadyToWork] = false;
         if (SimulatedOutput.Values[ProcessStart])
+        {
             SimulatedState = SimulationState.Executing;
+        }
         else
+        {
             SimulatedState = SimulationState.Idle;
+        }
     } 
 }
 ```
@@ -214,11 +224,3 @@ Then create a new workplan containing both steps and add it through a recipe to
 ![Complete workplan](./chapter-2/CompleteWorkplan.png)
 
 Now you should be able to start a new production.
-
-
-
-
-
-
-
-