Changes for page 01 Lua Functions

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

From 5.28 to 5.29 From 20.1 to 21.1

From version 5.29

edited by Stone Wu
on 2022/07/12 10:40

Change comment: (Autosaved)

To version 20.1

edited by Theodore Xu
on 2023/08/25 09:49

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Parent

@@ -1,1 +1,1 @@
--V-BOX.V-Net.1\.User Manual.04 Lua Script.WebHome
++V-BOX.V-Net.Manual.04 Lua Script.WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.Stone
++XWiki.AiXia

Content

@@ -140,7 +140,7 @@
   Table 2-1
--(% class="box errormessage" %)
++(% class="box infomessage" %)
  (((
  **✎Note: **If HLword enters any other value, it will be treated as invalid.
  )))
@@ -608,11 +608,12 @@
  Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below.
  |(((
++{{code language="LUA"}}
  local setup = {
  name = "COM2",
--mode = 422, ~-~- COM2 does not support RS422
++mode = 422, -- COM2 does not support RS422
  ...
@@ -619,6 +619,7 @@
  }
  serial.open(setup)
++{{/code}}
  )))
  **Data bit:**
@@ -1063,8 +1063,9 @@
  If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
--E.g:
++**For example:**
++{{code language="LUA"}}
  {
  [1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
@@ -1077,7 +1077,8 @@
  }
--Failed: //table// empty table
++Failed: table empty table
++{{/code}}
  (((
  == **bns_get_config(string from)** ==
@@ -1157,13 +1157,15 @@
  Type (1: switch, 2: number, 3: string)
--E.g:
-- {
++**For example:**
--[1]={~-~-The first communication port
++{{code language="LUA"}}
++{
--[1]={~-~-monitoring point array of the first communication port
++[1]={--The first communication port
++[1]={--monitoring point array of the first communication port
++
  [1]={[1]=11,[2]='data1',[3]=3,[4]=2},
  [2]={[1]=12,[2]='data2',[3]=3,[4]=2},
@@ -1170,23 +1170,23 @@
  ...
--[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},~-~-n monitoring points
++[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},--n monitoring points
  },
--[2]=14, ~-~-ID
++[2]=14, --ID
--[3]='Modbus TCP' ~-~-n monitoring points
++[3]='Modbus TCP' --n monitoring points
  },
--[2]={~-~-The second communication port
++[2]={--The second communication port
--[1]={},~-~-The monitoring point of the second communication port is not configured and is empty
++[1]={},--The monitoring point of the second communication port is not configured and is empty
--[2]=15, ~-~-ID
++[2]=15, --ID
--[3]='WECON' ~-~-communication protocol name
++[3]='WECON' --communication protocol name
  },
@@ -1193,6 +1193,7 @@
  ...n communication ports and so on
  }
++{{/code}}
  Failed~:// table// empty table
@@ -1272,8 +1272,9 @@
  Succeed: //table// one-dimensional array
--E.g:
++**For example:**
++{{code language="LUA"}}
  {
  [1]="This is the oldest message", - the first is the oldest message
@@ -1285,6 +1285,7 @@
  [n]="This is the latest message", - the last is the latest message
  }
++{{/code}}
  Failede: nil
@@ -1302,7 +1302,7 @@
  == **https request** ==
--Example：
++**For example:**
  {{code language="LUA"}}
  local json = require("json")
@@ -1358,7 +1358,7 @@
  **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.**
--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.
++**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.
  (% class="box infomessage" %)
  (((
@@ -1380,7 +1380,7 @@
 . Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
  (((
--== **8.2 Special data area (HSW/HSX)** ==
++== **Special data area (HSW/HSX)** ==
  (% class="box infomessage" %)
  (((
@@ -1498,8 +1498,19 @@
  ** addr_getstring("@W_HSW191",17)
  * Obtaining ICCID (read only)
  ** addr_getstring("@W_HSW225",15)
++* (((
++TSAP settings of Siemens LOGO PLC*
  (((
++addr_setword("@W_0#HSW1200",8192) means set the Local TSAP as 20.00
++)))
++
++* (((
++addr_setword("@W_0#HSW1201",4096) means set the Remote TSAP as 10.00
++)))
++)))
++
++(((
  == **Power-down storage area (HAW/HAX)** ==
  The system storage area (HAW) is used for the system power-down hold registers:
@@ -1534,7 +1534,7 @@
  Failed: multi
  (((
--== **9.2 send_sms_ucs2(string number, string message)** ==
++== **send_sms_ucs2(string number, string message)** ==
  )))
  **Function:**
@@ -1683,7 +1683,7 @@
  * number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
  * number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.
--Return:
++**Return:**
  Success: crc object
@@ -1742,7 +1742,7 @@
  Failed: multi, error code
  )))
--Example:
++**For example:**
  {{code language="LUA"}}
  function crcTest.main()
@@ -1781,9 +1781,9 @@
  end
  {{/code}}
--= **11 Special function for V-NET** =
++= **10 Special function for V-NET** =
--**normal_get_alldata()**
++== **normal_get_alldata()** ==
  **Function: **Obtain the data of all the monitoring points
@@ -1793,7 +1793,141 @@
  Succeed: table two-dimensional arrays, as follows:
--* Each item is a monitoring point and contains 4 attributes: ID, status, tag name, value)
--* Status contains 3 enumerated values (0: offline, 1: online, 2: timeout) Customization returns an empty table if there is no configuration, and vice versa, with "field name/field content"
++* Each item is a monitoring point and contains 4 attributes:
++** 1: ID
++** 2: status
++** 3: tag name
++** 4: value
++* Status contains 3 enumerated values
++** 0: offline
++** 1: online
++** 2: timeout
++* Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
--Failed: multi, error code
++**For example:**
++
++{{code language="LUA"}}
++{
++
++[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
++
++[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},
++
++...
++
++[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},
++
++}
++
++Failed: table, empty table
++{{/code}}
++
++== **normal_setdata_byname(string name, string data)** ==
++
++**Function:** Write data to the monitoring point name
++
++**Parameter:**
++
++name: the name of monitoring point
++
++data: the data to be written
++
++**Return:**
++
++Succeed: string: The value of the monitor point before it is written
++
++Failed: nil
++
++== **normal_getdata_byname(string name)** ==
++
++**Function:** Read the data of the monitoring point name
++
++**Parameter:**
++
++name: the name of monitoring point
++
++**Return:**
++
++Succeed: string
++
++Failed: nil
++
++= **11 Message summary algorithm** =
++
++== **hmac(string hash_func, string key, string message)** ==
++
++**Function:** HMAC calculate
++
++**Function name**
++
++hash_func:
++
++* [md5, sha1, sha224, sha256, sha384, sha512]
++* [sha512_224, sha512_256, sha3_224, sha3_256]
++* [sha3_384, sha3_512]
++
++**Parameter:**
++
++key: the key
++
++message: message content
++
++**Return:**
++
++Succeed: string, calculation result
++
++Failed: nil
++
++**For example:**
++
++{{code language="LUA"}}
++local sha = require"sha2"
++
++function hmac_test.main()
++
++local hmac = sha.hmac
++
++print(hmac(sha.sha1,
++
++"your key", "your message"))
++
++end
++{{/code}}
++
++== **sha(string message** ==
++
++**Function:** SHA calculate
++
++**Function name:**
++
++sha:
++
++*  sha1, sha224, sha256, sha384, sha512]
++* [sha512_224, sha512_256, sha3_224, sha3_256]
++* [sha3_384, sha3_512]
++
++**Parameter:**
++
++key: the key
++
++message: message content
++
++**Return:**
++
++Succeed: string, calculation result
++
++Failed: nil
++
++For example:
++
++{{code language="LUA"}}
++local sha = require"sha2"
++
++function sha_test.main()
++
++local sha256 = sha.sha256
++
++print(sha256("your message"))
++
++end
++{{/code}}

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents