Changes for page 01 Lua Functions

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

From 5.15 to 5.14 From 9.3 to 9.2

From version 9.2

edited by Stone Wu
on 2022/07/25 11:32

Change comment: Update document after refactoring.

To version 5.15

edited by Stone Wu
on 2022/07/12 09:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Parent

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

Content

@@ -140,7 +140,7 @@
   Table 2-1
--(% class="box infomessage" %)
++(% class="box errormessage" %)
  (((
  **✎Note: **If HLword enters any other value, it will be treated as invalid.
  )))
@@ -608,12 +608,11 @@
  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
  ...
@@ -620,7 +620,6 @@
  }
  serial.open(setup)
--{{/code}}
  )))
  **Data bit:**
@@ -1065,9 +1065,8 @@
  If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
--**For example:**
++E.g:
--{{code language="LUA"}}
  {
  [1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
@@ -1080,8 +1080,7 @@
  }
--Failed: table empty table
--{{/code}}
++Failed: //table// empty table
  (((
  == **bns_get_config(string from)** ==
@@ -1161,15 +1161,13 @@
  Type (1: switch, 2: number, 3: string)
--**For example:**
++E.g:
++ {
--{{code language="LUA"}}
--{
++[1]={~-~-The first communication port
--[1]={--The first communication port
++[1]={~-~-monitoring point array of 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},
@@ -1176,23 +1176,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
  },
@@ -1199,7 +1199,6 @@
  ...n communication ports and so on
  }
--{{/code}}
  Failed~:// table// empty table
@@ -1279,9 +1279,8 @@
  Succeed: //table// one-dimensional array
--**For example:**
++E.g:
--{{code language="LUA"}}
  {
  [1]="This is the oldest message", - the first is the oldest message
@@ -1293,7 +1293,6 @@
  [n]="This is the latest message", - the last is the latest message
  }
--{{/code}}
  Failede: nil
@@ -1311,7 +1311,7 @@
  == **https request** ==
--**For example:**
++Example：
  {{code language="LUA"}}
  local json = require("json")
@@ -1367,7 +1367,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" %)
  (((
@@ -1379,6 +1379,7 @@
  )))
++
  (((
  == **Data storage area（HDW/HDX）** ==
  )))
@@ -1389,7 +1389,7 @@
 . Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
  (((
--== **Special data area (HSW/HSX)** ==
++== **8.2 Special data area (HSW/HSX)** ==
  (% class="box infomessage" %)
  (((
@@ -1509,27 +1509,17 @@
  ** addr_getstring("@W_HSW225",15)
  (((
--== **Power-down storage area (HAW/HAX)** ==
--
--The system storage area (HAW) is used for the system power-down hold registers:
--
--1. Accessed as a word, numbered in the range: "@W_HAW0"-"@W_HAW199999".
--1. Accessed by bit, the numbering range is: "@B_HAX0.0"-"@B_HAX199999.15".
--
--(% class="box infomessage" %)
--(((
--**✎Note:** HAW/HAX is a power-down hold, that is, the registers of this type can retain the data before power-down in case of power-down.
--)))
--
  = **9 General Functions** =
  )))
  (((
--== **send_sms_ira(string number, string message)** ==
++== **9.1 send_sms_ira(string number, string message)** ==
  )))
--**Function:** Use IRA character set to send English text messages
++**Function:**
++Use IRA character set to send English text messages
++
  **Parameters:**
  //number: //number (up to 32 characters, the excess will be discarded)
@@ -1543,7 +1543,7 @@
  Failed: multi
  (((
--== **send_sms_ucs2(string number, string message)** ==
++== **9.2 send_sms_ucs2(string number, string message)** ==
  )))
  **Function:**
@@ -1563,11 +1563,13 @@
  Failed: multi
  (((
--== **sms_get_state(number id)** ==
++== **9.3 sms_get_state(number id)** ==
  )))
--**Function:** Get the status of the SMS
++**Function:**
++Get the status of the SMS
++
  **parameter:**
  //id~:// SMS corresponding id
@@ -1579,11 +1579,13 @@
  Failed: multi
  (((
--== **jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
++== **9.4 jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
  )))
--**Function:** Convert data to JWT format
++**Function:**
++Convert data to JWT format
++
  **parameter:**
  //aud: //project name
@@ -1628,20 +1628,19 @@
  //key~:// the private key required for encryption
--**For example:**
++For example:
--{{code language="LUA"}}
  function jwt.main()
--local PRIVATE_KEY = [[-- Please enter the secret key--]]
++local PRIVATE_KEY = ~[~[~-~- Please enter the secret key~-~-]]
  local JWTType=0
--local payload = {{key="test1",value="test1",type="0"},
++local payload = ~{~{key="test1",value="test1",type="0"},
  {key="test",value="123122131",type="1"}}
--local head = {{ key="name",value="data",type="0"},
++local head = ~{~{ key="name",value="data",type="0"},
  {key="test2",value="test2",type="0"}}
@@ -1656,14 +1656,15 @@
  print(en)
  End
--{{/code}}
  (((
--== **convertohex(number type, number value)** ==
++== **9.5 convertohex(number type, number value)** ==
  )))
--**Function:** Convert data into hexadecimal data
++**Function:**
++Convert data into hexadecimal data
++
  **parameter:**
  //type~:// incoming data type 0:word 1:dword 2:float
@@ -1676,445 +1676,106 @@
  Failed: multi
--== **crc.init(table prarm)** ==
--
--**Function:** Initialize the CRC
--
--**Parameters:**
--
--prarm is a Lua table and needs to contain the following fields.
--
--* string prarm name, see table 9-1 for details of the parameter model name When this parameter is passed in, the default table parameters are used and the poly,init,xorout,refin,and refout passed in are invalid.
--* number prarm.width: the width, i.e. the number of CRC bits.
--* number [prarm.poly]: short for the generated item in hexadecimal. For example, CRC-32 is 0x04C11DB7, ignoring the highest bit "1", i.e., the complete generation item is 0x104C11DB7.
--* number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal.
--* number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter.
--* 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:**
--
--Success: crc object
--
--Failure: multi, error code
--
  (((
--|=Parameter model name|=poly|=init|=xorout|=refin|=refout
--|crc8|0x07|0x00|0x00|false|false
--|crc8_cdma2000|0x9B|0xFF|0x00|false|false
--|crc8_darc|0x39|0x00|0x00|true|true
--|crc8_dvb_s2|0xD5|0x00|0x00|false|false
--|crc8_ebu|0x1D|0xFF|0x00|true|true
--|crc8_i_code|0x1D|0xFD|0x00|false|false
--|crc8_itu|0x07|0x00|0x55|false|false
--|crc8_maxim|0x31|0x00|0x00|true|true
--|crc8_rohc|0x07|0xFF|0x00|true|true
--|crc8_wcdma|0x9B|0x00|0x00|true|true
--|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false
--|crc8_opensafety|0x2F|0x00|0x00|false|false
--|crc16_tms37157|0x1021|0x3791|0x0000|true|true
--|crc16_a|0x1021|0x6363|0x0000|true|true
--|crc16_riello|0x1021|0x554D|0x0000|true|true
--|crc16_ccitt_false|0x1021|0xFFFF|0x0000|false|false
--|crc16_arc|0x8005|0x0000|0x0000|true|true
--|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false
--|crc16_buypass|0x8005|0x0000|0x0000|false|false
--|crc16_cdma2000|0xC867|0xFFFF|0x0000|false|false
--|crc16_dds110|0x8005|0x800D|0x0000|false|false
--|crc16_dect_r|0x0589|0x0000|0x0001|false|false
--|crc16_dect_x|0x0589|0x0000|0x0000|false|false
--|crc16_dnp|0x3D65|0x0000|0xFFFF|true|true
--|crc16_en_13757|0x3D65|0x0000|0xFFFF|false|false
--|crc16_genibus|0x1021|0xFFFF|0xFFFF|false|false
--|crc16_maxim|0x8005|0x0000|0xFFFF|true|true
--|crc16_mcrf4xx|0x1021|0xFFFF|0x0000|true|true
--|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false
--|crc16_teledisk|0xA097|0x0000|0x0000|false|false
--|crc16_usb|0x8005|0xFFFF|0xFFFF|true|true
--|crc16_kermit|0x1021|0x0000|0x0000|true|true
--
--(% class="wikigeneratedid" %)
--Table 9-1
--
--== **crc:calc(string crcValue)** ==
--
--**Function:** Calculate CRC result
--
--**Parameter:**
--
--crcValue: the value to be calculated
--
--**Return:**
--
--Succeed: calculated result
--
--Failed: multi, error code
++== **9.6 set_network(table config)** ==
  )))
--**For example:**
++**Function:**
--{{code language="LUA"}}
--function crcTest.main()
++Set V-BOX network, take effect after restart
--local param = {
++**parameter:**
--name = '',
++//config~:// incoming network configuration table
--width = 64,
++1. connectMode: the way V-BOX connects to the server, 0: Ethernet, 1: WIFI, 2: 4G, 3: 2G, it is not allowed to be empty.
++1. ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
++1. ethernetLanIp: Set the LAN IP address. Only V-BOX with three network ports support this configuration, and other models of V-BOX do not support setting LAN IP. This item is allowed to be empty.
++1. ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
++1. ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
++1. ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
++1. ethernetGateway: The gateway can be configured when Ethernet static IP is used.
--poly = 0x42F0E1EBA9EA3693,
++1. When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
++1. If you only use Ethernet to directly connect to the PLC for communication, you do not need to configure a gateway.
--init = 0xFFFFFFFFFFFFFFFF,
++1. ethernetFirstDns: You can configure the preferred DNS server when the Ethernet static IP is used, and it is allowed to be empty. If you use the Ethernet network and do not fill in the DNS server, V-BOX will not be connected to the server.
++1. ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
++1. wifiEnable: Whether to enable WIFI, 1: enable, 0: disable, it is not allowed to be empty. If it is a model that does not include WIFI, directly disable it.
++1. wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
++1. wifiPassword: WIFI password, it is allowed to be empty.
++1. wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
++1. wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
++1. wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
++1. wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
++1. wifiFirstDns: You can configure the preferred DNS server when the WIFI static IP is used, and it is allowed to be empty. If you use the WIFI network and do not fill in the DNS server, V-BOX will not be connected to the server.
++1. wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
++1. mobileEnable: Whether to enable the mobile network, 1: enable, 0: disable, it is not allowed to be empty, if it does not include 4G models, directly disable it.
++1. mobileApnMode: Whether to manually configure the APN, 0: Use the default APN, 1: Manually configure the APN, it is not allowed to be empty.
++1. apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
++1. apnPassword: APN username, it is allowed to be empty.
++1. apnUserName: APN number, it is allowed to be empty.
++1. apnNumber: APN number, it is allowed to be empty.
--xorout = 0xFFFFFFFFFFFFFFFF,
--
--refin = 1,
--
--refout = 1
--
--}
--
--crc64,err = crc.init(param)
--
--if not crc64 then
--
--print("Crc init failed:", err)
--else
--
--crcvalue = crc64:calc("123456789")
--
--print(string.format("crc64 calc :0X%16X", crcvalue))
--
--end
--
--end
--{{/code}}
--
--= **10 Special function for V-NET** =
--
--== **normal_get_alldata()** ==
--
--**Function: **Obtain the data of all the monitoring points
--
--**Parameter: None**
--
  **Return:**
--Succeed: table two-dimensional arrays, as follows:
++Succeed: true
--* 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"
++Faied: multi
--**For example:**
++(((
++== **9.7 remote_com_start(string config)** ==
++)))
--{{code language="LUA"}}
--{
++**Function:**
--[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
++start serial port pass-through
--[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
++//config: //incoming serial port parameter configuration, JSON format
--data: the data to be written
++1. type:0, serial port pass-through
++1. port: serial port number marked on the V-BOX
++1. comtype:0-RS232, 1-RS485, 2-RS422
++1. baudrate: Baud Rate
++1. data_length: Data Bits
++1. stop_bit: Stop Bit
++1. check_bit: Check Bit
  **Return:**
--Succeed: string: The value of the monitor point before it is written
++Succeed: true
--Failed: nil
++Failed: multi
--== **normal_getdata_byname(string name)** ==
++(((
++== **9.8 remote_com_stop()** ==
++)))
--**Function:** Read the data of the monitoring point name
++**Function:**
--**Parameter:**
++close serial port pass-through
--name: the name of monitoring point
--
  **Return:**
--Succeed: string
++Succeed: true
--Failed: nil
--
--= **11 MySQL database operation** =
--
--== **luaMySql.init(string sourcename, string username, string password, string host, number port, string character)** ==
--
--**Function:** Configure database connection parameters
--
--**Parameter:**
--
--sourcename: the name of database
--
--username: the username of the connection
--
--password: the password of the connection
--
--host: the host name of the connection
--
--port: the host port of the connection
--
--character: the character set of the connection
--
--**Return:**
--
--Succeed: string
--
  Failed: multi
--== **luaMySql.exec(string statement)** ==
++(((
++== **9.9 remote_com_state()** ==
++)))
--**Function:** Execute the given SQL statement without returning the result set (add, delete, change)
++**Function:**
--**Parameter:**
++query the serial port pass-through status and pass-through server domain name and port
--statement: the given SQL statement
--
  **Return:**
--Succeed: status: returns the number of rows affected by SQL statement execution.
++Succeed:
--Failed: nil, errorString
++1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
++1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
--== **luaMySql.execWithResult(string statement)** ==
--
--**Function:** Execute the given SQL statement returning the result set (check)
--
--**Parameter:**
--
--statement: the given SQL statement
--
--**Return:**
--
--Succeed: table: returns the result set
--
--Failed: nil, errorString
--
--**For example:**
--
--{{code language="LUA"}}
--mysql = require"mysqlclient"
--
--function DataInitRight()
--
--local dbName = "db_lua1"
--
--local user = "root"
--
--local pwd = "123456"
--
--local host = "192.168.56.186"
--
--local port = 3306
--local character = "UTF8"
--
--mysql.init(dbName, user, pwd, host, port, character)
--
--end
--
--function ExecFunc()
--
--status, errorString = mysql.exec("delete from tb_lua1 where mykey =
--
--10;")
--
--if nil == status then
--
--print("ExecFunc() error:", errorString)
--
--return -1
--
--else
--
--print("the number of rows affected by the command:", status)
--
--end
--
--return 0
--
--end
--
--function ExecWithResultFunc()
--
--status, errorString = mysql.execWithResult("select * from tb_lua1;")
--
--if nil == status then
--
--print("ExecWithResultFunc() error:", errorString)
--
--return -1
--
--else
--
--print("ExecWithResultFunc()
--
--success
--
--: status
--
--type
--
--=
--
--",
--
--type(status))
--
--print("ExecWithResultFunc() success : status len = ", #status)
--
--local num = #status
--
--local i = 1
--
--if num > 0 then
--
--for i = 1, num, 1 do
--
--local var = string.format("select result[%d] :mykey = %d,
--
--value = %s", i, status[i].mykey, status[i].value)
--
--print(var)
--
--end
--
--end
--
--print("---------------")
--
--end
--
--return 0
--end
--
--function luaMysql_apiTest.main()
--
--print("script running ...")
--
--DataInitRight()
--
----use exec demo
--
--if ExecFunc() < 0 then
--
--return
--
--end
--
----use execWithResult demo
--
--if ExecWithResultFunc() < 0 then
--
--return
--
--end
--
--print("script running success")
--
--end
--{{/code}}
--
--= **12 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}}
++Failed: multi

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents