Changes for page 01 Lua Functions

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

From 5.7 to 5.8 From 5.12 to 5.13

From version 5.8

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

Change comment: (Autosaved)

To version 5.12

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

Change comment: (Autosaved)

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -627,13 +627,11 @@
 . When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.
  (((
--== **3.1 serial.open(table setup)** ==
++== **serial.open(table setup)** ==
  )))
--**Function:**
++**Function:** Enable one serial port
--Enable one serial port
--
  **Parameters:**
  //Setup// is a Lua table; it needs to contain the following fields
@@ -667,17 +667,13 @@
  Failed: multi
  (((
--== **3.2 serial.close(serial obj)** ==
++== **serial.close(serial obj)** ==
  )))
--**Function:**
++**Function:** Disable the serial port
--Disable the serial port
++**Parameters: **//Obj //is the object returned by serial.open
--**Parameters:**
--
--//Obj //is the object returned by serial.open
--
  **Return：**
  Succeed: true
@@ -685,13 +685,11 @@
  Failed: multi
  (((
--== **3.3 serial:read(number bytes[, number timeout])** ==
++== **serial:read(number bytes[, number timeout])** ==
  )))
--**Function:**
++**Function:** Read the specified byte length serial port data
--Read the specified byte length serial port data
--
  **Parameters:**
  //bytes//: number of bytes
@@ -705,15 +705,13 @@
  Failed: multi
  (((
--== **3.4 serial:write(string data)** ==
++== **serial:write(string data)** ==
  )))
--**Function:**
++**Function:** Write the specified byte length to serial port data
--Write the specified byte length to serial port data
++**Parameters: **
--**Parameters:**
--
  //data//: serial port data
  **Return：**
@@ -723,13 +723,11 @@
  Failed: multi
  (((
--== **3.5 serial:flush([number flag])** ==
++== **serial:flush([number flag])** ==
  )))
--**Function:**
++**Function:** Clear the serial port buffer
--Clear the serial port buffer
--
  **Parameters:**
  //[flag=2]// clear option: 0: read, 1: write, 2: read-write
@@ -741,17 +741,13 @@
  Failed: multi
  (((
--== **3.6 serial:close()** ==
++== **serial:close()** ==
  )))
--**Function:**
++**Function:** Close the serial port object
--Close the serial port object
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return：**
  Succeed: true
@@ -768,12 +768,10 @@
  **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.
++* 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.
--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;
@@ -781,13 +781,11 @@
 : reserved
  (((
--== **4.1 mqtt.create(string serverurl, string clientid)** ==
++== **mqtt.create(string serverurl, string clientid)** ==
  )))
--**Function:**
++**Function:** Create an MQTT object
--Create an MQTT object
--
  **Parameters:**
  //serverurl //Server url
@@ -809,17 +809,13 @@
  Failed: multi
  (((
--== **4.2 mqtt.close(mqtt obj)** ==
++== **mqtt.close(mqtt obj)** ==
  )))
--**Function:**
++**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)
--Close the specified MQTT object (if the connected server will be disconnected automatically)
++**Parameters: **//Obj //is the objeced returned by mqtt.create
--**Parameters:**
--
--//Obj //is the objeced returned by mqtt.create
--
  **Return：**
  Succeed: true
@@ -827,32 +827,25 @@
  Failed: multi
  (((
--== **4.3 mqtt:connect(table conn[, table lwt, table cart])** ==
++== **mqtt:connect(table conn[, table lwt, table cart])** ==
  )))
--**Function:**
++**Function:**Establish a connection to the server
--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.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.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.
@@ -860,14 +860,11 @@
  //lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields
--//string lwt.topic//, topic
++* //string lwt.topic//, topic
++* //string lwt.message//, message
++* //number [lwt.qos=0]//, qos value
++* //number [lwt.retain=0]//, retain flag
--//string lwt.message//, message
--
--//number [lwt.qos=0]//, qos value
--
--//number [lwt.retain=0]//, retain flag
--
  **Return：**
  Succeed: true
@@ -875,17 +875,13 @@
  Failed: multi
  (((
--== **4.4 mqtt:disconnect([number timeout])** ==
++== **mqtt:disconnect([number timeout])** ==
  )))
--**Function:**
++**Function:** Disconnect from the MQTT server
--Disconnect from the MQTT server
++**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
--**Parameters:**
--
--//[timeout=10000] //Disconnect waiting timeout, in milliseconds
--
  **Return：**
  Succeed: true
@@ -893,17 +893,13 @@
  Failed: multi
  (((
--== **4.5 mqtt:isconnected()** ==
++== **mqtt:isconnected()** ==
  )))
