Dev202412 (#346)

* init Dev202412 * test action-runner * [update] update control palette for CSM * [update] update control palette for CSM * TEST-BUILDMACHINE * [fix] minor fix #347 * [fix] #323 fix grammar of unregister, to make it more friendly for new CSM user * update doc #323 * add Match Asterisk Pattern.vi * [fix] #348 fix unreadable description issue. Thanks @drjdpowell * [update] Update utility VI icons * make template looks simple * [update] #349 make template looks simple. Thanks @drjdpowell * add Global Log History Cacher.vi * [add] add Global Log History Cacher.vi and quick drop snippet of Global Log monitoring loop * fix https://github.com/NEVSTOP-LAB/Communicable-State-Machine/actions/runs/12427017260/job/34696165435 * update csm-intro.png * update example * Change wire labels * [update] #297 Internal Status registration will be automatically removed after csm exits. * add a testcase for #348 * [update] #344 show parameter in filtered periodic log in debug tools * [add] add a new example VI to compare the templates of JKISM and CSM * change wire label from "From CSM" to "Msg/Rep's CSM" * update JKISM vs CSM.vi * [update] Add "Skip in Runtime(T)" option for CSM - Internal State Debug Log History.vi [update] Add "Periodic Log Info" terminal for CSM - Internal State Debug Log History.vi * update Global Log History Cacher.vi * [add] add "Enum to String_csm.vim" utility * remove vim * add lvlibp build spec * improve tools performance * fix typo * fix with vi analyzer * [update] improve csm tools performance * update CSM - Global Log Monitoring Loop.vi * plan to release * mass compile all --------- Co-authored-by: NEVSTOP <nevstop>
NEVSTOP-LAB · Dec 30, 2024 · 54d2cb5 · 54d2cb5
1 parent dc0a58e
commit 54d2cb5
Show file tree

Hide file tree

Showing 272 changed files with 896 additions and 729 deletions.
diff --git a/.doc/_img/csm-intro.png b/.doc/_img/csm-intro.png
diff --git a/Communicable State Machine(CSM).lvproj b/Communicable State Machine(CSM).lvproj
@@ -74,6 +74,7 @@
 			<Item Name="testcase-csm-file-logger.lvclass" Type="LVClass" URL="../testcases/testcase-csm-file-logger/testcase-csm-file-logger.lvclass"/>
 			<Item Name="testcase-Broadcast Registry.lvclass" Type="LVClass" URL="../testcases/testcase-Broadcast Registry/testcase-Broadcast Registry.lvclass"/>
 			<Item Name="testcase-Basic-Function.lvclass" Type="LVClass" URL="../testcases/testcase-Basic-Function/testcase-Basic-Function.lvclass"/>
+			<Item Name="testcase-documentation.lvclass" Type="LVClass" URL="../testcases/testcase-documentation/testcase-documentation.lvclass"/>
 		</Item>
 		<Item Name="API Tree.vi" Type="VI" URL="../src/API Tree.vi"/>
 		<Item Name="Communicable State Machine(CSM).vipb" Type="Document" URL="../Communicable State Machine(CSM).vipb"/>
@@ -494,6 +495,46 @@
 			<Item Name="Checkmark Status.ctl" Type="VI" URL="/&lt;resource&gt;/plugins/PopupMenus/support/Checkmark Status.ctl"/>
 			<Item Name="Enabled Menu Item Status.ctl" Type="VI" URL="/&lt;resource&gt;/plugins/PopupMenus/support/Enabled Menu Item Status.ctl"/>
 		</Item>
-		<Item Name="Build Specifications" Type="Build"/>
+		<Item Name="Build Specifications" Type="Build">
+			<Item Name="Communicable State Machine.lvlibp" Type="Packed Library">
+				<Property Name="Bld_buildCacheID" Type="Str">{E6766B2B-D468-4793-BDC2-B658A6B7F582}</Property>
+				<Property Name="Bld_buildSpecName" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="Bld_excludeLibraryItems" Type="Bool">true</Property>
+				<Property Name="Bld_excludePolymorphicVIs" Type="Bool">true</Property>
+				<Property Name="Bld_localDestDir" Type="Path">../builds/NI_AB_PROJECTNAME/Communicable State Machine.lvlibp</Property>
+				<Property Name="Bld_localDestDirType" Type="Str">relativeToCommon</Property>
+				<Property Name="Bld_modifyLibraryFile" Type="Bool">true</Property>
+				<Property Name="Bld_previewCacheID" Type="Str">{10AFC524-DE75-48D3-9EA6-4A2C13DE721C}</Property>
+				<Property Name="Bld_version.build" Type="Int">2</Property>
+				<Property Name="Bld_version.major" Type="Int">2024</Property>
+				<Property Name="Bld_version.minor" Type="Int">12</Property>
+				<Property Name="Destination[0].destName" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="Destination[0].path" Type="Path">../builds/NI_AB_PROJECTNAME/Communicable State Machine.lvlibp/Communicable State Machine.lvlibp</Property>
+				<Property Name="Destination[0].preserveHierarchy" Type="Bool">true</Property>
+				<Property Name="Destination[0].type" Type="Str">App</Property>
+				<Property Name="Destination[1].destName" Type="Str">Support Directory</Property>
+				<Property Name="Destination[1].path" Type="Path">../builds/NI_AB_PROJECTNAME/Communicable State Machine.lvlibp</Property>
+				<Property Name="DestinationCount" Type="Int">2</Property>
+				<Property Name="PackedLib_callersAdapt" Type="Bool">true</Property>
+				<Property Name="Source[0].itemID" Type="Str">{39CD7CBB-08C4-4F97-AECB-862BA054B79A}</Property>
+				<Property Name="Source[0].type" Type="Str">Container</Property>
+				<Property Name="Source[1].destinationIndex" Type="Int">0</Property>
+				<Property Name="Source[1].itemID" Type="Ref">/My Computer/user.lib/_NEVSTOP/Communicable State Machine(CSM)/Communicable State Machine.lvlib</Property>
+				<Property Name="Source[1].Library.allowMissingMembers" Type="Bool">true</Property>
+				<Property Name="Source[1].Library.atomicCopy" Type="Bool">true</Property>
+				<Property Name="Source[1].Library.LVLIBPtopLevel" Type="Bool">true</Property>
+				<Property Name="Source[1].preventRename" Type="Bool">true</Property>
+				<Property Name="Source[1].sourceInclusion" Type="Str">TopLevel</Property>
+				<Property Name="Source[1].type" Type="Str">Library</Property>
+				<Property Name="SourceCount" Type="Int">2</Property>
+				<Property Name="TgtF_fileDescription" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="TgtF_internalName" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="TgtF_legalCopyright" Type="Str">Copyright ?2024 </Property>
+				<Property Name="TgtF_productName" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="TgtF_targetfileGUID" Type="Str">{AEC2982C-A144-46EC-BABE-851C50D1612D}</Property>
+				<Property Name="TgtF_targetfileName" Type="Str">Communicable State Machine.lvlibp</Property>
+				<Property Name="TgtF_versionIndependent" Type="Bool">true</Property>
+			</Item>
+		</Item>
 	</Item>
 </Project>
diff --git a/Communicable State Machine(CSM).vipb b/Communicable State Machine(CSM).vipb
@@ -1,7 +1,7 @@
-<VI_Package_Builder_Settings Version="2020.1" Created_Date="2023-07-01 11:20:47" Modified_Date="2024-11-25 18:34:43" Creator="liyao" Comments="" ID="56662b33a87bbad7dae5bc80b1f65906">
+<VI_Package_Builder_Settings Version="2020.1" Created_Date="2023-07-01 11:20:47" Modified_Date="2024-12-28 20:44:28" Creator="liyao" Comments="" ID="e796fd95bba5bceb4fe882896544e264">
   <Library_General_Settings>
     <Package_File_Name>NEVSTOP_lib_Communicable_State_Machine</Package_File_Name>
-    <Library_Version>2024.11.0.3</Library_Version>
+    <Library_Version>2024.12.0.3</Library_Version>
     <Auto_Increment_Version>false</Auto_Increment_Version>
     <Library_Source_Folder>src</Library_Source_Folder>
     <Library_Output_Folder>vip</Library_Output_Folder>
@@ -70,21 +70,29 @@ For information on NEVSTOP-LAB, visit: &lt;color=blue&gt;&lt;u&gt;&lt;i&gt;https
       <Copyright/>
       <Packager>NEVSTOP</Packager>
       <URL>https://github.com/NEVSTOP-LAB</URL>
-      <Release_Notes>[important] Peroidic States/Log will automatically be filtered in Template/DebugTools/Examples
-[important] Change License to MIT, to enable more csm users
-
-#Core
-[update] #337 Show Responses in "CSM - Run Script.vi"
-
-#Template
-[update] Update template to use new State Debug Log VI, which will automatically filter period States in log
+      <Release_Notes>#Core
+[fix] #323 fix grammar of unregister, to make it more friendly for new CSM user
+[update] #297 Internal Status registration will be automatically removed after csm exits.
 
-#Installer
-[update] Remove the localization process to speed up the installation. You can use the CSM Tool to change the description language.
+#API
+[update] update ctrl palette for CSM
+[fix] minor fix #347
 
-#Tool
-[update] #285 Peroidic States/Log will automatically be filtered in DebugTools
-[fix] minor fix #327</Release_Notes>
+#Template
+[update] #349 make template looks simple. Thanks @drjdpowell
+
+#Tool
+[update] improve csm tools performance
+
+#Documentation
+[add] add a new example VI to compare the teamplates of JKISM and CSM
+[fix] #348 fix unreadable description issue. Thanks @drjdpowell
+[update] Update utility VI icons
+
+#utility
+[add] add Global Log History Cacher.vi and quick drop snippet of Global Log monitoring loop
+[update] #344 show argument in filted periodic log in debug tools
+[update] Add "Skip in Runtime(T)" option for CSM - Internal State Debug Log History.vi</Release_Notes>
     </Description>
     <Destinations>
       <Toolkit_VIs>

diff --git a/README(zh-cn).md b/README(zh-cn).md
@@ -60,7 +60,6 @@ CSM API 介绍:
 
     // 取消注册源模块的状态
     Status@Source Module >> API@Handler Module -><unregister>
-    Status@Source Module >> Handler Module -><unregister> // API Name可以缺省
 
 #CSM 注释
     // 要添加注释，请使用 "//"，右边的所有文本将被忽略。

diff --git a/README.md b/README.md
@@ -60,7 +60,6 @@ In this scenario, inter-module communication solely relies on message string que
 
     // Unregister Source Module's status
     Status@Source Module >> API@Handler Module -><unregister>
-    Status@Source Module >> Handler Module -><unregister> // API Name could not be specified.
 
 #CSM Commenting
     To add a comment use "//" and all text to the right will be ignored

diff --git a/src/API Tree.vi b/src/API Tree.vi
diff --git a/src/Example/0. Base Concepts/Arguments - Complex Data As Arguments.vi b/src/Example/0. Base Concepts/Arguments - Complex Data As Arguments.vi
diff --git a/src/Example/0. Base Concepts/JKISM vs CSM.vi b/src/Example/0. Base Concepts/JKISM vs CSM.vi
diff --git a/src/Example/1. Create a reuse Module/CSM Reuse Module.vi b/src/Example/1. Create a reuse Module/CSM Reuse Module.vi
diff --git a/src/Example/2. Caller is CSM Scenario/CSM Example - Caller is a CSM.vi b/src/Example/2. Caller is CSM Scenario/CSM Example - Caller is a CSM.vi
diff --git a/src/Example/4. Advance Examples/Action Workers Example/Action Worker Mode Example.vi b/src/Example/4. Advance Examples/Action Workers Example/Action Worker Mode Example.vi
diff --git a/src/Example/4. Advance Examples/Action Workers Example/Action Worker.vi b/src/Example/4. Advance Examples/Action Workers Example/Action Worker.vi
diff --git a/src/Example/4. Advance Examples/Build-in Error Handling Framework/Error Module.vi b/src/Example/4. Advance Examples/Build-in Error Handling Framework/Error Module.vi
diff --git a/...Advance Examples/Build-in Error Handling Framework/Topmost VI who Registers all Errors.vi b/...Advance Examples/Build-in Error Handling Framework/Topmost VI who Registers all Errors.vi
diff --git a/...es/CSM with Side Loop as a Module/CSM Module - TCP Server SubModule(Side-Loop Support).vi b/...es/CSM with Side Loop as a Module/CSM Module - TCP Server SubModule(Side-Loop Support).vi
diff --git a/.../4. Advance Examples/Chain of Responsiblility Example/Chain of Responsiblility Example.vi b/.../4. Advance Examples/Chain of Responsiblility Example/Chain of Responsiblility Example.vi
diff --git a/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode A.vi b/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode A.vi
diff --git a/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode B.vi b/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode B.vi
diff --git a/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode C.vi b/src/Example/4. Advance Examples/Chain of Responsiblility Example/ChainNode C.vi
diff --git a/src/Example/Addons - Logger/CSM Application Running Log Example.vi b/src/Example/Addons - Logger/CSM Application Running Log Example.vi
diff --git a/src/Example/Addons - Loop Support/CSMLS - Continuous Loop in CSM Example.vi b/src/Example/Addons - Loop Support/CSMLS - Continuous Loop in CSM Example.vi
diff --git a/...tate Machine(CSM)/VI Description(en)/VI Description(en) - 02. Core Functions.md b/...tate Machine(CSM)/VI Description(en)/VI Description(en) - 02. Core Functions.md
@@ -89,7 +89,7 @@ This VI is used to build CSM message strings and operation strings.
 > - Build Unregister Status Message.vi
 > - CSM - Replace Substitution Marks in Messages.vi
 
-#### Build Message with Arguments (Auto Check).vi
+#### Build Message with Arguments(Auto Check).vi
 
 Concatenates a CSM message string, and the message type symbol will be automatically detected based on the input <b>State with Arguments</b>.
 
@@ -304,7 +304,7 @@ Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE
 > - add State(s) to Queue By BOOL (Array Right).vi
 > - add State(s) to Queue By BOOL (Array All).vi
 
-#### Add State(s) to Queue By BOOL (Element).vi
+#### Add State(s) to Queue By BOOL(Element).vi
 
 Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE state string options to avoid using conditional structures, improving code readability and programming efficiency.
 
@@ -320,7 +320,7 @@ Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE
 <b>Indicators</b>
 - <b>Remaining States</b>: All concatenated states and parameters.
 
-#### Add State(s) to Queue By BOOL (Array Left).vi
+#### Add State(s) to Queue By BOOL(Array Left).vi
 
 Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE state string options to avoid using conditional structures, improving code readability and programming efficiency.
 
@@ -336,7 +336,7 @@ Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE
 <b>Indicators</b>
 - <b>Remaining States</b>: All concatenated states and parameters.
 
-#### Add State(s) to Queue By BOOL (Array Right).vi
+#### Add State(s) to Queue By BOOL(Array Right).vi
 
 Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE state string options to avoid using conditional structures, improving code readability and programming efficiency.
 
@@ -352,7 +352,7 @@ Incorporates CSM message strings into the CSM message queue. Provides TRUE/FALSE
 <b>Indicators</b>
 - <b>Remaining States</b>: All concatenated states and parameters.
 
-#### Add State(s) to Queue By BOOL (Array All).vi
+#### Add State(s) to Queue By BOOL(Array All).vi
 
 Based on high priority and Bool input, this VI generates TRUE/False and remaining states concatenated states.
 The High Priority input determines whether to concatenate the TRUE or FALSE string before or after the remaining states.