Merge pull request #1061 from Inxton/controller-logger-updates-rep

controller logger updates rep

Author: PTKu

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "AXSharp.ixc": {
-      "version": "0.47.0-alpha.439",
+      "version": "0.47.0-alpha.452",
       "commands": [
         "ixc"
       ],
@@ -17,14 +17,14 @@
       "rollForward": false
     },
     "AXSharp.ixd": {
-      "version": "0.47.0-alpha.439",
+      "version": "0.47.0-alpha.452",
       "commands": [
         "ixd"
       ],
       "rollForward": false
     },
     "AXSharp.ixr": {
-      "version": "0.47.0-alpha.439",
+      "version": "0.47.0-alpha.452",
       "commands": [
         "ixr"
       ],

CHANGELOG.md

@@ -1,3 +1,41 @@
+### [CORE] Controller logger updates ([#1054](https://github.com/Inxton/AXOpen/pull/1054))
+
+**Note:** Enhanced logging and messaging capabilities with new message categories and requalification features.
+
+- feat: Added new `Potential` message category (severity level 150) for messages that may escalate to warnings or errors
+- feat: Introduced message requalification system via `RequalifyDownstreamMessages()` to allow downstream message category promotion
+- feat: Added `_messageCode` parameter to logger methods for improved message tracking and identification
+- feat: Implemented step timeout detection in `AxoSequencer` with automatic error message generation
+- feat: Enhanced `AxoMessageProvider` and `Flattener` to support configurable observation depth
+- refactor: Standardized severity localization keys (simplified from "SeverityInfo" to "Info", etc.)
+- refactor: Updated AxoMessenger logging signatures to use rise/fall signature markers for clarity
+- chore: Bumped AXSharp packages to 0.47.0-alpha.452 and Siemens.Simatic.S7.Webserver.API to 3.3.24
+
+**Impact:**
+- Enables intermediate message categorization before escalation to warnings or errors
+- Improves diagnostics through message code tracking and step timeout detection
+- Provides better control over message severity in distributed systems
+- Simplifies localization maintenance with consistent key naming
+
+**New Message Categories:**
+- `None` (0): No category; ignore non-critical messages
+- `Info` (100): Informative messages with minimal impact
+- `Potential` (150): Potential problems that may escalate (automatically requalified if configured)
+- `Warning` (200): Possible problems affecting the process
+- `Error` (300): Failures requiring intervention
+- `Critical` (400): Critical system failures
+- `ProgrammingError` (500): Implementation/configuration errors
+
+**Risks/Review:**
+- Existing code using old severity localization keys should be updated to use new simplified keys
+- Message requalification logic should be tested in environments with coordinated components
+- Step timeout thresholds should be validated for application-specific timing requirements
+
+**Testing:**
+- Unit tests for message requalification across all categories
+- Integration tests for step timeout scenarios in sequencers
+- Localization verification for all supported languages
+
 ### [INTEGRATIONS] Additional alignments with application template ([#768](https://github.com/Inxton/AXOpen/pull/768))
 
 **Note:** Namespace and component renames require consumers to update imports, templates, and generated UI bindings before upgrading.

Directory.Packages.props

@@ -11,12 +11,12 @@
   <!-- Framework-Agnostic Packages -->
   <ItemGroup>
     <!-- AX# Libraries -->
-    <PackageVersion Include="AXSharp.Abstractions" Version="0.47.0-alpha.456" />
-    <PackageVersion Include="AXSharp.Connector" Version="0.47.0-alpha.456" />
-    <PackageVersion Include="AXSharp.Connector.S71500.WebAPI" Version="0.47.0-alpha.456" />
-    <PackageVersion Include="AXSharp.Presentation.Blazor" Version="0.47.0-alpha.456" />
-    <PackageVersion Include="AXSharp.Presentation.Blazor.Controls" Version="0.47.0-alpha.456" />
-    <PackageVersion Include="Inxton.Operon" Version="0.3.0-alpha.133" />
+    <PackageVersion Include="AXSharp.Abstractions" Version="0.47.0-alpha.452" />
+    <PackageVersion Include="AXSharp.Connector" Version="0.47.0-alpha.452" />
+    <PackageVersion Include="AXSharp.Connector.S71500.WebAPI" Version="0.47.0-alpha.452" />
+    <PackageVersion Include="AXSharp.Presentation.Blazor" Version="0.47.0-alpha.452" />
+    <PackageVersion Include="AXSharp.Presentation.Blazor.Controls" Version="0.47.0-alpha.452" />
+    <PackageVersion Include="Inxton.Operon" Version="0.3.0-alpha.114" />
     <!-- Data & Serialization -->
     <PackageVersion Include="ClosedXML" Version="0.105.0" />
     <PackageVersion Include="Microsoft.Build" Version="18.0.2" />
@@ -40,7 +40,7 @@
     <PackageVersion Include="Serilog" Version="4.3.0" />
     <PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0" />
     <!-- Hardware & Devices -->
-    <PackageVersion Include="Siemens.Simatic.S7.Webserver.API" Version="3.3.3" />
+    <PackageVersion Include="Siemens.Simatic.S7.Webserver.API" Version="3.3.24" />
     <!-- Testing - Core -->
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
     <PackageVersion Include="NSubstitute" Version="5.3.0" />

docfx/articles/guidelines/components.md

@@ -123,6 +123,30 @@ Components should surface diagnostic and alarm information consistently:
 
 For UI auto‑rendering the alarm level icons provided by `AxoComponent` will reflect the highest active severity; ensure warnings are deactivated when condition clears to avoid stale visualization.
 
+### Message Categories
+
+The framework supports the following message categories (in order of severity):
+
+* **None** (0): No category; used to clear requalification directives and ignore non-critical messages
+* **Info** (100): Informative messages with minimal impact; do not require operator intervention
+* **Potential** (150): Potential problems that may escalate to Warning or Error states; these messages can be automatically requalified based on system configuration when downstream conditions are detected
+* **Warning** (200): Possible problems that may adversely affect a process; information to help identify problems but does not necessarily stop the process
+* **Error** (300): Failures that cannot be immediately recovered; intervention is needed
+* **Critical** (400): Critical system failures
+* **ProgrammingError** (500): Implementation or configuration errors in the application
+
+When using the `Potential` category, ensure that the parent context or sequencer is configured with appropriate requalification rules to escalate potential issues to `Warning` or `Error` when conditions persist.
+
+### Message Requalification
+
+For coordinated components and sequencers, message requalification allows upstream components to influence downstream message severity. Use `GetMessengerService().RequalifyDownstreamMessages(category)` to set the requalification category. This is particularly useful for:
+
+* Escalating `Potential` messages to `Warning` or `Error` based on elapsed time
+* Implementing hierarchical error response strategies in multi-step workflows
+* Ensuring consistent severity handling across component hierarchies
+
+Note: Only `Potential` messages are subject to requalification; other categories retain their configured severity.
+
 
 ## Documentation requirements
 

src/abstractions/ctrl/src/AxoLogger/IAxoLogger.st

@@ -25,7 +25,7 @@ NAMESPACE AXOpen.Logging
                 /// _message is a string of maximum 80 characters that represents the log message
                 /// </summary>
                 _message : STRING[80];
-                
+                                                       
                 /// <summary>
                 /// _level is an instance of eLogLevel that represents the level of the log
                 /// </summary>
@@ -35,6 +35,11 @@ NAMESPACE AXOpen.Logging
                 /// _sender is an instance of IAxoObject that represents the sender of the log
                 /// </summary>
                 _sender : IAxoObject;
+
+                /// <summary>
+                /// _messageCode is an unsigned long integer that represents the code of the log message
+                /// </summary>
+                _messageCode : ULINT;
             END_VAR                         
         END_METHOD                
 

src/abstractions/ctrl/src/AxoMessenger/IAxoMessengerService.st

@@ -5,8 +5,37 @@ NAMESPACE AXOpen.Core
                 inMessegenger : IAxoMessenger;
             END_VAR            
         END_METHOD
+        /// <summary>
+        /// Suspends the messaging system. When suspended, messages will not be sent to subscribers until the system is resumed.
+        /// This is useful for scenarios where you want to temporarily prevent messages from being processed.
+        /// </summary>
         METHOD SuspendMessaging END_METHOD    
+       
+        /// <summary>
+        /// Resumes the messaging system. When resumed, messages that arose while the system was suspended will NOT be sent to subscribers.
+        /// </summary>
         METHOD ResumeMessaging END_METHOD    
+
+        /// <summary>
+        /// Checks if the messaging system is currently suspended.
+        /// Returns true if the messaging system is suspended, false otherwise.
+        /// </summary>    
         METHOD IsSuspended : BOOL END_METHOD
+            
+        /// <summary>
+        /// Requalifies the message category for downstream messages. 
+        /// This is used to ensure that messages that are sent from a downstream component are categorized correctly, 
+        /// even if the upstream component has a different message category.
+        /// </summary>
+        METHOD RequalifyDownstreamMessages
+            VAR_INPUT
+                inMessageCategory : AXOpen.Messaging.eAxoMessageCategory;
+            END_VAR
+        END_METHOD     
+
+        /// <summary>
+        /// Gets the requalified message category for downstream messages.
+        /// </summary>
+        METHOD GetRequalifiedMessageCategory : AXOpen.Messaging.eAxoMessageCategory END_METHOD            
     END_INTERFACE    
 END_NAMESPACE

…/src/AxoMessaging/eAxoMessageCategory.st …/src/AxoMessenger/eAxoMessageCategory.stsrc/core/ctrl/src/AxoMessaging/eAxoMessageCategory.st renamed to src/abstractions/ctrl/src/AxoMessenger/eAxoMessageCategory.st src/core/ctrl/src/AxoMessaging/eAxoMessageCategory.st renamed to src/abstractions/ctrl/src/AxoMessenger/eAxoMessageCategory.st

@@ -5,20 +5,36 @@ NAMESPACE AXOpen.Messaging
         /// ATTENTION: Values must be multiply of 100
         ///</summary>
         eAxoMessageCategory : INT
-        (		                                   
+        (		        
+            ///<summary>
+            /// No category.            
+            /// This is used to indicate that the message does not have any importance and should be ignored by the system. 
+            /// Do not use this category for messages that have to be delivered to the user, even if such information is not critical.
+            /// </summary>    
+            None := 0,
+            
+            
             ///<summary>
             /// Info message.
             /// Use when you want to deliver information to the user, that has only informative character and does not adversely affect a process.
             ///</summary>
             Info := 100,
-                            
+
+            ///<summary>
+            /// Potential problem message.
+            /// Use this category when you want to report to the user an information about a potential problem, that does not necessarily affect a process 
+            /// but may cause a problem. This is typically used when certain conditions is expected to happen within a process that did not happen yet, 
+            /// this category is aimed to be later automatically requalified to Warning or Error by coordination primitive if the expected conditions did not happen within expected time.            
+            ///</summary>
+            Potential := 150,
+
             ///<summary>
             /// Warning message.
             /// Use this category when you want to report to the user an information about a possible problem, that may adversly affect a process.
             /// Information in this cateogory aims to help the user to identify a problem, the cause of such problem does not necessarily stops the process.
             ///</summary>
             Warning := 200,
-
+            
             ///<summary>
             /// Error message.
             /// Use this category when there is a failure that cannot be immediately recovered and an intervention is needed. This is typically a situation when a device fails

src/components.elements/ctrl/test/Mock.st

@@ -67,5 +67,16 @@ NAMESPACE AXOpen.Components.Elements.Tests
             END_VAR
             ;
         END_METHOD
+    
+        METHOD PUBLIC Log
+            VAR_INPUT
+                _message : STRING[80];
+                _level : eLogLevel;
+                _sender : IAxoObject;
+                _messageCode : ULINT;
+            END_VAR
+
+            ;
+        END_METHOD
     END_CLASS    
 END_NAMESPACE

src/components.pneumatics/ctrl/src/AxoCylinder.st

@@ -115,7 +115,7 @@ NAMESPACE AXOpen.Components.Pneumatics
 
             _Messenger.Serve(THIS);
 
-            _Messenger.ActivateOnCondition(UINT#3, _OutSensor AND _InSensor, eAxoMessageCategory#Error);
+            _Messenger.ActivateOnCondition(UINT#3, _OutSensor AND _InSensor, eAxoMessageCategory#Warning);
 
             IF(_StopTask.Execute(THIS)) THEN
                 _MoveInSignal := FALSE;
@@ -136,9 +136,10 @@ NAMESPACE AXOpen.Components.Pneumatics
 
             _MoveToOutIsBusy := _MoveOutTask.IsBusy();
 
-           _Messenger.ActivateOnCondition(UINT#1, (_MoveToOutIsBusy AND NOT _MoveToOutIsSuspended AND _MoveOutTask.Duration >= T#10S), eAxoMessageCategory#Error);   
-           _Messenger.ActivateOnCondition(UINT#9, (_MoveOutTask.IsDone() AND NOT _OutSensor), eAxoMessageCategory#Warning); 
-            
+           IF(NOT _MoveToOutIsSuspended AND NOT THIS._MoveOutTask.IsDisabled) THEN
+                _Messenger.ActivateOnCondition(UINT#1, (_MoveToOutIsBusy AND NOT _MoveToOutIsSuspended), eAxoMessageCategory#Potential);   
+                _Messenger.ActivateOnCondition(UINT#9, (_MoveOutTask.IsDone() AND NOT _OutSensor), eAxoMessageCategory#Potential); 
+           END_IF;
 
             IF(_MoveInTask.Execute(THIS)) THEN    
                 IF(_MoveInTask.IsFirstExecutionCycle()) THEN
@@ -151,8 +152,10 @@ NAMESPACE AXOpen.Components.Pneumatics
 
             _MoveToInIsBusy := _MoveInTask.IsBusy();
 
-            _Messenger.ActivateOnCondition(UINT#2, (_MoveToInIsBusy AND NOT _MoveToInIsSuspended AND _MoveInTask.Duration >= T#10S), eAxoMessageCategory#Error);
-            _Messenger.ActivateOnCondition(UINT#8, (_MoveInTask.IsDone() AND NOT _InSensor), eAxoMessageCategory#Warning);
+            IF(NOT _MoveToInIsSuspended AND NOT THIS._MoveInTask.IsDisabled) THEN
+                _Messenger.ActivateOnCondition(UINT#2, (_MoveToInIsBusy AND NOT _MoveToInIsSuspended), eAxoMessageCategory#Potential);
+                _Messenger.ActivateOnCondition(UINT#8, (_MoveInTask.IsDone() AND NOT _InSensor), eAxoMessageCategory#Potential);
+            END_IF;    
 
 
             outMoveInSignal := _MoveInSignal AND NOT _MoveToInIsSuspended;