Changes for page 01 Lua Functions

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

From 5.7 to 5.6 From 9.2 to 9.1

From version 9.1

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

Change comment: Renamed from xwiki:V-BOX.V-Net.1\.User Manual.04 Lua Script.01 Lua Functions.WebHome

To version 5.7

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

Change comment: (Autosaved)

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -106,6 +106,8 @@
  (((
  = **2 Address operation** =
++
++
  )))
  |=16-bit data formal|=HLword|=32-bit data formal|=HLword|= 64-bit data formal|=HLword
@@ -138,17 +138,20 @@
  43218765
  )))|10
-- Table 2-1
++* If HLword enters any other value, it will be treated as invalid.
--(% class="box infomessage" %)
--(((
--**✎Note: **If HLword enters any other value, it will be treated as invalid.
--)))
++                      Demo:  Reads a 32-bit floating-point number at position D0 of PLC
--== **addr_getshort(string addr[, number type, number hlword])** ==
--**Function:** Read 16-bit signed decimal address
++[[image:企业微信截图_20210506180640.png||height="301" width="600" class="img-thumbnail"]]
++
++== **2.1 addr_getshort(string addr[, number type, number hlword])** ==
++
++**Function:**
++
++Read 16-bit signed decimal address
++
  **Parameters:**
  //addr//: address
