Changes for page 01 Lua Functions

Last modified by Theodore Xu on 2023/10/26 10:51

From version 5.34
edited by Stone Wu
on 2022/07/12 10:55
Change comment: (Autosaved)
To version 17.1
edited by Theodore Xu
on 2023/08/24 16:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.1\.User Manual.04 Lua Script.WebHome
1 +V-BOX.V-Net.Manual.04 Lua Script.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Stone
1 +XWiki.AiXia
Content
... ... @@ -140,7 +140,7 @@
140 140  
141 141   Table 2-1
142 142  
143 -(% class="box errormessage" %)
143 +(% class="box infomessage" %)
144 144  (((
145 145  **✎Note: **If HLword enters any other value, it will be treated as invalid.
146 146  )))
... ... @@ -608,11 +608,12 @@
608 608  Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below.
609 609  
610 610  |(((
611 +{{code language="LUA"}}
611 611  local setup = {
612 612  
613 613  name = "COM2",
614 614  
615 -mode = 422, ~-~- COM2 does not support RS422
616 +mode = 422, -- COM2 does not support RS422
616 616  
617 617  ...
618 618  
... ... @@ -619,6 +619,7 @@
619 619  }
620 620  
621 621  serial.open(setup)
623 +{{/code}}
622 622  )))
623 623  
624 624  **Data bit:**
... ... @@ -1063,8 +1063,9 @@
1063 1063  
1064 1064  If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
1065 1065  
1066 -E.g:
1068 +**For example:**
1067 1067  
1070 +{{code language="LUA"}}
1068 1068  {
1069 1069  
1070 1070  [1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
... ... @@ -1077,7 +1077,8 @@
1077 1077  
1078 1078  }
1079 1079  
1080 -Failed: //table// empty table
1083 +Failed: table empty table
1084 +{{/code}}
1081 1081  
1082 1082  (((
1083 1083  == **bns_get_config(string from)** ==
... ... @@ -1157,13 +1157,15 @@
1157 1157  
1158 1158  Type (1: switch, 2: number, 3: string)
1159 1159  
1160 -E.g:
1161 - {
1164 +**For example:**
1162 1162  
1163 -[1]={~-~-The first communication port
1166 +{{code language="LUA"}}
1167 +{
1164 1164  
1165 -[1]={~-~-monitoring point array of the first communication port
1169 +[1]={--The first communication port
1166 1166  
1171 +[1]={--monitoring point array of the first communication port
1172 +
1167 1167  [1]={[1]=11,[2]='data1',[3]=3,[4]=2},
1168 1168  
1169 1169  [2]={[1]=12,[2]='data2',[3]=3,[4]=2},
... ... @@ -1170,23 +1170,23 @@
1170 1170  
1171 1171  ...
1172 1172  
1173 -[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},~-~-n monitoring points
1179 +[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},--n monitoring points
1174 1174  
1175 1175  },
1176 1176  
1177 -[2]=14, ~-~-ID
1183 +[2]=14, --ID
1178 1178  
1179 -[3]='Modbus TCP' ~-~-n monitoring points
1185 +[3]='Modbus TCP' --n monitoring points
1180 1180  
1181 1181  },
1182 1182  
1183 -[2]={~-~-The second communication port
1189 +[2]={--The second communication port
1184 1184  
1185 -[1]={},~-~-The monitoring point of the second communication port is not configured and is empty
1191 +[1]={},--The monitoring point of the second communication port is not configured and is empty
1186 1186  
1187 -[2]=15, ~-~-ID
1193 +[2]=15, --ID
1188 1188  
1189 -[3]='WECON' ~-~-communication protocol name
1195 +[3]='WECON' --communication protocol name
1190 1190  
1191 1191  },
1192 1192  
... ... @@ -1193,6 +1193,7 @@
1193 1193  ...n communication ports and so on
1194 1194  
1195 1195  }
1202 +{{/code}}
1196 1196  
1197 1197  Failed~:// table// empty table
1198 1198  
... ... @@ -1272,8 +1272,9 @@
1272 1272  
1273 1273  Succeed: //table// one-dimensional array
1274 1274  
1275 -E.g:
1282 +**For example:**
1276 1276  
1284 +{{code language="LUA"}}
1277 1277  {
1278 1278  
1279 1279  [1]="This is the oldest message", - the first is the oldest message
... ... @@ -1285,6 +1285,7 @@
1285 1285  [n]="This is the latest message", - the last is the latest message
1286 1286  
1287 1287  }
1296 +{{/code}}
1288 1288  
1289 1289  Failede: nil
1290 1290  
... ... @@ -1302,7 +1302,7 @@
1302 1302  
1303 1303  == **https request** ==
1304 1304  
1305 -Example
1314 +**For example:**
1306 1306  
1307 1307  {{code language="LUA"}}
1308 1308  local json = require("json")
... ... @@ -1358,7 +1358,7 @@
1358 1358  
1359 1359  **Access in bit mode, the prefix is @B_HDX, the number in front of "." indicates the number of the word, and the number behind is the bit number of the word.**
1360 1360  
1361 -For example: @B_HDX1020.12, its meaning is to access the system data area in bit mode, the specific location is the 13th bit of the 1020th word.
1370 +**For example:** @B_HDX1020.12, its meaning is to access the system data area in bit mode, the specific location is the 13th bit of the 1020th word.
1362 1362  
1363 1363  (% class="box infomessage" %)
1364 1364  (((
... ... @@ -1380,7 +1380,7 @@
1380 1380  1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
1381 1381  
1382 1382  (((
1383 -== **8.2 Special data area (HSW/HSX)** ==
1392 +== **Special data area (HSW/HSX)** ==
1384 1384  
1385 1385  (% class="box infomessage" %)
1386 1386  (((
... ... @@ -1498,8 +1498,19 @@
1498 1498  ** addr_getstring("@W_HSW191",17)
1499 1499  * Obtaining ICCID (read only)
1500 1500  ** addr_getstring("@W_HSW225",15)
1510 +* (((
1511 +TSAP settings of Siemens LOGO PLC*
1501 1501  
1502 1502  (((
1514 +addr_setword("@W_0#HSW1200",8192) means set the Local TSAP as 20.00
1515 +)))
1516 +
1517 +* (((
1518 +addr_setword("@W_0#HSW1201",4096) means set the Remote TSAP as 10.00
1519 +)))
1520 +)))
1521 +
1522 +(((
1503 1503  == **Power-down storage area (HAW/HAX)** ==
1504 1504  
1505 1505  The system storage area (HAW) is used for the system power-down hold registers:
... ... @@ -1534,7 +1534,7 @@
1534 1534  Failed: multi
1535 1535  
1536 1536  (((
1537 -== **9.2 send_sms_ucs2(string number, string message)** ==
1557 +== **send_sms_ucs2(string number, string message)** ==
1538 1538  )))
1539 1539  
1540 1540  **Function:**
... ... @@ -1683,7 +1683,7 @@
1683 1683  * number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
1684 1684  * number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.
1685 1685  
1686 -Return:
1706 +**Return:**
1687 1687  
1688 1688  Success: crc object
1689 1689  
... ... @@ -1742,7 +1742,7 @@
1742 1742  Failed: multi, error code
1743 1743  )))
1744 1744  
1745 -Example:
1765 +**For example:**
1746 1746  
1747 1747  {{code language="LUA"}}
1748 1748  function crcTest.main()
... ... @@ -1804,8 +1804,9 @@
1804 1804  ** 2: timeout
1805 1805  * Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
1806 1806  
1807 -For example:
1827 +**For example:**
1808 1808  
1829 +{{code language="LUA"}}
1809 1809  {
1810 1810  
1811 1811  [1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
... ... @@ -1819,6 +1819,7 @@
1819 1819  }
1820 1820  
1821 1821  Failed: table, empty table
1843 +{{/code}}
1822 1822  
1823 1823  == **normal_setdata_byname(string name, string data)** ==
1824 1824  
... ... @@ -1834,13 +1834,10 @@
1834 1834  
1835 1835  Succeed: string: The value of the monitor point before it is written
1836 1836  
1837 -Failed: mil
1859 +Failed: nil
1838 1838  
1839 1839  == **normal_getdata_byname(string name)** ==
1840 1840  
1841 -
1842 -
1843 -
1844 1844  **Function:** Read the data of the monitoring point name
1845 1845  
1846 1846  **Parameter:**
... ... @@ -1851,7 +1851,7 @@
1851 1851  
1852 1852  Succeed: string
1853 1853  
1854 -Failed: mil
1873 +Failed: nil
1855 1855  
1856 1856  = **11 MySQL database operation** =
1857 1857  
... ... @@ -1863,12 +1863,194 @@
1863 1863  
1864 1864  sourcename: the name of database
1865 1865  
1866 -username: the connected username
1885 +username: the username of the connection
1867 1867  
1868 -password:
1887 +password: the password of the connection
1869 1869  
1889 +host: the host name of the connection
1890 +
1891 +port: the host port of the connection
1892 +
1893 +character: the character set of the connection
1894 +
1870 1870  **Return:**
1871 1871  
1872 1872  Succeed: string
1873 1873  
1874 -Failed: mil
1899 +Failed: multi
1900 +
1901 +== **luaMySql.exec(string statement)** ==
1902 +
1903 +**Function:** Execute the given SQL statement without returning the result set (add, delete, change)
1904 +
1905 +**Parameter:**
1906 +
1907 +statement: the given SQL statement
1908 +
1909 +**Return:**
1910 +
1911 +Succeed: status: returns the number of rows affected by SQL statement execution.
1912 +
1913 +Failed: nil, errorString
1914 +
1915 +== **luaMySql.execWithResult(string statement)** ==
1916 +
1917 +**Function:** Execute the given SQL statement returning the result set (check)
1918 +
1919 +**Parameter:**
1920 +
1921 +statement: the given SQL statement
1922 +
1923 +**Return:**
1924 +
1925 +Succeed: table: returns the result set
1926 +
1927 +Failed: nil, errorString
1928 +
1929 +**For example:**
1930 +
1931 +{{code language="LUA"}}
1932 +-- Assuming the "mysqlclient" library is properly installed and available
1933 +mysql = require("mysqlclient")
1934 +
1935 +function DataInitRight()
1936 + local dbName = "excel"
1937 + local user = "root"
1938 + local pwd = "XXXXX"
1939 + local host = "192.168.39.146"
1940 + local port = 3306
1941 + local character = "utf8mb3"
1942 +
1943 + mysql.init(dbName, user, pwd, host, port, character)
1944 +end
1945 +
1946 +function ExecFunc()
1947 + status, errorString = mysql.exec("delete from student where Name = 'XXX';") --Delete statement, column name = table element
1948 + if nil == status then
1949 + print("ExecFunc() error:", errorString)
1950 + return -1
1951 + else
1952 + print("the number of rows affected by the command:", status)
1953 + end
1954 + return 0
1955 +end
1956 +
1957 +
1958 +function ExecWithResultFunc()
1959 + status, errorString = mysql.execWithResult("select * from student;")
1960 + if nil == status then
1961 + print("ExecWithResultFunc() error:", errorString)
1962 + return -1
1963 + else
1964 + print("ExecWithResultFunc() success : status type = ", type(status))
1965 + print("ExecWithResultFunc() success : status len = ", #status)
1966 + local num = #status
1967 + local i = 1
1968 + if num > 0 then
1969 + for i = 1, num, 1 do
1970 + local var = string.format("select result[%d] :Num = %d,Name = %s,Age = %d", i, status[i].Num, status[i].Name,status[i].Age) --Iterate through the data in the table, noting whether the elements are strings or numbers
1971 + print(var)
1972 + end
1973 + end
1974 + print("---------------")
1975 + end
1976 + return 0
1977 +end
1978 +
1979 +function MySQL.main()
1980 + print("script running ...")
1981 + DataInitRight()
1982 +
1983 + -- use exec demo
1984 + if ExecFunc() < 0 then
1985 + return
1986 + end
1987 +
1988 + -- use execWithResult demo
1989 + if ExecWithResultFunc() < 0 then
1990 + return
1991 + end
1992 +
1993 + print("script running success")
1994 +end
1995 +{{/code}}
1996 +
1997 += **12 Message summary algorithm** =
1998 +
1999 +== **hmac(string hash_func, string key, string message)** ==
2000 +
2001 +**Function:** HMAC calculate
2002 +
2003 +**Function name**
2004 +
2005 +hash_func:
2006 +
2007 +* [md5, sha1, sha224, sha256, sha384, sha512]
2008 +* [sha512_224, sha512_256, sha3_224, sha3_256]
2009 +* [sha3_384, sha3_512]
2010 +
2011 +**Parameter:**
2012 +
2013 +key: the key
2014 +
2015 +message: message content
2016 +
2017 +**Return:**
2018 +
2019 +Succeed: string, calculation result
2020 +
2021 +Failed: nil
2022 +
2023 +**For example:**
2024 +
2025 +{{code language="LUA"}}
2026 +local sha = require"sha2"
2027 +
2028 +function hmac_test.main()
2029 +
2030 +local hmac = sha.hmac
2031 +
2032 +print(hmac(sha.sha1,
2033 +
2034 +"your key", "your message"))
2035 +
2036 +end
2037 +{{/code}}
2038 +
2039 +== **sha(string message** ==
2040 +
2041 +**Function:** SHA calculate
2042 +
2043 +**Function name:**
2044 +
2045 +sha:
2046 +
2047 +* sha1, sha224, sha256, sha384, sha512]
2048 +* [sha512_224, sha512_256, sha3_224, sha3_256]
2049 +* [sha3_384, sha3_512]
2050 +
2051 +**Parameter:**
2052 +
2053 +key: the key
2054 +
2055 +message: message content
2056 +
2057 +**Return:**
2058 +
2059 +Succeed: string, calculation result
2060 +
2061 +Failed: nil
2062 +
2063 +For example:
2064 +
2065 +{{code language="LUA"}}
2066 +local sha = require"sha2"
2067 +
2068 +function sha_test.main()
2069 +
2070 +local sha256 = sha.sha256
2071 +
2072 +print(sha256("your message"))
2073 +
2074 +end
2075 +{{/code}}