Changes for page 01 Lua Functions

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

From 5.1 to 5.2 From 5.10 to 5.11

From version 5.2

edited by Leo
on 2022/06/16 17:19

Change comment: Update document after refactoring.

To version 5.10

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

Change comment: (Autosaved)

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--01 Lua script function
++01 Lua Functions

Author

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

Content

@@ -1,70 +1,66 @@
--= **1 Interface Description** =
++= **1 Interface description** =
--== **1.1 Data type definition** ==
++== **Data type definition** ==
--
  |=**Type**|=**Description**
  |=nil|Null
--|=boolean|Boolean, the value is true or false
--|=number|Integer or floating point, signed or unsigned
++|=boolean|Boolean (the value is true or false)
++|=number|Integer or floating point (signed or unsigned)
  |=string|String
  |=table|Table
  |=function|Functions
--== **1.2 Built-in function library clipping** ==
++== **Built-in function library clipping** ==
  Full features supported: coroutine/debug/ math/ package/ string/ table/ utf8
--//,,Some features supported (available in []):** **os[clock/ date/ difftime/ time],,//
++//Some features supported (available in []):** **os[clock/ date/ difftime/ time]//
--//,,Not supported: io/ file,,//
++//Not supported: io/ file//
--== **1.3 Return value description** ==
++== **Return value description** ==
  The function return type multi means multiple return values (at least 2), usually:
--//,,1st: nil;,,//
++//1st: nil//
--//,,2nd: the error message;,,//
++//2nd: the error message//
  (((
--== **1.4 Function parameter description** ==
++== **Function parameter description** ==
  )))
--**Assume the function prototype:**
++Suppose a function prototype is defined:
--|(((
--//student(string name, number age[, number class])//
++{{code language="LUA"}}
++student(string name, number age[, number class])
--**Function:**
++Function:
  Register a student
--**Parameters:**
++Parameters:
--//name//: student name
++name: student name
--//age//: student age
++age: student age
--//[class=1]//: Student class
++[class=1]: Student class
--**Return：**
++Return：
  Succeed: true
  Failed: multi
--)))
++{{/code}}
--**Comment**
++**Explanation**
--1.string name indicates that the first parameter name is a string
++1. string name indicates that the first parameter name is a string
++1. number age indicates that the second parameter age is numeric
++1. [, number class] indicates that the third parameter class is a numeric value, and it is optional. Specify the default class in class 1 in the parameter description.
++1. **Any parameter in the [] is considered to be an optional parameter, and may not be transmitted when called. The default value will be given in the parameter description.**
--2.number age indicates that the second parameter age is numeric
--
--3. [, number class] indicates that the third parameter class is a numeric value, and it is optional. Specify the default class in class 1 in the parameter description.
--
--4. Any parameter in the brackets of [] is considered to be an optional parameter, and may not be transmitted when called. The default value will be given in the parameter description.
--
  **Call example**
  |(((
@@ -93,28 +93,23 @@
  **Comment**
--1.From the print result, the second line of the first line is successfully called and returns true; the third line fails the call, the error message is translated as: the bar student has been registered, and there is indeed an error in the code.
++1. From the print result, the first line and the second line are successfully called and returns true; the third line fails the call, the error message is translated as: the bar student has been registered, and there is indeed an error in the code.
++1. The fourth line of code uses two variables to receive the return value. The call failed, the first variable stat is nil, and the second variable err stores the error message. Then print it out using print, which is the output of the third line. This example shows how to capture and view the error message.
--2.The fourth line of code uses two variables to receive the return value. The call failed, the first variable stat is nil, and the second variable err stores the error message. Then print it out using print, which is the output of the third line. This example shows how to capture and view the error message.
++== **Modification of print function** ==
--== **1.5 Modification of the Print Function** ==
++For the convenience of remote development, the print data is sent to the front end (web page) by means of network transmission, and the user can see the result of the debug output, because it consumes certain data and occupies the bandwidth of the server (or occupies server resources). So the following restrictions are made.
--For the convenience of remote development, the print data is sent to the front end (web page) by means of network transmission, and the user can see the result of the debug output, because it consumes certain data and occupies the bandwidth of the server (or occupies server resources). So make the following restrictions:
++1. **Interval limit: **When debugging, transfer once every 2~~3 seconds;
++1. **Data limit: **The transfer data cannot be larger than 1.5KB in a single transmission, otherwise the extra part will be ignored;
++1. **Transmission limit: **The data transmission will be stopped automatically after the debugging windows is not closed normally. Only when it is in the debugging window and the switch is on, there is data transmission;
--**1.Interval limit: **When debugging, transfer once every 2~~3 seconds;
--
--**2.Data limit: **The transfer data cannot be larger than 1.5KB, and the extra part will be ignored;
--
--**3.Transmission limit: **The data transmission will be stopped automatically after the debugging windows is not closed normally. Only when it is in the debugging window and the switch is on, there is data transmission;
--
  Users should pay attention to avoid printing a lot of useless information, should minimize the debug output
  In addition, please refer to the front-end documentation for how to use view debugging.
  (((
--= **2 Address Operation** =
--
--
++= **2 Address operation** =
  )))
  |=16-bit data formal|=HLword|=32-bit data formal|=HLword|= 64-bit data formal|=HLword
@@ -147,20 +147,17 @@
  43218765
  )))|10