--**Function:**
++**Function:** Test whether or not a client is currently connected to the MQTT server
--Test whether or not a client is currently connected to the MQTT server
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return：**
  Succeed: true ~-~-Connected
@@ -911,13 +911,11 @@
  Failed: false ~-~- Unconnected and other unknowns
  (((
--== **4.6 mqtt:subscribe(string topic, number qos)** ==
++== **mqtt:subscribe(string topic, number qos)** ==
  )))
--**Function:**
++**Function: **Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
--Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
--
  **Parameters:**
  //topic//, topic name
@@ -931,13 +931,11 @@
  Failed: multi
  (((
--== **4.7 mqtt:unsubscribe(string topic)** ==
++== **mqtt:unsubscribe(string topic)** ==
  )))
--**Function:**
++**Function:** Unsubscribe topic
--Unsubscribe topic
--
  **Parameters:**
  //topic//, topic name
@@ -949,13 +949,11 @@
  Failed: multi
  (((
--== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
++== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
  )))
--**Function:**
++**Function:** Publish message
--Publish message
--
  **Parameters:**
  //topic//, topic name
@@ -975,17 +975,13 @@
  Failed: multi
  (((
--== **4.9 mqtt:close()** ==
++== **mqtt:close()** ==
  )))
--**Function:**
++**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)
--Close the mqtt object (the connection to the server will be automatically disconnected)
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return：**
  Succeed: true
@@ -993,13 +993,11 @@
  Failed: multi
  (((
--== **4.10 mqtt:on(string method, function callback)** ==
++== **mqtt:on(string method, function callback)** ==
  )))
--**Function:**
++**Function:** Register event callback function
--Register event callback function
--
  **Parameters:**
  //method//, It can be message/arrived/offline, these 3 types of events
@@ -1012,20 +1012,17 @@
  Parameter:
--//Topic//, topic name
++* //Topic//, topic name
++* //Message//, content
--//Message//, content
++**2."arrived" is published by publish, this function will be called after the publication arrives**
--**2.**"arrived" is published by publish, this function will be called after the publication arrives
--
  //Callback// prototype~:// function ()//
--Parameter:
++Parameter: None
--None
++**3.This function will be called after the "offline" connection is lost**
--**3.**This function will be called after the "offline" connection is lost
--
  //Callback// prototype~:// function (string cause)//
  Parameter:
@@ -1039,17 +1039,13 @@
  Failed: multi
  (((
--== **4.11 mqtt:setup_cfg()** ==
++== **mqtt:setup_cfg()** ==
  )))
--**Function:**
++**Function:** Cloud mode interface, to obtain MQTT information configured by the cloud platform
--Cloud mode interface, to obtain MQTT information configured by the cloud platform
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return:**
  //serverurl, clientid, conn, lwt, cart //(5 returns, respectively, server address, client ID, connection table, last word table, certificate table)
@@ -1067,39 +1067,27 @@
  Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table.
  (((
--== **5.1 json.encode( lua_object )** ==
++== **json.encode( lua_object )** ==
  )))
--**Function:**
++**Function: **Convert lua data type to json string
--Convert lua data type to json string
++**Parameters: **Lua data type (including boolean, number, string, table)
--**Parameters:**
++**Return：** Json format string
--Lua data type (including boolean, number, string, table)
--
--**Return：**
--
--Json format string
--
  (((
--== **5.2 json.decode(string json_string)** ==
++== **json.decode(string json_string)** ==
  )))
--**Function:**
++**Function:** Convert json string to lua data type
--Convert json string to lua data type
++**Parameters: **//json_string//, string of json data structure
--**Parameters:**
++**Return: **Lua data type
--//json_string//, string of json data structure
--
--**Return：**
--
--Lua data type
--
  (((
--== **5.3 json.null** ==
++== **json.null** ==
  )))
  **Function:**
@@ -1106,32 +1106,24 @@
  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:**
++**Parameters:** None
--None
++**Return: **None
--**Return：**
--
--None
--
  = **6 Cloud mode** =
  The cloud interface is only used in cloud mode, and V-NET mode is not available.
  (((
--== **6.1 bns_get_alldata()** ==
++== **bns_get_alldata()** ==
  )))
--**Function:**
++**Function:** Obtain all monitoring points (point table) data configured by the end user
--Obtain all monitoring points (point table) data configured by the end user
++**✎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
--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
--**Parameters:**
--
--None
--
  **Return:**
  Succeed: table two-dimensional array, the structure is as follows
@@ -1161,13 +1161,11 @@
  Failed: //table// empty table
  (((
--== **6.2 bns_get_config(string from)** ==
++== **bns_get_config(string from)** ==
  )))
