Changes for page 01 Lua Functions

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

From 2.2 to 2.1 From 5.7 to 5.6

From version 5.6

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

Change comment: There is no comment for this version

To version 2.2

edited by Leo Wei
on 2022/06/16 16:07

Change comment: Update document after refactoring.

Raw
Rendered

Summary

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

Details

Page properties

Title

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

Parent

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

Author

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

Content

@@ -1,66 +1,70 @@
  = **1 Interface Description** =
--== **Data type definition** ==
++== **1.1 Data type definition** ==
--|=**Type**|=**Description**
--|=nil|Null
--|=boolean|Boolean (the value is true or false)
--|=number|Integer or floating point (signed or unsigned)
--|=string|String
--|=table|Table
--|=function|Functions
++(% class="table-bordered" style="width:749.989px" %)
++|(% style="width:375px" %)**Type**|(% style="width:372px" %)**Description**
++|(% style="width:375px" %)nil|(% style="width:372px" %)Null
++|(% style="width:375px" %)boolean|(% style="width:372px" %)Boolean, the value is true or false
++|(% style="width:375px" %)number|(% style="width:372px" %)Integer or floating point, signed or unsigned
++|(% style="width:375px" %)string|(% style="width:372px" %)String
++|(% style="width:375px" %)table|(% style="width:372px" %)Table
++|(% style="width:375px" %)function|(% style="width:372px" %)Functions
--== **Built-in function library clipping** ==
++== **1.2 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,,//
--== **Return value description** ==
++== **1.3 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;,,//
  (((
--== **Function parameter description** ==
++== **1.4 Function parameter description** ==
  )))
--Suppose a function prototype is defined:
++**Assume the function prototype:**
--{{code language="LUA"}}
--student(string name, number age[, number class])
++|(((
++//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}}
++)))
--**Explanation**
++**Comment**
--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.**
++1.string name indicates that the first parameter name is a string
++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.
++
++{{id name="OLE_LINK4"/}}{{id name="OLE_LINK5"/}}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**
  |(((
@@ -89,17 +89,20 @@
  **Comment**
--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.
++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.
--== **Modification of the Print Function** ==
++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.
--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.
++== **1.5 Modification of the Print Function** ==
--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;
++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;
++
++**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.
@@ -107,38 +107,39 @@
  (((
  = **2 Address Operation** =
--
++**~ Form 2.1**
  )))
--|=16-bit data formal|=HLword|=32-bit data formal|=HLword|= 64-bit data formal|=HLword
--|12（Default）|0|1234（Default）|0|(((
--12345678(Default)
--)))|(((
--0
++(% class="table-bordered" style="width:982px" %)
++|(% style="width:167px" %)   16-bit data formal|(% style="width:142px" %)         HLword|(% style="width:194px" %)      32-bit data formal|(% style="width:177px" %)            HLword|(% style="width:147px" %) 64-bit data formal|(% style="width:152px" %)           HLword
++|(% style="width:167px" %)       12（Default）|(% style="width:142px" %)              0|(% style="width:194px" %)          1234（Default）|(% style="width:177px" %)                  0|(% style="width:147px" %)(((
++           12345678(Default)
++)))|(% style="width:152px" %)(((
++               0
  )))
--|21|6|(((
--3412(High and low word conversion)
--)))|2|(((
--34127856  (High and low word conversion)
--)))|2
--| | |2143|3|(((
--21436587
--)))|3
--| | |4321|6|(((
--87654321
--)))|6
--| | | | |(((
--78563412
--)))|7
--| | | | |(((
--56781234
--)))|8
--| | | | |(((
--65872143
--)))|9
--| | | | |(((
--43218765
--)))|10
++|(% style="width:167px" %)       21|(% style="width:142px" %)              6|(% style="width:194px" %)(((
++          3412(High and low word conversion)
++)))|(% style="width:177px" %)                  2|(% style="width:147px" %)(((
++        34127856  (High and low word conversion)
++)))|(% style="width:152px" %)               2
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %)               2143|(% style="width:177px" %)                  3|(% style="width:147px" %)(((
++        21436587
++)))|(% style="width:152px" %)               3
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %)               4321|(% style="width:177px" %)                  6|(% style="width:147px" %)(((
++        87654321
++)))|(% style="width:152px" %)               6
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
++        78563412
++)))|(% style="width:152px" %)               7
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
++        56781234
++)))|(% style="width:152px" %)               8
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
++        65872143
++)))|(% style="width:152px" %)               9
++|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
++        43218765
++)))|(% style="width:152px" %)              10
  * If HLword enters any other value, it will be treated as invalid.
@@ -145,9 +145,9 @@
                        Demo:  Reads a 32-bit floating-point number at position D0 of PLC
++(% style="text-align:center" %)
++[[image:企业微信截图_20210506180640.png||class="img-thumbnail" height="301" width="600"]]
--[[image:企业微信截图_20210506180640.png||height="301" width="600" class="img-thumbnail"]]
--
  == **2.1 addr_getshort(string addr[, number type, number hlword])** ==
  **Function:**
@@ -200,7 +200,7 @@
  **Function:**
--Read 16-bit unsigned decimal address
++{{id name="OLE_LINK6"/}}Read 16-bit unsigned decimal address
  **Parameters:**
@@ -292,7 +292,7 @@
  **Function:**
--Read 32-bit unsigned decimal address
++{{id name="OLE_LINK7"/}}Read 32-bit unsigned decimal address
  **Parameters:**
@@ -368,7 +368,7 @@
  //num//: value
--[type = 0]not read through 1: read through
++{{id name="OLE_LINK8"/}}[type = 0]not read through 1: read through
  [hlword = 0]  Don't convert，See Form 2.1
@@ -1492,7 +1492,7 @@
  **✎Note: **
--//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).
++//{{id name="OLE_LINK1"/}}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.
@@ -1835,7 +1835,7 @@
  Faied: multi
  (((
--== **9.7 remote_com_start(string config)** ==
++== **9.7 {{id name="_Toc22969"/}}remote_com_start(string config)** ==
  )))
  **Function:**
@@ -1875,7 +1875,7 @@
  Failed: multi
  (((
--== **9.9 remote_com_state()** ==
++== **9.9{{id name="_Toc22824"/}} remote_com_state()** ==
  )))
  **Function:**
@@ -1889,4 +1889,4 @@
 . number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
 . string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
--Failed: multi
++{{id name="OLE_LINK9"/}}Failed: multi

Changes for page 01 Lua Functions

Summary

Details

Navigation

Table of Contents