--* If HLword enters any other value, it will be treated as invalid.
++ Table 2-1
--                      Demo:  Reads a 32-bit floating-point number at position D0 of PLC
++(% class="box errormessage" %)
++(((
++**✎Note: **If HLword enters any other value, it will be treated as invalid.
++)))
++== **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
@@ -178,13 +178,11 @@
  Failed: multi
  (((
--== **2.2 addr_setshort(string addr, number num[, number type, number hlword])** ==
++== **addr_setshort(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Write 16-bit signed decimal address
--Write 16-bit signed decimal address
--
  **Parameters:**
  //addr//: address
@@ -202,13 +202,11 @@
  Failed: multi
  (((
--== **2.3 addr_getword(string addr[, number type, number hlword])** ==
++== **addr_getword(string addr[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Read 16-bit unsigned decimal address
--Read 16-bit unsigned decimal address
--
  **Parameters:**
  //addr//: address
@@ -224,13 +224,11 @@
  Failed: multi
  (((
--== **2.4 addr_setword(string addr, number num[, number type, number hlword])** ==
++== **addr_setword(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:**Write 16-bit unsigned decimal address
--Write 16-bit unsigned decimal address
--
  **Parameters:**
  //addr//: address
@@ -248,13 +248,11 @@
  Failed: multi
  (((
--== **2.5 addr_getint(string addr[, number type, number hlword])** ==
++== **addr_getint(string addr[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Read 32-bit signed decimal address
--Read 32-bit signed decimal address
--
  **Parameters:**
  //addr//: address
@@ -270,13 +270,11 @@
  Failed: multi
  (((
--== **2.6 addr_setint(string addr, number num[, number type, number hlword])** ==
++== **addr_setint(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Write 32-bit signed decimal address
--Write 32-bit signed decimal address
--
  **Parameters:**
  //addr//: address
@@ -294,13 +294,11 @@
  Failed: multi
  (((
--== **2.7 addr_getdword(string addr[, number type, number hlword])** ==
++== **addr_getdword(string addr[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Read 32-bit unsigned decimal address
--Read 32-bit unsigned decimal address
--
  **Parameters:**
  //addr//: address
@@ -316,13 +316,11 @@
  Failed: multi
  (((
--== **2.8 addr_setdword(string addr, number num[, number type, number hlword])** ==
++== **addr_setdword(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Write 32-bit unsigned decimal address
--Write 32-bit unsigned decimal address
--
  **Parameters:**
  //addr//: address
@@ -340,13 +340,11 @@
  Failed: multi
  (((
--== **2.9 addr_getbit(string addr[, number type])** ==
++== **addr_getbit(string addr[, number type])** ==
  )))
--**Function:**
++**Function:** Read a bit of the register address
--Read a bit of the register address
--
  **Parameters:**
  //addr//: address
@@ -362,13 +362,11 @@
  Failed: multi
  (((
--== **2.10 addr_setbit(string addr, number num[, number type])** ==
++== **addr_setbit(string addr, number num[, number type])** ==
  )))
--**Function:**
++**Function:** Write a bit of the register address
--Write a bit of the register address
--
  **Parameters:**
  //addr//: address
@@ -386,13 +386,11 @@
  Failed: multi
  (((
--== **2.11 addr_getfloat(string addr[, number type, number hlword])** ==
++== **addr_getfloat(string addr[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Read 32-bit floating address
--Read 32-bit floating address
--
  **Parameters:**
  //addr//: address
@@ -408,13 +408,11 @@
  Failed: multi
  (((
--== **2.12 addr_setfloat(string addr, number num[, number type, number hlword])** ==
++== **addr_setfloat(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Write 32-bit floating address
--Write 32-bit floating address
--
  **Parameters:**
  //addr//: address
@@ -432,13 +432,11 @@
  Failed: multi
  (((
--== **2.13 addr_getdouble(string addr[, number type, number hlword])** ==
++== **addr_getdouble(string addr[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Read 64-bit floating address
--Read 64-bit floating address
--
  **Parameters:**
  //addr//: address
@@ -454,13 +454,11 @@
  Failed: multi
  (((
--== **2.14 addr_setdouble(string addr, number num[, number type, number hlword])** ==
++== **addr_setdouble(string addr, number num[, number type, number hlword])** ==
  )))
--**Function:**
++**Function:** Write 64-bit floating address
--Write 64-bit floating address
--
  **Parameters:**
  addr: address
@@ -478,13 +478,11 @@
  Failed: multi
  (((
--== **2.15 addr_getstring(string addr, number length[, number type, number hlbyte])** ==
++== **addr_getstring(string addr, number length[, number type, number hlbyte])** ==
  )))
--**Function:**
++**Function:** Read the specified length string from address
--Read the specified length string from address
--
  **Parameters:**
  //addr//: address
@@ -502,13 +502,11 @@
  Failed: multi
  (((
--== **2.16 addr_setstring(string addr, string str[, number type, number hlbyte])** ==
++== **addr_setstring(string addr, string str[, number type, number hlbyte])** ==
  )))
--**Function:**
++**Function:** Write the specified length string to address
--Write the specified length string to address
--
  **Parameters:**
  //addr//: address
@@ -526,13 +526,11 @@
  Failed: multi
  (((
--== **2.17 addr_bmov(string dst, string src, number length)** ==
++== **addr_bmov(string dst, string src, number length)** ==
  )))
--**Function:**
++**Function:** Copy data from source address to destination address
--Copy data from source address to destination address
--
  **Parameters:**
  //dst//: destination address
@@ -548,13 +548,11 @@
  **Failed: multi**
  (((
--== **2.18 addr_fill(string addr, number num, number length)** ==
++== **addr_fill(string addr, number num, number length)** ==
  )))
--**Function:**
++**Function:** Write the same value to consecutive addresses
--Write the same value to consecutive addresses
--
  **Parameters:**
  //addr//: address
@@ -570,13 +570,11 @@
  Failed: multi
  (((
--== **2.19 addr_newnoaddr(string addr, number offset)** ==
++== **addr_newnoaddr(string addr, number offset)** ==
  )))
--**Function:**
++**Function:** Offset address value relative to //addr//
--Offset address value relative to //addr//
--
  **Parameters:**
  //addr//: address
@@ -590,13 +590,11 @@
  Failed: multi
  (((
--== **2.20 addr_newstataddr(string addr, number offset)** ==
++== **addr_newstataddr(string addr, number offset)** ==
  )))
--**Function:**
++**Function:** Offset station number relative to //addr //station number
--Offset station number relative to //addr //station number
--
  **Parameters:**
  //addr//: address
@@ -609,12 +609,10 @@
  Failed: multi
--== **2.21 addr_gethex64(string addr[, number type, number hlword])** ==
++== **addr_gethex64(string addr[, number type, number hlword])** ==
--**Function:**
++**Function:** Read 64-bit hexadecimal numbers
--Read 64-bit hexadecimal numbers
--
  **Parameters:**
  //addr//: address
@@ -629,12 +629,10 @@
  Failed: multi
--== **2.22 addr_sethex64(string addr, number num[, number type, number hlword])** ==
++== **addr_sethex64(string addr, number num[, number type, number hlword])** ==
--**Function:**
++**Function:** Write 64-bit hexadecimal addresses
--Write 64-bit hexadecimal addresses
--
  **Parameters:**
  //addr//: address
@@ -655,11 +655,11 @@
  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.
  |(((
  local setup = {
@@ -681,13 +681,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
@@ -721,17 +721,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
@@ -739,13 +739,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
@@ -759,15 +759,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：**
@@ -777,13 +777,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
@@ -795,17 +795,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
@@ -822,12 +822,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;
@@ -835,13 +835,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
@@ -863,17 +863,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
@@ -881,32 +881,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.
@@ -914,14 +914,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
@@ -929,17 +929,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
@@ -947,17 +947,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
@@ -965,13 +965,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
@@ -985,13 +985,11 @@
  Failed: multi
  (((
--== **4.7 mqtt:unsubscribe(string topic)** ==
++== **mqtt:unsubscribe(string topic)** ==
  )))
--**Function:**
++**Function:** Unsubscribe topic
--Unsubscribe topic
--
  **Parameters:**
  //topic//, topic name
@@ -1003,13 +1003,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
@@ -1029,17 +1029,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
@@ -1047,13 +1047,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

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents