Dev202408 (#15)

* [update] update CSM framework to latest version. * [add] add "VI Reference" Case to every CSM Modules * [update] add demonstration to show how to use CSM file logger add-on. * Update README.md * Update README(CN).md * add LogFilterRules in ini * [update] add demonstration to show use-case of CSM Watchdog add-on. --------- Co-authored-by: NEVSTOP <nevstop>
NEVSTOP-LAB · Aug 29, 2024 · 1eb0c25 · 1eb0c25
1 parent f945966
commit 1eb0c25
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 257 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 *.lvlps
 /*.xml
 /_data/*
-*.csm.log
+*.csm.log
+*.csmlog
diff --git a/Acquisition/Acquisition.vi b/Acquisition/Acquisition.vi
diff --git a/Algorithm/Algorithm.vi b/Algorithm/Algorithm.vi
diff --git a/CSM Continuous Meausrement and Logging Example.vipb b/CSM Continuous Meausrement and Logging Example.vipb
@@ -1,7 +1,7 @@
-<VI_Package_Builder_Settings Version="2020.1" Created_Date="2023-09-27 14:21:53" Modified_Date="2024-05-08 22:07:26" Creator="liyao" Comments="" ID="8225115d0b73a81364250fcaddb33220">
+<VI_Package_Builder_Settings Version="2020.1" Created_Date="2023-09-27 14:21:53" Modified_Date="2024-08-29 11:25:29" Creator="liyao" Comments="" ID="325c010e47fdf11ca5ce906ff5d02a8f">
   <Library_General_Settings>
     <Package_File_Name/>
-    <Library_Version>2024.5.0.1</Library_Version>
+    <Library_Version>2024.8.0.1</Library_Version>
     <Auto_Increment_Version>false</Auto_Increment_Version>
     <Library_Source_Folder>.</Library_Source_Folder>
     <Library_Output_Folder>vip</Library_Output_Folder>
@@ -17,10 +17,10 @@
   </Library_General_Settings>
   <Advanced_Settings>
     <Package_Dependencies>
-      <Additional_External_Dependencies>nevstop_lib_communicable_state_machine &gt;=2024.5.6.140418</Additional_External_Dependencies>
-      <Additional_External_Dependencies>nevstop_lib_csm_api_string_arguments_support &gt;=2024.4.30.131752</Additional_External_Dependencies>
-      <Additional_External_Dependencies>nevstop_lib_csm_ini_static_variable_support &gt;=2024.4.30.133132</Additional_External_Dependencies>
-      <Additional_External_Dependencies>nevstop_lib_csm_massdata_parameter_support &gt;=2024.4.30.130940</Additional_External_Dependencies>
+      <Additional_External_Dependencies>nevstop_lib_communicable_state_machine &gt;=2024.8.27.230559</Additional_External_Dependencies>
+      <Additional_External_Dependencies>nevstop_lib_csm_api_string_arguments_support &gt;=2024.8.27.163103</Additional_External_Dependencies>
+      <Additional_External_Dependencies>nevstop_lib_csm_ini_static_variable_support &gt;=2024.8.28.152007</Additional_External_Dependencies>
+      <Additional_External_Dependencies>nevstop_lib_csm_massdata_parameter_support &gt;=2024.7.30.95006</Additional_External_Dependencies>
       <Package_Conflicts>nevstop_lib_jki_state_machine++ &gt;=2023.9.9.235144</Package_Conflicts>
     </Package_Dependencies>
     <Custom_Action_VIs>
@@ -44,10 +44,10 @@ More information, please visit: https://github.com/NEVSTOP-LAB/CSM-Continuous-Me
       <Copyright/>
       <Packager>NEVSTOP</Packager>
       <URL>https://github.com/NEVSTOP-LAB/CSM-Continuous-Meausrement-and-Logging</URL>
-      <Release_Notes>[update] frequency of waveform generated is changing around 10Hz
-[update] update icons of CSM modules
-[update] update dependencies version
-[update] UI Module: show Frequency Status.</Release_Notes>
+      <Release_Notes>[update] update CSM framework to latest version.
+[update] add "VI Reference" Case to every CSM Modules
+[update] add demonstration to show how to use CSM file logger add-on.
+[update] add demonstration to show usecase of CSM Watchdog add-on.</Release_Notes>
     </Description>
     <Destinations>
       <Toolkit_VIs>
@@ -171,9 +171,6 @@ More information, please visit: https://github.com/NEVSTOP-LAB/CSM-Continuous-Me
       <Exclusions>
         <Path>LICENSE</Path>
       </Exclusions>
-      <Exclusions>
-        <Path>_data</Path>
-      </Exclusions>
       <Place_Folder_Contents>
         <Path/>
       </Place_Folder_Contents>
@@ -233,6 +230,7 @@ More information, please visit: https://github.com/NEVSTOP-LAB/CSM-Continuous-Me
       <close_labview_before_install>false</close_labview_before_install>
       <restart_labview_after_install>false</restart_labview_after_install>
       <skip_mass_compile_after_install>false</skip_mass_compile_after_install>
+      <install_into_global_environment>false</install_into_global_environment>
     </LabVIEW>
     <VI_Docs>
       <Edit_VI_Description>false</Edit_VI_Description>

diff --git a/CSM Continuous Meausrement and Logging.ini b/CSM Continuous Meausrement and Logging.ini
@@ -5,3 +5,8 @@ Logging.BasePath = "D:\\data"
 
 [LabVIEW]
 State = "Idle"
+
+[LogFilterRules]
+Global.State = 
+Global.StateType = State - Complete
+Acquisition.StateType = State - Complete
diff --git a/CSM Continuous Meausrement and Logging.lvproj b/CSM Continuous Meausrement and Logging.lvproj
diff --git a/Logging/Logging.vi b/Logging/Logging.vi
diff --git a/README(CN).md b/README(CN).md
@@ -7,15 +7,6 @@
 
 基于 CSM 框架更简单、更直观，更优雅的实现连续测量和记录应用的示例。
 
-> [!NOTE]
->
-> 依赖:
-> - Communicable State Machine(CSM) >= 2024.5.6.140418
-> - CSM API String Arguments Support >= 2024.4.30.131752
-> - CSM INI Static Variable Support >= 2024.4.30.133132
-> - CSM MassData Parameter Support >= 2024.4.30.130940
->
-
 ## 可复用的底层模块
 
 ### `Logging Module` : 将1D波形数据记录到TDMS文件中
@@ -76,7 +67,7 @@ API: Update Settings v2.0 >> Signal Type:Sine Wave -> Acquisition
 
 可以看出，"Logging Module" 和 "Acquisition Module" 设计完成时，完全不知道彼此的存在。为了创建连续测量和记录应用程序，除了需要一个用户界面模块。还需要调度这两个底层模块协同工作。为了简单，用户界面模块也作为 Controller，承担调度工作。
 
-当需要使用真实硬件进行数据采集时，可以创建另一个 JKISM 模块，该模块具有相同的 API 和状态，然后将其替换掉 UI 模块中的 Acquisition Module。这将允许轻松地切换并集成不同的硬件模块，而不必更改 UI 模块的其余部分，因为它们遵循相同的 API 和状态接口。
+当需要使用真实硬件进行数据采集时，可以创建另一个 CSM 模块，该模块具有相同的 API 和状态，然后将其替换掉 UI 模块中的 Acquisition Module。这将允许轻松地切换并集成不同的硬件模块，而不必更改 UI 模块的其余部分，因为它们遵循相同的 API 和状态接口。
 
 ### 用户界面模块
 

diff --git a/README.md b/README.md
@@ -7,15 +7,6 @@
 
 Accomplish application of Continuous Measurement and Logging with CSM. It's much more simple, intuitive and graceful.
 
-> [!NOTE]
->
-> Dependency:
-> - Communicable State Machine(CSM) >= 2024.5.6.140418
-> - CSM API String Arguments Support >= 2024.4.30.131752
-> - CSM INI Static Variable Support >= 2024.4.30.133132
-> - CSM MassData Parameter Support >= 2024.4.30.130940
->
-
 ## Reusable Modules
 
 ### `Logging Module` : Logging 1D Waveform Data to tdms file
@@ -78,7 +69,7 @@ API: Update Settings v2.0 >> Signal Type:Sine Wave -> Acquisition
 User interface module is needed for Continuous Measurement and Logging application.
 To make it sample(and easy to compare with workers), UI Module is also acting as the controller of the application.
 
-When you need to use real hardware for data acquisition, create another JKISM module for your hardware with the same API/Status and replace the `Acquisition Module` in UI module.
+When you need to use real hardware for data acquisition, create another CSM module for your hardware with the same API/Status and replace the `Acquisition Module` in UI module.
 
 ### UI Module
 

diff --git a/UI/UI(Launcher).vi b/UI/UI(Launcher).vi