--**Function:**
++**Function:** Obtain custom configuration parameters with the specified from type
--Obtain custom configuration parameters with the specified from type
--
  **parameter:**
  from type, there are the following two categories, the string must be all lowercase
@@ -1185,13 +1185,11 @@
  Failed~:// table// empty table
  (((
--== **6.3 bns_get_data(string name, string data)** ==
++== **bns_get_data(string name, string data)** ==
  )))
--**Function:**
++**Function:**write data to the name of the monitoring point
--write data to the name of the monitoring point
--
  **parameter:**
  //name //The name of the monitoring point
@@ -1205,7 +1205,7 @@
  Failed: nil
  (((
--== **6.4 bns_get_data(string name)** ==
++== **bns_get_data(string name)** ==
  )))
  **Function:**
@@ -1223,17 +1223,13 @@
  Failed: nil
  (((
--== **6.5 bns_get_datadesc()** ==
++== **bns_get_datadesc()** ==
  )))
--**Function:**
++**Function: **Obtain all configured communication ports and monitoring point information
--Obtain all configured communication ports and monitoring point information
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return:**
  Succeed: table three-dimensional array, the structure is as follows
@@ -1286,17 +1286,13 @@
  Failed~:// table// empty table
  (((
--== **6.6 bns_get_machineinfo()** ==
++== **bns_get_machineinfo()** ==
  )))
--**Function:**
++**Function:** get machine information
--get machine information
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return:**
  Succeed: 3 string type results (model, machine code, software version)
@@ -1304,13 +1304,11 @@
  Failed: nil
  (((
--== **6.7 bns_get_groupdata(string name)** ==
++== **bns_get_groupdata(string name)** ==
  )))
--**Function:**
++**Function:** Get all monitoring point data under the specified group name
--Get all monitoring point data under the specified group name
--
  **parameter:**
  //Name  // group name
@@ -1322,17 +1322,13 @@
  Failed: //table// empty table
  (((
--== **6.8 bns_get_groupdesc()** ==
++== **bns_get_groupdesc()** ==
  )))
--**Function:**
++**Function:** Get all group information
--Get all group information
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return:**
  Succeed: //table// two-dimensional array, the structure is as follows
@@ -1346,17 +1346,13 @@
  Failed: //table  // empty table
  (((
--== **6.9 bns_get_onecache(string msg)** ==
++== **bns_get_onecache(string msg)** ==
  )))
--**Function:**
++**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.
--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
--**Parameters:**
--
--//msg// String
--
  **Return:**
  Succeed: true
@@ -1364,17 +1364,13 @@
  Failed: nil
  (((
--== **6.10 bns_get_allcache()** ==
++== **bns_get_allcache()** ==
  )))
--**Function:**
++**Function:** Get all the cached content (once the internal cache file will be emptied)
--Get all the cached content (once the internal cache file will be emptied)
++**Parameters:** None
--**Parameters:**
--
--None
--
  **Return:**
  Succeed: //table// one-dimensional array
@@ -1402,11 +1402,57 @@
  Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it.
  (((
--== **7.1 http request** ==
++== **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** ==
++
++Example：
++
++{{code language="LUA"}}
++local json = require("json")
++
++local https = require("https")
++
++functions https_demo.main()
++
++local url = "https://XXXXXXXXXXXXXXXXXXXXXXXXXX"
++
++local body = {}
++
++body["XXXXXX"] = "XXXXX"
++
++body["XXXXXXX"] = "XXXXXXXXXXX"
++
++local bodyJson = json.encode(body)
++
++local header = {}
++
++header["content-type"] = "application/json"
++
++local result_table, code, headers, status = https.request(url,
++
++bodyJson)
++
++if code == 200 then
++
++print("https suc")
++
++return true
++
++else
++
++print("https fail")
++
++return nil
++
++end
++
++end
++{{/code}}
++
  (((
  = **8 Internal register** =
  )))
@@ -1413,32 +1413,32 @@
  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):
--**~1. **Access by word, prefix @W_HDW,
++**Access by word, prefix @W_HDW.**
  For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
--**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.
++**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.
++(% class="box errormessage" %)
++(((
  **✎Note: **
++)))
--**~1. **The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
++* 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.
--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.
--
--**2.**The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
--
  (((
--== **8.1 Data storage area（HDW/HDX）** ==
++== **Data storage area（HDW/HDX）** ==
  )))
  The system storage area (HDW) of the V-BOX is used to store temporary data:
--~1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
++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. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
--
  (((
  == **8.2 Special data area (HSW/HSX)** ==
  )))

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents