diff --git a/CSM API String Arguments Support.lvproj b/CSM API String Arguments Support.lvproj index 37e9117..fdd0762 100644 --- a/CSM API String Arguments Support.lvproj +++ b/CSM API String Arguments Support.lvproj @@ -32,6 +32,7 @@ + @@ -120,23 +121,16 @@ - - - - - - - @@ -200,7 +194,6 @@ - @@ -258,7 +251,6 @@ - @@ -266,7 +258,6 @@ - diff --git a/CSM API String Arguments Support.vipb b/CSM API String Arguments Support.vipb index 28231de..505c282 100644 --- a/CSM API String Arguments Support.vipb +++ b/CSM API String Arguments Support.vipb @@ -1,4 +1,4 @@ - + NEVSTOP_lib_CSM_API_String_Arguments_Support 0.2.0.15 @@ -35,9 +35,10 @@ CSM API String Arguments Support.vipc API string argument support enhancement for CSM - # JKISMPP-API-String-Arugments-Support + The purpose of this library is to enhance the API parameters for Communicable State Machine (CSM). It allows for the inclusion of various data types in plain text format. Two more templates which include "Data: Get Configuration", "Data: Set Configuration" and "Data: Get Internal Status" states, are provided in the library. These templates can serve as a starting point for building your CSM module with the ability to access data stored in the '>> internal data >>' shift register. -### Supported Data Type + +## Supported Data Type - String/Path - Boolean @@ -47,133 +48,16 @@ - Array - Cluster -#### String/Path - -It Follows JKISM++'s rule. '->|' '->' '-@' '-&' '>>' ',' ';' should be replaced with %[Hex] String before passing. You can use **JKISM++ AdvanceAPI\JKISM++ Make String Arguments Safe.vi**. - -#### Boolean - -``` -TRUE/FALSE String Pairs: - - T/F - - True/False - - On/Off - - Enable/Disable - - Active/Inactive - - valid/Invalid - - 1/0 - - Open/Close - - Non-null/null -``` - -#### Integer - -``` -Supported format: - - 12345 - - 0d12345 - - 0x1234 - - 0b10101010 - - 0o777 - - 1234H - - 10101010H - - 7777O - - 10k - - 1M -``` - -#### Float(DBL/SGL) - -``` -Supported Format: - - 1.2345 - - 1.23E+2 - - 1.23E-2 - - 1.23M (1.23*10^6) - - 1.23k (1.23*10^3) - - 1.23m (1.23*0.001) - - 1.23u (1.23*0.000001) -``` - -### Enum - -**Condition1** - -Enum = {AAA,BBBB,CCCC} - - - String "AAA" will be converted to Enum(AAA), IntegerValue = 0 - - String "CCC" will be converted to Enum(CCC), IntegerValue = 2 - -**Condition2** - -Enum = {1- AAA,5 - BBBB, 9 - CCCC} - - - String "AAA" will be converted to Enum(1- AAA), IntegerValue = 0 - - String "5" will be converted to Enum(5 - BBBB), IntegerValue = 1 - - String "9 - CCCC" will be converted to Enum(9 - CCCC), IntegerValue = 2 - -### Array - -',' is used for element seperator, ';' is usd for row seperator. '[' & ']' are used for boundary symbol. If it's not in cluster, boundary symbol is not indispensable. - -**Example:** - -`a,b,c,d,e` and `[a,b,c,d,e]` stands for 5 elements array - -``` -a b c d e -``` - -`a;b;c;d;e` and `[a;b;c;d;e]` stands for 5 elements array - -``` -a -b -c -d -e -``` - -`a1, b1, c1, d1, e1; a2, b2, c2, d2, e2` and `[a1, b1, c1, d1, e1; a2, b2, c2, d2, e2]` stands for 2*5 2D array - -``` -a1 b1 c1 d1 e1 -a2 b2 c2 d2 e2 -``` - -### Cluster - - -':' is used for seperating name and value, ';' is usd for seperating elements. '{' & '}' are used for boundary symbol. If it's not within other array/cluster, boundary symbol is not indispensable. Not all elements should be descripted but the changing ones. -It's helpful for JKISM++ to reduce configuration setting API numbers. You can defined the configuration within a cluster and one single setting API for the config API. - -**Example:** - -Suppose a cluster as below: -``` -typedef cluster{ -Boolean b; -String str; -U32 integer -} -``` - -`b:On` and `{b:On}` stands for change the input cluster's boolean b to TURE only. Other elements keep as before. - -`b:On;str:abcdef` and `{b:On;str:abcdef}` stands for change the input cluster's boolean b to TURE and String str to "abcdef". Other elements keep as before. - +More information for the supported datatype format, please visit: https://github.com/NEVSTOP-LAB/CSM-API-String-Arugments-Support ## Know Issue -1. Cluster in Array is not fully supported. Need to imporve. -2. 2D array in cluster is not supported now. Need to imporve. - - - +1. **Cluster in Array is not fully supported. Need to imporve.** +2. **2D array in cluster is not supported now. Need to imporve.** NEVSTOP https://github.com/NEVSTOP-LAB/CSM-API-String-Arugments-Support - + First release. API is under CSM Add-on palette. diff --git a/Example/Example/Main.vi b/Example/Example/Main.vi index b4004d4..a24b0b5 100644 Binary files a/Example/Example/Main.vi and b/Example/Example/Main.vi differ diff --git a/Example/Example/Module.vi b/Example/Example/Module.vi index 4f6e81e..5ddb7de 100644 Binary files a/Example/Example/Module.vi and b/Example/Example/Module.vi differ diff --git a/Example/Supported Datatype Examples/Test Cases - Datatype Check.vi b/Example/Supported Datatype Examples/Test Cases - Datatype Check.vi index 1311e28..575de1c 100644 Binary files a/Example/Supported Datatype Examples/Test Cases - Datatype Check.vi and b/Example/Supported Datatype Examples/Test Cases - Datatype Check.vi differ diff --git a/README.md b/README.md index 1ec1ce2..3f1cc2f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # CSM-API-String-Arugments-Support +The purpose of this library is to enhance the API parameters for Communicable State Machine (CSM). It allows for the inclusion of various data types in plain text format. Two more templates which include "Data: Get Configuration", "Data: Set Configuration" and "Data: Get Internal Status" states, are provided in the library. These templates can serve as a starting point for building your CSM module with the ability to access data stored in the '>> internal data >>' shift register. + ### Supported Data Type - String/Path @@ -128,8 +130,5 @@ U32 integer ## Know Issue -1. Cluster in Array is not fully supported. Need to imporve. -2. 2D array in cluster is not supported now. Need to imporve. - - - +1. **Cluster in Array is not fully supported. Need to imporve.** +2. **2D array in cluster is not supported now. Need to imporve.** diff --git a/Template/CSM - With Event Structure Template(+Configuration).vi b/Template/CSM - With Event Structure Template(+Configuration).vi index c531af9..2429c02 100644 Binary files a/Template/CSM - With Event Structure Template(+Configuration).vi and b/Template/CSM - With Event Structure Template(+Configuration).vi differ diff --git a/Template/CSM - Without Event Structure Template(+Configuration).vi b/Template/CSM - Without Event Structure Template(+Configuration).vi index f8bf104..6c4a619 100644 Binary files a/Template/CSM - Without Event Structure Template(+Configuration).vi and b/Template/CSM - Without Event Structure Template(+Configuration).vi differ