@@ -166,11 +166,13 @@
  Failed: multi
  (((
--== **addr_setshort(string addr, number num[, number type, number hlword])** ==
++== **2.2 addr_setshort(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:** Write 16-bit signed decimal address
++**Function:**
++Write 16-bit signed decimal address
++
  **Parameters:**
  //addr//: address
@@ -188,11 +188,13 @@
  Failed: multi
  (((
--== **addr_getword(string addr[, number type, number hlword])** ==
++== **2.3 addr_getword(string addr[, number type, number hlword])** ==
  )))
--**Function:** Read 16-bit unsigned decimal address
++**Function:**
++Read 16-bit unsigned decimal address
++
  **Parameters:**
  //addr//: address
@@ -208,11 +208,13 @@
  Failed: multi
  (((
--== **addr_setword(string addr, number num[, number type, number hlword])** ==
++== **2.4 addr_setword(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**Write 16-bit unsigned decimal address
++**Function:**
++Write 16-bit unsigned decimal address
++
  **Parameters:**
  //addr//: address
@@ -230,11 +230,13 @@
  Failed: multi
  (((
--== **addr_getint(string addr[, number type, number hlword])** ==
++== **2.5 addr_getint(string addr[, number type, number hlword])** ==
  )))
--**Function:** Read 32-bit signed decimal address
++**Function:**
++Read 32-bit signed decimal address
++
  **Parameters:**
  //addr//: address
@@ -250,11 +250,13 @@
  Failed: multi
  (((
--== **addr_setint(string addr, number num[, number type, number hlword])** ==
++== **2.6 addr_setint(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:** Write 32-bit signed decimal address
++**Function:**
++Write 32-bit signed decimal address
++
  **Parameters:**
  //addr//: address
@@ -272,11 +272,13 @@
  Failed: multi
  (((
--== **addr_getdword(string addr[, number type, number hlword])** ==
++== **2.7 addr_getdword(string addr[, number type, number hlword])** ==
  )))
--**Function:** Read 32-bit unsigned decimal address
++**Function:**
++Read 32-bit unsigned decimal address
++
  **Parameters:**
  //addr//: address
@@ -292,11 +292,13 @@
  Failed: multi
  (((
--== **addr_setdword(string addr, number num[, number type, number hlword])** ==
++== **2.8 addr_setdword(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:** Write 32-bit unsigned decimal address
++**Function:**
++Write 32-bit unsigned decimal address
++
  **Parameters:**
  //addr//: address
@@ -314,11 +314,13 @@
  Failed: multi
  (((
--== **addr_getbit(string addr[, number type])** ==
++== **2.9 addr_getbit(string addr[, number type])** ==
  )))
--**Function:** Read a bit of the register address
++**Function:**
++Read a bit of the register address
++
  **Parameters:**
  //addr//: address
@@ -334,11 +334,13 @@
  Failed: multi
  (((
--== **addr_setbit(string addr, number num[, number type])** ==
++== **2.10 addr_setbit(string addr, number num[, number type])** ==
  )))
--**Function:** Write a bit of the register address
++**Function:**
++Write a bit of the register address
++
  **Parameters:**
  //addr//: address
@@ -356,11 +356,13 @@
  Failed: multi
  (((
--== **addr_getfloat(string addr[, number type, number hlword])** ==
++== **2.11 addr_getfloat(string addr[, number type, number hlword])** ==
  )))
--**Function:** Read 32-bit floating address
++**Function:**
++Read 32-bit floating address
++
  **Parameters:**
  //addr//: address
@@ -376,11 +376,13 @@
  Failed: multi
  (((
--== **addr_setfloat(string addr, number num[, number type, number hlword])** ==
++== **2.12 addr_setfloat(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:** Write 32-bit floating address
++**Function:**
++Write 32-bit floating address
++
  **Parameters:**
  //addr//: address
@@ -398,11 +398,13 @@
  Failed: multi
  (((
--== **addr_getdouble(string addr[, number type, number hlword])** ==
++== **2.13 addr_getdouble(string addr[, number type, number hlword])** ==
  )))
--**Function:** Read 64-bit floating address
++**Function:**
++Read 64-bit floating address
++
  **Parameters:**
  //addr//: address
@@ -418,11 +418,13 @@
  Failed: multi
  (((
--== **addr_setdouble(string addr, number num[, number type, number hlword])** ==
++== **2.14 addr_setdouble(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:** Write 64-bit floating address
++**Function:**
++Write 64-bit floating address
++
  **Parameters:**
  addr: address
@@ -440,11 +440,13 @@
  Failed: multi
  (((
--== **addr_getstring(string addr, number length[, number type, number hlbyte])** ==
++== **2.15 addr_getstring(string addr, number length[, number type, number hlbyte])** ==
  )))
--**Function:** Read the specified length string from address
++**Function:**
++Read the specified length string from address
++
  **Parameters:**
  //addr//: address
@@ -462,11 +462,13 @@
  Failed: multi
  (((
--== **addr_setstring(string addr, string str[, number type, number hlbyte])** ==
++== **2.16 addr_setstring(string addr, string str[, number type, number hlbyte])** ==
  )))
--**Function:** Write the specified length string to address
++**Function:**
++Write the specified length string to address
++
  **Parameters:**
  //addr//: address
@@ -484,11 +484,13 @@
  Failed: multi
  (((
--== **addr_bmov(string dst, string src, number length)** ==
++== **2.17 addr_bmov(string dst, string src, number length)** ==
  )))
--**Function:** Copy data from source address to destination address
++**Function:**
++Copy data from source address to destination address
++
  **Parameters:**
  //dst//: destination address
@@ -504,11 +504,13 @@
  **Failed: multi**
  (((
--== **addr_fill(string addr, number num, number length)** ==
++== **2.18 addr_fill(string addr, number num, number length)** ==
  )))
--**Function:** Write the same value to consecutive addresses
++**Function:**
++Write the same value to consecutive addresses
++
  **Parameters:**
  //addr//: address
@@ -524,11 +524,13 @@
  Failed: multi
  (((
--== **addr_newnoaddr(string addr, number offset)** ==
++== **2.19 addr_newnoaddr(string addr, number offset)** ==
  )))
--**Function:** Offset address value relative to //addr//
++**Function:**
++Offset address value relative to //addr//
++
  **Parameters:**
  //addr//: address
@@ -542,11 +542,13 @@
  Failed: multi
  (((
--== **addr_newstataddr(string addr, number offset)** ==
++== **2.20 addr_newstataddr(string addr, number offset)** ==
  )))
--**Function:** Offset station number relative to //addr //station number
++**Function:**
++Offset station number relative to //addr //station number
++
  **Parameters:**
  //addr//: address
@@ -559,10 +559,12 @@
  Failed: multi
--== **addr_gethex64(string addr[, number type, number hlword])** ==
++== **2.21 addr_gethex64(string addr[, number type, number hlword])** ==
--**Function:** Read 64-bit hexadecimal numbers
++**Function:**
++Read 64-bit hexadecimal numbers
++
  **Parameters:**
  //addr//: address
@@ -577,10 +577,12 @@
  Failed: multi
--== **addr_sethex64(string addr, number num[, number type, number hlword])** ==
++== **2.22 addr_sethex64(string addr, number num[, number type, number hlword])** ==
--**Function:** Write 64-bit hexadecimal addresses
++**Function:**
++Write 64-bit hexadecimal addresses
++
  **Parameters:**
  //addr//: address
@@ -601,19 +601,18 @@
  Operations on the serial port such as read, write, etc. must use ':' for full mode calls, ie operations on an open serial object.
--**Serial port name and mode**
++**Serial port name and mode:**
  The serial port configured in the communication configuration window cannot be configured again using the script. RS232 and RS458 (or RS422) can be used simultaneously, but RS422 and RS485 are mutually exclusive.For example, when the communication port is configured with COM1-485, the script can only open COM1-232, but not COM1-485/422. Similarly, when the communication port is configured with COM2-485, the script can only open COM2-232, but not COM2-485.
--Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below.
++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:**
@@ -629,11 +629,13 @@
 . When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.
  (((
--== **serial.open(table setup)** ==
++== **3.1 serial.open(table setup)** ==
  )))
--**Function:** Enable one serial port
++**Function:**
++Enable one serial port
++
  **Parameters:**
  //Setup// is a Lua table; it needs to contain the following fields
@@ -667,13 +667,17 @@
  Failed: multi
  (((
--== **serial.close(serial obj)** ==
++== **3.2 serial.close(serial obj)** ==
  )))
--**Function:** Disable the serial port
++**Function:**
--**Parameters: **//Obj //is the object returned by serial.open
++Disable the serial port
++**Parameters:**
++
++//Obj //is the object returned by serial.open
++
  **Return：**
  Succeed: true
@@ -681,11 +681,13 @@
  Failed: multi
  (((
--== **serial:read(number bytes[, number timeout])** ==
++== **3.3 serial:read(number bytes[, number timeout])** ==
  )))
--**Function:** Read the specified byte length serial port data
++**Function:**
++Read the specified byte length serial port data
++
  **Parameters:**
  //bytes//: number of bytes
@@ -699,13 +699,15 @@
  Failed: multi
  (((
--== **serial:write(string data)** ==
++== **3.4 serial:write(string data)** ==
  )))
--**Function:** Write the specified byte length to serial port data
++**Function:**
--**Parameters: **
++Write the specified byte length to serial port data
++**Parameters:**
++
  //data//: serial port data
  **Return：**
@@ -715,11 +715,13 @@
  Failed: multi
  (((
--== **serial:flush([number flag])** ==
++== **3.5 serial:flush([number flag])** ==
  )))
--**Function:** Clear the serial port buffer
++**Function:**
++Clear the serial port buffer
++
  **Parameters:**
  //[flag=2]// clear option: 0: read, 1: write, 2: read-write
@@ -731,13 +731,17 @@
  Failed: multi
  (((
--== **serial:close()** ==
++== **3.6 serial:close()** ==
  )))
--**Function:** Close the serial port object
++**Function:**
--**Parameters:** None
++Close the serial port object
++**Parameters:**
++
++None
++
  **Return：**
  Succeed: true
@@ -754,10 +754,12 @@
  **QoS value:**
--* 0: Only push messages once, messages may be lost or duplicated. It can be used for environmental sensor data, it doesn't matter if lose a record, because there will be a second push message soon. This method is mainly used for normal APP push, but if the user smart device is not connected when the message is pushed, the message will be discarded, and the smart device will not be received when it is networked again.
--* 1: The message is delivered at least once, but the message may be delivered repeatedly.
--* 2: The message was delivered exactly once. This level can be used in a billing system. In a billing system, repeated or missing messages can lead to incorrect results. This highest quality message push service can also be used for instant messaging APP pushes, ensuring that users only receive messages once.
++0: Only push messages once, messages may be lost or duplicated. It can be used for environmental sensor data, it doesn't matter if lose a record, because there will be a second push message soon. This method is mainly used for normal APP push, but if the user smart device is not connected when the message is pushed, the message will be discarded, and the smart device will not be received when it is networked again.
++1: The message is delivered at least once, but the message may be delivered repeatedly.
++
++2: The message was delivered exactly once. This level can be used in a billing system. In a billing system, repeated or missing messages can lead to incorrect results. This highest quality message push service can also be used for instant messaging APP pushes, ensuring that users only receive messages once.
++
  **Retain flag:**
 : not reserved;
@@ -765,11 +765,13 @@
 : reserved
  (((
--== **mqtt.create(string serverurl, string clientid)** ==
++== **4.1 mqtt.create(string serverurl, string clientid)** ==
  )))
--**Function:** Create an MQTT object
++**Function:**
++Create an MQTT object
++
  **Parameters:**
  //serverurl //Server url
@@ -791,13 +791,17 @@
  Failed: multi
  (((
--== **mqtt.close(mqtt obj)** ==
++== **4.2 mqtt.close(mqtt obj)** ==
  )))
--**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)
++**Function:**
--**Parameters: **//Obj //is the objeced returned by mqtt.create
++Close the specified MQTT object (if the connected server will be disconnected automatically)
++**Parameters:**
++
++//Obj //is the objeced returned by mqtt.create
++
  **Return：**
  Succeed: true
@@ -805,25 +805,32 @@
  Failed: multi
  (((
--== **mqtt:connect(table conn[, table lwt, table cart])** ==
++== **4.3 mqtt:connect(table conn[, table lwt, table cart])** ==
  )))
--**Function:**Establish a connection to the server
++**Function:**
++Establish a connection to the server
++
  **Parameters:**
  //conn //is a Lua table and needs to contain the following fields
--* //string conn.username//, user name
--* //string conn.password//, password
--* //number [conn.netway=0]//, networking method, if set error number will use Ethernet method
--** 0: Ethernet
--** 1: WIFI
--** 2: 4G
--** 3: 2G
--* //number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
--* //number [conn.cleansession=1]//, empty the session as described below:
++//string conn.username//, user name
++//string conn.password//, password
++
++//number [conn.netway=0]//, networking method, if set error number will use Ethernet method
++
++* 0: Ethernet
++* 1: WIFI
++* 2: 4G
++* 3: 2G
++
++//number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
++
++//number [conn.cleansession=1]//, empty the session as described below:
++
  This function is used to control the behavior when connecting and disconnecting, and the client and server will retain the session information. This information is used to guarantee "at least once" and "accurately once" delivery, as well as the subject of the client subscription, the user can choose to keep or ignore the session message, set as follows:
  * 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.
@@ -831,11 +831,14 @@
  //lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields
--* //string lwt.topic//, topic
--* //string lwt.message//, message
--* //number [lwt.qos=0]//, qos value
--* //number [lwt.retain=0]//, retain flag
++//string lwt.topic//, topic
++//string lwt.message//, message
++
++//number [lwt.qos=0]//, qos value
++
++//number [lwt.retain=0]//, retain flag
++
  **Return：**
  Succeed: true
@@ -843,13 +843,17 @@
  Failed: multi
  (((
--== **mqtt:disconnect([number timeout])** ==
++== **4.4 mqtt:disconnect([number timeout])** ==
  )))
--**Function:** Disconnect from the MQTT server
++**Function:**
--**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
++Disconnect from the MQTT server
++**Parameters:**
++
++//[timeout=10000] //Disconnect waiting timeout, in milliseconds
++
  **Return：**
  Succeed: true
@@ -857,13 +857,17 @@
  Failed: multi
  (((
--== **mqtt:isconnected()** ==
++== **4.5 mqtt:isconnected()** ==
  )))
--**Function:** Test whether or not a client is currently connected to the MQTT server
++**Function:**
--**Parameters:** None
++Test whether or not a client is currently connected to the MQTT server
++**Parameters:**
++
++None
++
  **Return：**
  Succeed: true ~-~-Connected
@@ -871,11 +871,13 @@
  Failed: false ~-~- Unconnected and other unknowns
  (((
--== **mqtt:subscribe(string topic, number qos)** ==
++== **4.6 mqtt:subscribe(string topic, number qos)** ==
  )))
--**Function: **Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
++**Function:**
++Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
++
  **Parameters:**
  //topic//, topic name
@@ -889,11 +889,13 @@
  Failed: multi
  (((
--== **mqtt:unsubscribe(string topic)** ==
++== **4.7 mqtt:unsubscribe(string topic)** ==
  )))
--**Function:** Unsubscribe topic
++**Function:**
++Unsubscribe topic
++
  **Parameters:**
  //topic//, topic name
@@ -905,11 +905,13 @@
  Failed: multi
  (((
--== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
++== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
  )))
--**Function:** Publish message
++**Function:**
++Publish message
++
  **Parameters:**
  //topic//, topic name
@@ -929,13 +929,17 @@
  Failed: multi
  (((
--== **mqtt:close()** ==
++== **4.9 mqtt:close()** ==
  )))
--**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)
++**Function:**
--**Parameters:** None
++Close the mqtt object (the connection to the server will be automatically disconnected)
++**Parameters:**
++
++None
++
  **Return：**
  Succeed: true
@@ -943,11 +943,13 @@
  Failed: multi
  (((
--== **mqtt:on(string method, function callback)** ==
++== **4.10 mqtt:on(string method, function callback)** ==
  )))
--**Function:** Register event callback function
++**Function:**
++Register event callback function
++
  **Parameters:**
  //method//, It can be message/arrived/offline, these 3 types of events
@@ -960,17 +960,20 @@
  Parameter:
--* //Topic//, topic name
--* //Message//, content
++//Topic//, topic name
--**2."arrived" is published by publish, this function will be called after the publication arrives**
++//Message//, content
++**2.**"arrived" is published by publish, this function will be called after the publication arrives
++
  //Callback// prototype~:// function ()//
--Parameter: None
++Parameter:
--**3.This function will be called after the "offline" connection is lost**
++None
++**3.**This function will be called after the "offline" connection is lost
++
  //Callback// prototype~:// function (string cause)//
  Parameter:
@@ -984,13 +984,17 @@
  Failed: multi
  (((
--== **mqtt:setup_cfg()** ==
++== **4.11 mqtt:setup_cfg()** ==
  )))
--**Function:** Cloud mode interface, to obtain MQTT information configured by the cloud platform
++**Function:**
--**Parameters:** None
++Cloud mode interface, to obtain MQTT information configured by the cloud platform
++**Parameters:**
++
++None
++
  **Return:**
  //serverurl, clientid, conn, lwt, cart //(5 returns, respectively, server address, client ID, connection table, last word table, certificate table)
@@ -1008,27 +1008,39 @@
  Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table.
  (((
--== **json.encode( lua_object )** ==
++== **5.1 json.encode( lua_object )** ==
  )))
--**Function: **Convert lua data type to json string
++**Function:**
--**Parameters: **Lua data type (including boolean, number, string, table)
++Convert lua data type to json string
--**Return：** Json format string
++**Parameters:**
++Lua data type (including boolean, number, string, table)
++
++**Return：**
++
++Json format string
++
  (((
--== **json.decode(string json_string)** ==
++== **5.2 json.decode(string json_string)** ==
  )))
--**Function:** Convert json string to lua data type
++**Function:**
--**Parameters: **//json_string//, string of json data structure
++Convert json string to lua data type
--**Return: **Lua data type
++**Parameters:**
++//json_string//, string of json data structure
++
++**Return：**
++
++Lua data type
++
  (((
--== **json.null** ==
++== **5.3 json.null** ==
  )))
  **Function:**
@@ -1035,24 +1035,32 @@
  This method is used when assembling json data, which is equivalent to null in json. If the user directly uses json.null() to return the address of the function, it must be valid with the use of encode.
--**Parameters:** None
++**Parameters:**
--**Return: **None
++None
++**Return：**
++
++None
++
  = **6 Cloud mode** =
  The cloud interface is only used in cloud mode, and V-NET mode is not available.
  (((
--== **bns_get_alldata()** ==
++== **6.1 bns_get_alldata()** ==
  )))
--**Function:** Obtain all monitoring points (point table) data configured by the end user
++**Function:**
--**✎Note: **Assuming there are timing scripts A and B with a period of 1 second, if this function is called in script A, the data will not be obtained if called in script B
++Obtain all monitoring points (point table) data configured by the end user
--**Parameters:** None
++Note: Assuming there are timing scripts A and B with a period of 1 second, if this function is called in script A, the data will not be obtained if called in script B
++**Parameters:**
++
++None
++
  **Return:**
  Succeed: table two-dimensional array, the structure is as follows
@@ -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,15 +1080,16 @@
  }
--Failed: table empty table
--{{/code}}
++Failed: //table// empty table
  (((
--== **bns_get_config(string from)** ==
++== **6.2 bns_get_config(string from)** ==
  )))
--**Function:** Obtain custom configuration parameters with the specified from type
++**Function:**
++Obtain custom configuration parameters with the specified from type
++
  **parameter:**
  from type, there are the following two categories, the string must be all lowercase
@@ -1106,11 +1106,13 @@
  Failed~:// table// empty table
  (((
--== **bns_get_data(string name, string data)** ==
++== **6.3 bns_get_data(string name, string data)** ==
  )))
--**Function:**write data to the name of the monitoring point
++**Function:**
++write data to the name of the monitoring point
++
  **parameter:**
  //name //The name of the monitoring point
@@ -1124,7 +1124,7 @@
  Failed: nil
  (((
--== **bns_get_data(string name)** ==
++== **6.4 bns_get_data(string name)** ==
  )))
  **Function:**
@@ -1142,13 +1142,17 @@
  Failed: nil
  (((
--== **bns_get_datadesc()** ==
++== **6.5 bns_get_datadesc()** ==
  )))
--**Function: **Obtain all configured communication ports and monitoring point information
++**Function:**
--**Parameters:** None
++Obtain all configured communication ports and monitoring point information
++**Parameters:**
++
++None
++
  **Return:**
  Succeed: table three-dimensional array, the structure is as follows
@@ -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,18 +1199,21 @@
  ...n communication ports and so on
  }
--{{/code}}
  Failed~:// table// empty table
  (((
--== **bns_get_machineinfo()** ==
++== **6.6 bns_get_machineinfo()** ==
  )))
--**Function:** get machine information
++**Function:**
--**Parameters:** None
++get machine information
++**Parameters:**
++
++None
++
  **Return:**
  Succeed: 3 string type results (model, machine code, software version)
@@ -1218,11 +1218,13 @@
  Failed: nil
  (((
--== **bns_get_groupdata(string name)** ==
++== **6.7 bns_get_groupdata(string name)** ==
  )))
--**Function:** Get all monitoring point data under the specified group name
++**Function:**
++Get all monitoring point data under the specified group name
++
  **parameter:**
  //Name  // group name
@@ -1234,13 +1234,17 @@
  Failed: //table// empty table
  (((
--== **bns_get_groupdesc()** ==
++== **6.8 bns_get_groupdesc()** ==
  )))
--**Function:** Get all group information
++**Function:**
--**Parameters:** None
++Get all group information
++**Parameters:**
++
++None
++
  **Return:**
  Succeed: //table// two-dimensional array, the structure is as follows
@@ -1254,13 +1254,17 @@
  Failed: //table  // empty table
  (((
--== **bns_get_onecache(string msg)** ==
++== **6.9 bns_get_onecache(string msg)** ==
  )))
--**Function:** Save a message to the cache file, which can be stored after power failure. Store up to 2000 items, delete the old and save the new in a rolling manner when it is full.
++**Function:**
--**Parameters: **//msg// String
++Save a message to the cache file, which can be stored after power failure. Store up to 2000 items, delete the old and save the new in a rolling manner when it is full.
++**Parameters:**
++
++//msg// String
++
  **Return:**
  Succeed: true
@@ -1268,20 +1268,23 @@
  Failed: nil
  (((
--== **bns_get_allcache()** ==
++== **6.10 bns_get_allcache()** ==
  )))
--**Function:** Get all the cached content (once the internal cache file will be emptied)
++**Function:**
--**Parameters:** None
++Get all the cached content (once the internal cache file will be emptied)
++**Parameters:**
++
++None
++
  **Return:**
  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
@@ -1304,232 +1304,194 @@
  Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it.
  (((
--== **http request** ==
++== **7.1 http request** ==
  )))
  [[http:~~/~~/w3.impa.br/~~~~diego/software/luasocket/http.html#request>>url:http://w3.impa.br/~~diego/software/luasocket/http.html#request]]
--== **https request** ==
++(((
++= **8 Internal register** =
++)))
--**For example:**
++The internal registers of the box are divided into bit addresses and word addresses, which can be accessed in two ways (taking HDW as an example):
--{{code language="LUA"}}
--local json = require("json")
++**~1. **Access by word, prefix @W_HDW,
--local https = require("https")
++For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
--functions https_demo.main()
++**2. **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.
--local url = "https://XXXXXXXXXXXXXXXXXXXXXXXXXX"
++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.
--local body = {}
++**✎Note: **
--body["XXXXXX"] = "XXXXX"
++**~1. **The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
--body["XXXXXXX"] = "XXXXXXXXXXX"
++For example, @B_HDX1020.12 is to access the 13th bit of the 1020th word. The value of this bit is the same as the word obtained by @W_HDW001020. The 13th bit of this word is actually the same bit as @B_HDX1020.12.
--local bodyJson = json.encode(body)
++**2.**The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
--local header = {}
++(((
++== **8.1 Data storage area（HDW/HDX）** ==
++)))
--header["content-type"] = "application/json"
++The system storage area (HDW) of the V-BOX is used to store temporary data:
--local result_table, code, headers, status = https.request(url,
++~1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
--bodyJson)
++2. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
--if code == 200 then
++(((
++== **8.2 Special data area (HSW/HSX)** ==
++)))
--print("https suc")
++**✎Note: **
--return true
++//HSW// is a system special register, so please refer to the system special register table during use. Do not use addresses that are not mentioned in the table, and use the addresses stated in the table with caution (example: restart ("@W_HSW0") Writing a value of 1 will cause V-BOX to restart).
--else
++//Without any conditions. Direct use ("@W_HSW0") will cause the V-BOX to restart continuously.// When using ("@W_HSW0") address, please add judgment conditions, such as: connection to MQTT fails, there is no network, the value of a PLC address meets the condition or counts to a certain value.
--print("https fail")
++1.The system data area (HSW) of the box is used for system special registers (system reserved). Use //addr_getword// to obtain the following register information:
--return nil
++(% class="table-bordered" %)
++|address|function|Read and write status: read only, write only, read and write
++|@W_HSW0|restart|read and write
++|@W_HSW1|Box time: year|read and write
++|@W_HSW2|Box time: month|read and write
++|@W_HSW3|Box time: day|read and write
++|@W_HSW4|Box time: hour|read and write
++|@W_HSW5|Box time: minute|read and write
++|@W_HSW6|Box time: second|read and write
++|@W_HSW7|Box time: week|read and write
++|@W_HSW8|Ethernet IP1|read only
++|@W_HSW9|Ethernet IP2|read only
++|@W_HSW10|Ethernet IP3|read only
++|@W_HSW11|Ethernet IP4|read only
++|@W_HSW12|Ethernet Mask 1|read only
++|@W_HSW13|Ethernet Mask 2|read only
++|@W_HSW14|Ethernet Mask 3|read only
++|@W_HSW15|Ethernet Mask 4|read only
++|@W_HSW16|Ethernet Gateway 1|read only
++|@W_HSW17|Ethernet Gateway 2|read only
++|@W_HSW18|Ethernet Gateway 3|read only
++|@W_HSW19|Ethernet Gateway 4|read only
++|@W_HSW21|Ethernet MAC1|read only
++|@W_HSW22|Ethernet MAC2|read only
++|@W_HSW23|Ethernet MAC3|read only
++|@W_HSW24|Ethernet MAC4|read only
++|@W_HSW25|Ethernet MAC3|read only
++|@W_HSW26|Ethernet MAC4|read only
++|@W_HSW128|WIFI IP1|read only
++|@W_HSW129|WIFI IP2|read only
++|@W_HSW130|WIFI IP3|read only
++|@W_HSW131|WIFI IP4|read only
++|@W_HSW132|WIFI Mask 1|read only
++|@W_HSW133|WIFI Mask 2|read only
++|@W_HSW134|WIFI Mask 3|read only
++|@W_HSW135|WIFI Mask 4|read only
++|@W_HSW136|WIFI Gateway 1|read only
++|@W_HSW137|WIFI Gateway 2|read only
++|@W_HSW138|WIFI Gateway 3|read only
++|@W_HSW139|WIFI Gateway 4|read only
++|@W_HSW140|WIFI MAC1|read only
++|@W_HSW141|WIFI MAC2|read only
++|@W_HSW142|WIFI MAC3|read only
++|@W_HSW143|WIFI MAC4|read only
++|@W_HSW144|WIFI MAC5|read only
++|@W_HSW145|WIFI MAC6|read only
++|@W_HSW146|WIFI Signal value|read only
++|@W_HSW148|4G IP1|read only
++|@W_HSW149|4G IP2|read only
++|@W_HSW150|4G IP3|read only
++|@W_HSW151|4G IP4|read only
++|@W_HSW152|4G Mask 1|read only
++|@W_HSW153|4G Mask 2|read only
++|@W_HSW154|4G Mask 3|read only
++|@W_HSW155|4G Mask 4|read only
++|@W_HSW156|4G Gateway 1|read only
++|@W_HSW157|4G Gateway 2|read only
++|@W_HSW158|4G Gateway 3|read only
++|@W_HSW159|4G Gateway 4|read only
++|@W_HSW160|4G MAC1|read only
++|@W_HSW161|4G MAC2|read only
++|@W_HSW162|4G MAC3|read only
++|@W_HSW163|4G MAC4|read only
++|@W_HSW164|4G MAC5|read only
++|@W_HSW165|4G MAC6|read only
++|@W_HSW166|4G Signal value|read only
--end
++2. Other
--end
--{{/code}}
++2.1 Access password: addr_getstring("@W_HSW27", 16)
--(((
--= **8 Internal register** =
--)))
++2.2 Machine code: addr_getstring("@W_HSW60", 64)
--The internal registers of the box are divided into bit addresses and word addresses, which can be accessed in two ways (taking HDW as an example):
++2.3 Positioning method (@W_HSW167): (read only)
--**Access by word, prefix @W_HDW.**
++~1. Latitude and longitude
--For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
++Longitude: addr_getdouble("@W_HSW168") (read only)
--**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.**
++Latitude: addr_getdouble("@W_HSW172") (read only)
--**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.
++2. Base station positioning
--(% class="box infomessage" %)
--(((
--**✎Note: **
++LAC: addr_getdword("@W_HSW168") (read only)
--* The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
--** For example, @B_HDX1020.12 is to access the 13th bit of the 1020th word. The value of this bit is the same as the word obtained by @W_HDW001020. The 13th bit of this word is actually the same bit as @B_HDX1020.12.
--* The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
--)))
++CI: addr_getdword("@W_HSW172") (read only)
++2.4 Convert base station to latitude and longitude via API
--(((
--== **Data storage area（HDW/HDX）** ==
--)))
++Longitude: addr_getdouble("@W_HSW187") (read only)
--The system storage area (HDW) of the V-BOX is used to store temporary data:
++Latitude: addr_getdouble("@W_HSW183") (read only)
--1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
--1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
++2.5 Operator information: addr_getdword("@W_HSW181") (read only)
--(((
--== **Special data area (HSW/HSX)** ==
++2.6 Networking mode: addr_getword("@W_HSW177") (read only)
--(% class="box infomessage" %)
--(((
--**✎Note: **
++0: Ethernet, 1: WIFI, 2: 4G, 3: 2G
--* //HSW// is a system special register, so please refer to the system special register table during use. Do not use addresses that are not mentioned in the table, and use the addresses stated in the table with caution (example: restart ("@W_HSW0") Writing a value of 1 will cause V-BOX to restart).
--* //Without any conditions. Direct use ("@W_HSW0") will cause the V-BOX to restart continuously.// When using ("@W_HSW0") address, please add judgment conditions, such as: connection to MQTT fails, there is no network, the value of a PLC address meets the condition or counts to a certain value.
--)))
--)))
++2.7 Map fence flag: addr_getword("@W_HSW178") (read only)
--The system data area (HSW) of the box is used for system special registers (system reserved). Use //addr_getword// to obtain the following register information:
++0: No map fence is drawn
--(% class="table-bordered" %)
--|=(% style="width: 151px;" %)address|=(% style="width: 169px;" %)function|=(% style="width: 456px;" %)Read and write status: read only, write only, read and write
--|(% style="width:151px" %)@W_HSW0|(% style="width:169px" %)restart|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW1|(% style="width:169px" %)Box time: year|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW2|(% style="width:169px" %)Box time: month|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW3|(% style="width:169px" %)Box time: day|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW4|(% style="width:169px" %)Box time: hour|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW5|(% style="width:169px" %)Box time: minute|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW6|(% style="width:169px" %)Box time: second|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW7|(% style="width:169px" %)Box time: week|(% style="width:456px" %)read and write
--|(% style="width:151px" %)@W_HSW8|(% style="width:169px" %)Ethernet IP1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW9|(% style="width:169px" %)Ethernet IP2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW10|(% style="width:169px" %)Ethernet IP3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW11|(% style="width:169px" %)Ethernet IP4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW12|(% style="width:169px" %)Ethernet Mask 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW13|(% style="width:169px" %)Ethernet Mask 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW14|(% style="width:169px" %)Ethernet Mask 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW15|(% style="width:169px" %)Ethernet Mask 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW16|(% style="width:169px" %)Ethernet Gateway 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW17|(% style="width:169px" %)Ethernet Gateway 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW18|(% style="width:169px" %)Ethernet Gateway 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW19|(% style="width:169px" %)Ethernet Gateway 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW21|(% style="width:169px" %)Ethernet MAC1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW22|(% style="width:169px" %)Ethernet MAC2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW23|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW24|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW25|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW26|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW128|(% style="width:169px" %)WIFI IP1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW129|(% style="width:169px" %)WIFI IP2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW130|(% style="width:169px" %)WIFI IP3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW131|(% style="width:169px" %)WIFI IP4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW132|(% style="width:169px" %)WIFI Mask 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW133|(% style="width:169px" %)WIFI Mask 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW134|(% style="width:169px" %)WIFI Mask 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW135|(% style="width:169px" %)WIFI Mask 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW136|(% style="width:169px" %)WIFI Gateway 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW137|(% style="width:169px" %)WIFI Gateway 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW138|(% style="width:169px" %)WIFI Gateway 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW139|(% style="width:169px" %)WIFI Gateway 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW140|(% style="width:169px" %)WIFI MAC1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW141|(% style="width:169px" %)WIFI MAC2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW142|(% style="width:169px" %)WIFI MAC3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW143|(% style="width:169px" %)WIFI MAC4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW144|(% style="width:169px" %)WIFI MAC5|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW145|(% style="width:169px" %)WIFI MAC6|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW146|(% style="width:169px" %)WIFI Signal value|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW148|(% style="width:169px" %)4G IP1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW149|(% style="width:169px" %)4G IP2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW150|(% style="width:169px" %)4G IP3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW151|(% style="width:169px" %)4G IP4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW152|(% style="width:169px" %)4G Mask 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW153|(% style="width:169px" %)4G Mask 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW154|(% style="width:169px" %)4G Mask 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW155|(% style="width:169px" %)4G Mask 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW156|(% style="width:169px" %)4G Gateway 1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW157|(% style="width:169px" %)4G Gateway 2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW158|(% style="width:169px" %)4G Gateway 3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW159|(% style="width:169px" %)4G Gateway 4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW160|(% style="width:169px" %)4G MAC1|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW161|(% style="width:169px" %)4G MAC2|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW162|(% style="width:169px" %)4G MAC3|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW163|(% style="width:169px" %)4G MAC4|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW164|(% style="width:169px" %)4G MAC5|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW165|(% style="width:169px" %)4G MAC6|(% style="width:456px" %)read only
--|(% style="width:151px" %)@W_HSW166|(% style="width:169px" %)4G Signal value|(% style="width:456px" %)read only
++1: Draw a map fence and the box is in the fence
--**Others**
++2: Draw a map fence and the box is not in the fence
--* Access password: addr_getstring("@W_HSW27", 16)
--* Machine code: addr_getstring("@W_HSW60", 64)
--* Positioning method (@W_HSW167): (read only)
--** Latitude and longitude
--*** Longitude: addr_getdouble("@W_HSW168") (read only)
--*** Latitude: addr_getdouble("@W_HSW172") (read only)
--** Base station positioning
--*** LAC: addr_getdword("@W_HSW168") (read only)
--*** CI: addr_getdword("@W_HSW172") (read only)
--* Convert base station to latitude and longitude via API
--** Longitude: addr_getdouble("@W_HSW187") (read only)
--** Latitude: addr_getdouble("@W_HSW183") (read only)
--* Operator information: addr_getdword("@W_HSW181") (read only)
--* Networking mode: addr_getword("@W_HSW177") (read only)
--** 0: Ethernet
--** 1: WIFI
--** 2: 4G
--** 3: 2G
--* Map fence flag: addr_getword("@W_HSW178") (read only)
--** 0: No map fence is drawn
--** 1: Draw a map fence and the box is in the fence
--** 2: Draw a map fence and the box is not in the fence
--* SIM card status addr_getword("@W_HSW179") (read only)
--** 1: No card detected
--** 2: Card insertion detected
--** 3: The card status is abnormal
--* MQTT status addr_getword("@W_HSW180") (read only)
--** 1: online, 2: offline
--* IO interface, X is read only, Y is read and write (H series)
--** addr_getbit(addr1), addr_setbit(addr2)
--** addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
--** addr2:"@B_Y0" "@B_Y1"
--* Obtaining IMEI (read only)
--** addr_getstring("@W_HSW191",17)
--* Obtaining ICCID (read only)
--** addr_getstring("@W_HSW225",15)
++2.8 SIM card status addr_getword("@W_HSW179") (read only)
--(((
--== **Power-down storage area (HAW/HAX)** ==
++1: No card detected
--The system storage area (HAW) is used for the system power-down hold registers:
++2: Card insertion detected
--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".
++3: The card status is abnormal
--(% 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.
--)))
++2.9 MQTT status addr_getword("@W_HSW180") (read only)
++1: online, 2: offline
++
++2.10 IO interface, X is read only, Y is read and write (H series)
++
++addr_getbit(addr1), addr_setbit(addr2)
++
++addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
++
++addr2:"@B_Y0" "@B_Y1"
++
++(((
  = **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