Changes for page 01 Lua Functions

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

From version 5.10
edited by Stone Wu
on 2022/07/12 09:30
Change comment: (Autosaved)
To version 1.1
edited by Leo Wei
on 2022/06/08 12:58
Change comment: Imported from XAR

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -01 Lua Functions
1 +01 Lua script function
Parent
... ... @@ -1,1 +1,1 @@
1 -V-BOX.V-Net.1\.User Manual.04 Lua Script.WebHome
1 +V-BOX.V-Net.1\.User Manual.04\.Lua script function and operation.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Stone
1 +XWiki.admin
Content
... ... @@ -1,66 +1,70 @@
1 -= **1 Interface description** =
1 += **1 Interface Description** =
2 2  
3 -== **Data type definition** ==
3 +== **1.1 Data type definition** ==
4 4  
5 -|=**Type**|=**Description**
6 -|=nil|Null
7 -|=boolean|Boolean (the value is true or false)
8 -|=number|Integer or floating point (signed or unsigned)
9 -|=string|String
10 -|=table|Table
11 -|=function|Functions
5 +(% class="table-bordered" style="width:749.989px" %)
6 +|(% style="width:375px" %)**Type**|(% style="width:372px" %)**Description**
7 +|(% style="width:375px" %)nil|(% style="width:372px" %)Null
8 +|(% style="width:375px" %)boolean|(% style="width:372px" %)Boolean, the value is true or false
9 +|(% style="width:375px" %)number|(% style="width:372px" %)Integer or floating point, signed or unsigned
10 +|(% style="width:375px" %)string|(% style="width:372px" %)String
11 +|(% style="width:375px" %)table|(% style="width:372px" %)Table
12 +|(% style="width:375px" %)function|(% style="width:372px" %)Functions
12 12  
13 -== **Built-in function library clipping** ==
14 +== **1.2 Built-in function library clipping** ==
14 14  
15 15  Full features supported: coroutine/debug/ math/ package/ string/ table/ utf8
16 16  
17 -//Some features supported (available in []):** **os[clock/ date/ difftime/ time]//
18 +//,,Some features supported (available in []):** **os[clock/ date/ difftime/ time],,//
18 18  
19 -//Not supported: io/ file//
20 +//,,Not supported: io/ file,,//
20 20  
21 -== **Return value description** ==
22 +== **1.3 Return value description** ==
22 22  
23 23  The function return type multi means multiple return values (at least 2), usually:
24 24  
25 -//1st: nil//
26 +//,,1st: nil;,,//
26 26  
27 -//2nd: the error message//
28 +//,,2nd: the error message;,,//
28 28  
29 29  (((
30 -== **Function parameter description** ==
31 +== **1.4 Function parameter description** ==
31 31  )))
32 32  
33 -Suppose a function prototype is defined:
34 +**Assume the function prototype:**
34 34  
35 -{{code language="LUA"}}
36 -student(string name, number age[, number class])
36 +|(((
37 +//student(string name, number age[, number class])//
37 37  
38 -Function:
39 +**Function:**
39 39  
40 40  Register a student
41 41  
42 -Parameters:
43 +**Parameters:**
43 43  
44 -name: student name
45 +//name//: student name
45 45  
46 -age: student age
47 +//age//: student age
47 47  
48 -[class=1]: Student class
49 +//[class=1]//: Student class
49 49  
50 -Return:
51 +**Return:**
51 51  
52 52  Succeed: true
53 53  
54 54  Failed: multi
55 -{{/code}}
56 +)))
56 56  
57 -**Explanation**
58 +**Comment**
58 58  
59 -1. string name indicates that the first parameter name is a string
60 -1. number age indicates that the second parameter age is numeric
61 -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.
62 -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.**
60 +1.string name indicates that the first parameter name is a string
63 63  
62 +2.number age indicates that the second parameter age is numeric
63 +
64 +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.
65 +
66 +{{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.
67 +
64 64  **Call example**
65 65  
66 66  |(((
... ... @@ -89,66 +89,75 @@
89 89  
90 90  **Comment**
91 91  
92 -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.
93 -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.
96 +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.
94 94  
95 -== **Modification of print function** ==
98 +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.
96 96  
97 -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.
100 +== **1.5 Modification of the Print Function** ==
98 98  
99 -1. **Interval limit: **When debugging, transfer once every 2~~3 seconds;
100 -1. **Data limit: **The transfer data cannot be larger than 1.5KB in a single transmission, otherwise the extra part will be ignored;
101 -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;
102 +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:
102 102  
104 +**1.Interval limit: **When debugging, transfer once every 2~~3 seconds;
105 +
106 +**2.Data limit: **The transfer data cannot be larger than 1.5KB, and the extra part will be ignored;
107 +
108 +**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;
109 +
103 103  Users should pay attention to avoid printing a lot of useless information, should minimize the debug output
104 104  
105 105  In addition, please refer to the front-end documentation for how to use view debugging.
106 106  
107 107  (((
108 -= **2 Address operation** =
115 += **2 Address Operation** =
116 +
117 +**~ Form 2.1**
109 109  )))
110 110  
111 -|=16-bit data formal|=HLword|=32-bit data formal|=HLword|= 64-bit data formal|=HLword
112 -|12(Default)|0|1234(Default)|0|(((
113 -12345678(Default)
114 -)))|(((
115 -0
120 +(% class="table-bordered" style="width:982px" %)
121 +|(% 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
122 +|(% style="width:167px" %) 12(Default)|(% style="width:142px" %) 0|(% style="width:194px" %) 1234(Default)|(% style="width:177px" %) 0|(% style="width:147px" %)(((
123 + 12345678(Default)
124 +)))|(% style="width:152px" %)(((
125 + 0
116 116  )))
117 -|21|6|(((
118 -3412(High and low word conversion)
119 -)))|2|(((
120 -34127856  (High and low word conversion)
121 -)))|2
122 -| | |2143|3|(((
123 -21436587
124 -)))|3
125 -| | |4321|6|(((
126 -87654321
127 -)))|6
128 -| | | | |(((
129 -78563412
130 -)))|7
131 -| | | | |(((
132 -56781234
133 -)))|8
134 -| | | | |(((
135 -65872143
136 -)))|9
137 -| | | | |(((
138 -43218765
139 -)))|10
127 +|(% style="width:167px" %) 21|(% style="width:142px" %) 6|(% style="width:194px" %)(((
128 + 3412(High and low word conversion)
129 +)))|(% style="width:177px" %) 2|(% style="width:147px" %)(((
130 + 34127856  (High and low word conversion)
131 +)))|(% style="width:152px" %) 2
132 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) 2143|(% style="width:177px" %) 3|(% style="width:147px" %)(((
133 + 21436587
134 +)))|(% style="width:152px" %) 3
135 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) 4321|(% style="width:177px" %) 6|(% style="width:147px" %)(((
136 + 87654321
137 +)))|(% style="width:152px" %) 6
138 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
139 + 78563412
140 +)))|(% style="width:152px" %) 7
141 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
142 + 56781234
143 +)))|(% style="width:152px" %) 8
144 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
145 + 65872143
146 +)))|(% style="width:152px" %) 9
147 +|(% style="width:167px" %) |(% style="width:142px" %) |(% style="width:194px" %) |(% style="width:177px" %) |(% style="width:147px" %)(((
148 + 43218765
149 +)))|(% style="width:152px" %) 10
140 140  
141 - Table 2-1
151 +* If HLword enters any other value, it will be treated as invalid.
142 142  
143 -(% class="box errormessage" %)
144 -(((
145 -**✎Note: **If HLword enters any other value, it will be treated as invalid.
146 -)))
153 + Demo:  Reads a 32-bit floating-point number at position D0 of PLC
147 147  
148 -== **addr_getshort(string addr[, number type, number hlword])** ==
149 149  
150 -**Function:** Read 16-bit signed decimal address
156 +(% style="text-align:center" %)
157 +[[image:企业微信截图_20210506180640.png||class="img-thumbnail" height="301" width="600"]]
151 151  
159 +== **2.1 addr_getshort(string addr[, number type, number hlword])** ==
160 +
161 +**Function:**
162 +
163 +Read 16-bit signed decimal address
164 +
152 152  **Parameters:**
153 153  
154 154  //addr//: address
... ... @@ -166,11 +166,13 @@
166 166  Failed: multi
167 167  
168 168  (((
169 -== **addr_setshort(string addr, number num[, number type, number hlword])** ==
182 +== **2.2 addr_setshort(string addr, number num[, number type, number hlword])** ==
170 170  )))
171 171  
172 -**Function:** Write 16-bit signed decimal address
185 +**Function:**
173 173  
187 +Write 16-bit signed decimal address
188 +
174 174  **Parameters:**
175 175  
176 176  //addr//: address
... ... @@ -188,11 +188,13 @@
188 188  Failed: multi
189 189  
190 190  (((
191 -== **addr_getword(string addr[, number type, number hlword])** ==
206 +== **2.3 addr_getword(string addr[, number type, number hlword])** ==
192 192  )))
193 193  
194 -**Function:** Read 16-bit unsigned decimal address
209 +**Function:**
195 195  
211 +{{id name="OLE_LINK6"/}}Read 16-bit unsigned decimal address
212 +
196 196  **Parameters:**
197 197  
198 198  //addr//: address
... ... @@ -208,11 +208,13 @@
208 208  Failed: multi
209 209  
210 210  (((
211 -== **addr_setword(string addr, number num[, number type, number hlword])** ==
228 +== **2.4 addr_setword(string addr, number num[, number type, number hlword])** ==
212 212  )))
213 213  
214 -**Function:**Write 16-bit unsigned decimal address
231 +**Function:**
215 215  
233 +Write 16-bit unsigned decimal address
234 +
216 216  **Parameters:**
217 217  
218 218  //addr//: address
... ... @@ -230,11 +230,13 @@
230 230  Failed: multi
231 231  
232 232  (((
233 -== **addr_getint(string addr[, number type, number hlword])** ==
252 +== **2.5 addr_getint(string addr[, number type, number hlword])** ==
234 234  )))
235 235  
236 -**Function:** Read 32-bit signed decimal address
255 +**Function:**
237 237  
257 +Read 32-bit signed decimal address
258 +
238 238  **Parameters:**
239 239  
240 240  //addr//: address
... ... @@ -250,11 +250,13 @@
250 250  Failed: multi
251 251  
252 252  (((
253 -== **addr_setint(string addr, number num[, number type, number hlword])** ==
274 +== **2.6 addr_setint(string addr, number num[, number type, number hlword])** ==
254 254  )))
255 255  
256 -**Function:** Write 32-bit signed decimal address
277 +**Function:**
257 257  
279 +Write 32-bit signed decimal address
280 +
258 258  **Parameters:**
259 259  
260 260  //addr//: address
... ... @@ -272,11 +272,13 @@
272 272  Failed: multi
273 273  
274 274  (((
275 -== **addr_getdword(string addr[, number type, number hlword])** ==
298 +== **2.7 addr_getdword(string addr[, number type, number hlword])** ==
276 276  )))
277 277  
278 -**Function:** Read 32-bit unsigned decimal address
301 +**Function:**
279 279  
303 +{{id name="OLE_LINK7"/}}Read 32-bit unsigned decimal address
304 +
280 280  **Parameters:**
281 281  
282 282  //addr//: address
... ... @@ -292,11 +292,13 @@
292 292  Failed: multi
293 293  
294 294  (((
295 -== **addr_setdword(string addr, number num[, number type, number hlword])** ==
320 +== **2.8 addr_setdword(string addr, number num[, number type, number hlword])** ==
296 296  )))
297 297  
298 -**Function:** Write 32-bit unsigned decimal address
323 +**Function:**
299 299  
325 +Write 32-bit unsigned decimal address
326 +
300 300  **Parameters:**
301 301  
302 302  //addr//: address
... ... @@ -314,11 +314,13 @@
314 314  Failed: multi
315 315  
316 316  (((
317 -== **addr_getbit(string addr[, number type])** ==
344 +== **2.9 addr_getbit(string addr[, number type])** ==
318 318  )))
319 319  
320 -**Function:** Read a bit of the register address
347 +**Function:**
321 321  
349 +Read a bit of the register address
350 +
322 322  **Parameters:**
323 323  
324 324  //addr//: address
... ... @@ -334,11 +334,13 @@
334 334  Failed: multi
335 335  
336 336  (((
337 -== **addr_setbit(string addr, number num[, number type])** ==
366 +== **2.10 addr_setbit(string addr, number num[, number type])** ==
338 338  )))
339 339  
340 -**Function:** Write a bit of the register address
369 +**Function:**
341 341  
371 +Write a bit of the register address
372 +
342 342  **Parameters:**
343 343  
344 344  //addr//: address
... ... @@ -345,7 +345,7 @@
345 345  
346 346  //num//: value
347 347  
348 -[type = 0]not read through 1: read through
379 +{{id name="OLE_LINK8"/}}[type = 0]not read through 1: read through
349 349  
350 350  [hlword = 0]  Don't convert,See Form 2.1
351 351  
... ... @@ -356,11 +356,13 @@
356 356  Failed: multi
357 357  
358 358  (((
359 -== **addr_getfloat(string addr[, number type, number hlword])** ==
390 +== **2.11 addr_getfloat(string addr[, number type, number hlword])** ==
360 360  )))
361 361  
362 -**Function:** Read 32-bit floating address
393 +**Function:**
363 363  
395 +Read 32-bit floating address
396 +
364 364  **Parameters:**
365 365  
366 366  //addr//: address
... ... @@ -376,11 +376,13 @@
376 376  Failed: multi
377 377  
378 378  (((
379 -== **addr_setfloat(string addr, number num[, number type, number hlword])** ==
412 +== **2.12 addr_setfloat(string addr, number num[, number type, number hlword])** ==
380 380  )))
381 381  
382 -**Function:** Write 32-bit floating address
415 +**Function:**
383 383  
417 +Write 32-bit floating address
418 +
384 384  **Parameters:**
385 385  
386 386  //addr//: address
... ... @@ -398,11 +398,13 @@
398 398  Failed: multi
399 399  
400 400  (((
401 -== **addr_getdouble(string addr[, number type, number hlword])** ==
436 +== **2.13 addr_getdouble(string addr[, number type, number hlword])** ==
402 402  )))
403 403  
404 -**Function:** Read 64-bit floating address
439 +**Function:**
405 405  
441 +Read 64-bit floating address
442 +
406 406  **Parameters:**
407 407  
408 408  //addr//: address
... ... @@ -418,11 +418,13 @@
418 418  Failed: multi
419 419  
420 420  (((
421 -== **addr_setdouble(string addr, number num[, number type, number hlword])** ==
458 +== **2.14 addr_setdouble(string addr, number num[, number type, number hlword])** ==
422 422  )))
423 423  
424 -**Function:** Write 64-bit floating address
461 +**Function:**
425 425  
463 +Write 64-bit floating address
464 +
426 426  **Parameters:**
427 427  
428 428  addr: address
... ... @@ -440,11 +440,13 @@
440 440  Failed: multi
441 441  
442 442  (((
443 -== **addr_getstring(string addr, number length[, number type, number hlbyte])** ==
482 +== **2.15 addr_getstring(string addr, number length[, number type, number hlbyte])** ==
444 444  )))
445 445  
446 -**Function:** Read the specified length string from address
485 +**Function:**
447 447  
487 +Read the specified length string from address
488 +
448 448  **Parameters:**
449 449  
450 450  //addr//: address
... ... @@ -462,11 +462,13 @@
462 462  Failed: multi
463 463  
464 464  (((
465 -== **addr_setstring(string addr, string str[, number type, number hlbyte])** ==
506 +== **2.16 addr_setstring(string addr, string str[, number type, number hlbyte])** ==
466 466  )))
467 467  
468 -**Function:** Write the specified length string to address
509 +**Function:**
469 469  
511 +Write the specified length string to address
512 +
470 470  **Parameters:**
471 471  
472 472  //addr//: address
... ... @@ -484,11 +484,13 @@
484 484  Failed: multi
485 485  
486 486  (((
487 -== **addr_bmov(string dst, string src, number length)** ==
530 +== **2.17 addr_bmov(string dst, string src, number length)** ==
488 488  )))
489 489  
490 -**Function:** Copy data from source address to destination address
533 +**Function:**
491 491  
535 +Copy data from source address to destination address
536 +
492 492  **Parameters:**
493 493  
494 494  //dst//: destination address
... ... @@ -504,11 +504,13 @@
504 504  **Failed: multi**
505 505  
506 506  (((
507 -== **addr_fill(string addr, number num, number length)** ==
552 +== **2.18 addr_fill(string addr, number num, number length)** ==
508 508  )))
509 509  
510 -**Function:** Write the same value to consecutive addresses
555 +**Function:**
511 511  
557 +Write the same value to consecutive addresses
558 +
512 512  **Parameters:**
513 513  
514 514  //addr//: address
... ... @@ -524,11 +524,13 @@
524 524  Failed: multi
525 525  
526 526  (((
527 -== **addr_newnoaddr(string addr, number offset)** ==
574 +== **2.19 addr_newnoaddr(string addr, number offset)** ==
528 528  )))
529 529  
530 -**Function:** Offset address value relative to //addr//
577 +**Function:**
531 531  
579 +Offset address value relative to //addr//
580 +
532 532  **Parameters:**
533 533  
534 534  //addr//: address
... ... @@ -542,11 +542,13 @@
542 542  Failed: multi
543 543  
544 544  (((
545 -== **addr_newstataddr(string addr, number offset)** ==
594 +== **2.20 addr_newstataddr(string addr, number offset)** ==
546 546  )))
547 547  
548 -**Function:** Offset station number relative to //addr //station number
597 +**Function:**
549 549  
599 +Offset station number relative to //addr //station number
600 +
550 550  **Parameters:**
551 551  
552 552  //addr//: address
... ... @@ -559,10 +559,12 @@
559 559  
560 560  Failed: multi
561 561  
562 -== **addr_gethex64(string addr[, number type, number hlword])** ==
613 +== **2.21 addr_gethex64(string addr[, number type, number hlword])** ==
563 563  
564 -**Function:** Read 64-bit hexadecimal numbers
615 +**Function:**
565 565  
617 +Read 64-bit hexadecimal numbers
618 +
566 566  **Parameters:**
567 567  
568 568  //addr//: address
... ... @@ -577,10 +577,12 @@
577 577  
578 578  Failed: multi
579 579  
580 -== **addr_sethex64(string addr, number num[, number type, number hlword])** ==
633 +== **2.22 addr_sethex64(string addr, number num[, number type, number hlword])** ==
581 581  
582 -**Function:** Write 64-bit hexadecimal addresses
635 +**Function:**
583 583  
637 +Write 64-bit hexadecimal addresses
638 +
584 584  **Parameters:**
585 585  
586 586  //addr//: address
... ... @@ -601,11 +601,11 @@
601 601  
602 602  Operations on the serial port such as read, write, etc. must use ':' for full mode calls, ie operations on an open serial object.
603 603  
604 -**Serial port name and mode**
659 +**Serial port name and mode:**
605 605  
606 606  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.
607 607  
608 -Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below.
663 +Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below
609 609  
610 610  |(((
611 611  local setup = {
... ... @@ -627,11 +627,13 @@
627 627  1. When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.
628 628  
629 629  (((
630 -== **serial.open(table setup)** ==
685 +== **3.1 serial.open(table setup)** ==
631 631  )))
632 632  
633 -**Function:** Enable one serial port
688 +**Function:**
634 634  
690 +Enable one serial port
691 +
635 635  **Parameters:**
636 636  
637 637  //Setup// is a Lua table; it needs to contain the following fields
... ... @@ -665,13 +665,17 @@
665 665  Failed: multi
666 666  
667 667  (((
668 -== **serial.close(serial obj)** ==
725 +== **3.2 serial.close(serial obj)** ==
669 669  )))
670 670  
671 -**Function:** Disable the serial port
728 +**Function:**
672 672  
673 -**Parameters: **//Obj //is the object returned by serial.open
730 +Disable the serial port
674 674  
732 +**Parameters:**
733 +
734 +//Obj //is the object returned by serial.open
735 +
675 675  **Return:**
676 676  
677 677  Succeed: true
... ... @@ -679,11 +679,13 @@
679 679  Failed: multi
680 680  
681 681  (((
682 -== **serial:read(number bytes[, number timeout])** ==
743 +== **3.3 serial:read(number bytes[, number timeout])** ==
683 683  )))
684 684  
685 -**Function:** Read the specified byte length serial port data
746 +**Function:**
686 686  
748 +Read the specified byte length serial port data
749 +
687 687  **Parameters:**
688 688  
689 689  //bytes//: number of bytes
... ... @@ -697,13 +697,15 @@
697 697  Failed: multi
698 698  
699 699  (((
700 -== **serial:write(string data)** ==
763 +== **3.4 serial:write(string data)** ==
701 701  )))
702 702  
703 -**Function:** Write the specified byte length to serial port data
766 +**Function:**
704 704  
705 -**Parameters: **
768 +Write the specified byte length to serial port data
706 706  
770 +**Parameters:**
771 +
707 707  //data//: serial port data
708 708  
709 709  **Return:**
... ... @@ -713,11 +713,13 @@
713 713  Failed: multi
714 714  
715 715  (((
716 -== **serial:flush([number flag])** ==
781 +== **3.5 serial:flush([number flag])** ==
717 717  )))
718 718  
719 -**Function:** Clear the serial port buffer
784 +**Function:**
720 720  
786 +Clear the serial port buffer
787 +
721 721  **Parameters:**
722 722  
723 723  //[flag=2]// clear option: 0: read, 1: write, 2: read-write
... ... @@ -729,13 +729,17 @@
729 729  Failed: multi
730 730  
731 731  (((
732 -== **serial:close()** ==
799 +== **3.6 serial:close()** ==
733 733  )))
734 734  
735 -**Function:** Close the serial port object
802 +**Function:**
736 736  
737 -**Parameters:** None
804 +Close the serial port object
738 738  
806 +**Parameters:**
807 +
808 +None
809 +
739 739  **Return:**
740 740  
741 741  Succeed: true
... ... @@ -752,10 +752,12 @@
752 752  
753 753  **QoS value:**
754 754  
755 -* 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.
756 -* 1: The message is delivered at least once, but the message may be delivered repeatedly.
757 -* 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.
826 +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.
758 758  
828 +1: The message is delivered at least once, but the message may be delivered repeatedly.
829 +
830 +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.
831 +
759 759  **Retain flag:**
760 760  
761 761  0: not reserved;
... ... @@ -763,11 +763,13 @@
763 763  1: reserved
764 764  
765 765  (((
766 -== **mqtt.create(string serverurl, string clientid)** ==
839 +== **4.1 mqtt.create(string serverurl, string clientid)** ==
767 767  )))
768 768  
769 -**Function:** Create an MQTT object
842 +**Function:**
770 770  
844 +Create an MQTT object
845 +
771 771  **Parameters:**
772 772  
773 773  //serverurl //Server url
... ... @@ -789,13 +789,17 @@
789 789  Failed: multi
790 790  
791 791  (((
792 -== **mqtt.close(mqtt obj)** ==
867 +== **4.2 mqtt.close(mqtt obj)** ==
793 793  )))
794 794  
795 -**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)
870 +**Function:**
796 796  
797 -**Parameters: **//Obj //ithe objeced returned by mqtt.create
872 +Close the specified MQTT object (if the connected server will be disconnected automatically)
798 798  
874 +**Parameters:**
875 +
876 +//Obj //is the objeced returned by mqtt.create
877 +
799 799  **Return:**
800 800  
801 801  Succeed: true
... ... @@ -803,25 +803,32 @@
803 803  Failed: multi
804 804  
805 805  (((
806 -== **mqtt:connect(table conn[, table lwt, table cart])** ==
885 +== **4.3 mqtt:connect(table conn[, table lwt, table cart])** ==
807 807  )))
808 808  
809 -**Function:**Establish a connection to the server
888 +**Function:**
810 810  
890 +Establish a connection to the server
891 +
811 811  **Parameters:**
812 812  
813 813  //conn //is a Lua table and needs to contain the following fields
814 814  
815 -* //string conn.username//, user name
816 -* //string conn.password//, password
817 -* //number [conn.netway=0]//, networking method, if set error number will use Ethernet method
818 -** 0: Ethernet
819 -** 1: WIFI
820 -** 2: 4G
821 -** 3: 2G
822 -* //number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
823 -* //number [conn.cleansession=1]//, empty the session as described below:
896 +//string conn.username//, user name
824 824  
898 +//string conn.password//, password
899 +
900 +//number [conn.netway=0]//, networking method, if set error number will use Ethernet method
901 +
902 +* 0: Ethernet
903 +* 1: WIFI
904 +* 2: 4G
905 +* 3: 2G
906 +
907 +//number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
908 +
909 +//number [conn.cleansession=1]//, empty the session as described below:
910 +
825 825  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:
826 826  
827 827  * 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.
... ... @@ -829,11 +829,14 @@
829 829  
830 830  //lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields
831 831  
832 -* //string lwt.topic//, topic
833 -* //string lwt.message//, message
834 -* //number [lwt.qos=0]//, qos value
835 -* //number [lwt.retain=0]//, retain flag
918 +//string lwt.topic//, topic
836 836  
920 +//string lwt.message//, message
921 +
922 +//number [lwt.qos=0]//, qos value
923 +
924 +//number [lwt.retain=0]//, retain flag
925 +
837 837  **Return:**
838 838  
839 839  Succeed: true
... ... @@ -841,13 +841,17 @@
841 841  Failed: multi
842 842  
843 843  (((
844 -== **mqtt:disconnect([number timeout])** ==
933 +== **4.4 mqtt:disconnect([number timeout])** ==
845 845  )))
846 846  
847 -**Function:** Disconnect from the MQTT server
936 +**Function:**
848 848  
849 -**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
938 +Disconnect from the MQTT server
850 850  
940 +**Parameters:**
941 +
942 +//[timeout=10000] //Disconnect waiting timeout, in milliseconds
943 +
851 851  **Return:**
852 852  
853 853  Succeed: true
... ... @@ -855,13 +855,17 @@
855 855  Failed: multi
856 856  
857 857  (((
858 -== **mqtt:isconnected()** ==
951 +== **4.5 mqtt:isconnected()** ==
859 859  )))
860 860  
861 -**Function:** Test whether or not a client is currently connected to the MQTT server
954 +**Function:**
862 862  
863 -**Parameters:** None
956 +Test whether or not a client is currently connected to the MQTT server
864 864  
958 +**Parameters:**
959 +
960 +None
961 +
865 865  **Return:**
866 866  
867 867  Succeed: true ~-~-Connected
... ... @@ -869,11 +869,13 @@
869 869  Failed: false ~-~- Unconnected and other unknowns
870 870  
871 871  (((
872 -== **mqtt:subscribe(string topic, number qos)** ==
969 +== **4.6 mqtt:subscribe(string topic, number qos)** ==
873 873  )))
874 874  
875 -**Function: **Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
972 +**Function:**
876 876  
974 +Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
975 +
877 877  **Parameters:**
878 878  
879 879  //topic//, topic name
... ... @@ -887,11 +887,13 @@
887 887  Failed: multi
888 888  
889 889  (((
890 -== **mqtt:unsubscribe(string topic)** ==
989 +== **4.7 mqtt:unsubscribe(string topic)** ==
891 891  )))
892 892  
893 -**Function:** Unsubscribe topic
992 +**Function:**
894 894  
994 +Unsubscribe topic
995 +
895 895  **Parameters:**
896 896  
897 897  //topic//, topic name
... ... @@ -903,11 +903,13 @@
903 903  Failed: multi
904 904  
905 905  (((
906 -== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
1007 +== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
907 907  )))
908 908  
909 -**Function:** Publish message
1010 +**Function:**
910 910  
1012 +Publish message
1013 +
911 911  **Parameters:**
912 912  
913 913  //topic//, topic name
... ... @@ -927,13 +927,17 @@
927 927  Failed: multi
928 928  
929 929  (((
930 -== **mqtt:close()** ==
1033 +== **4.9 mqtt:close()** ==
931 931  )))
932 932  
933 -**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)
1036 +**Function:**
934 934  
935 -**Parameters:** None
1038 +Close the mqtt object (the connection to the server will be automatically disconnected)
936 936  
1040 +**Parameters:**
1041 +
1042 +None
1043 +
937 937  **Return:**
938 938  
939 939  Succeed: true
... ... @@ -941,11 +941,13 @@
941 941  Failed: multi
942 942  
943 943  (((
944 -== **mqtt:on(string method, function callback)** ==
1051 +== **4.10 mqtt:on(string method, function callback)** ==
945 945  )))
946 946  
947 -**Function:** Register event callback function
1054 +**Function:**
948 948  
1056 +Register event callback function
1057 +
949 949  **Parameters:**
950 950  
951 951  //method//, It can be message/arrived/offline, these 3 types of events
... ... @@ -1391,7 +1391,7 @@
1391 1391  
1392 1392  **✎Note: **
1393 1393  
1394 -//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).
1503 +//{{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).
1395 1395  
1396 1396  //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.
1397 1397  
... ... @@ -1734,7 +1734,7 @@
1734 1734  Faied: multi
1735 1735  
1736 1736  (((
1737 -== **9.7 remote_com_start(string config)** ==
1846 +== **9.7 {{id name="_Toc22969"/}}remote_com_start(string config)** ==
1738 1738  )))
1739 1739  
1740 1740  **Function:**
... ... @@ -1774,7 +1774,7 @@
1774 1774  Failed: multi
1775 1775  
1776 1776  (((
1777 -== **9.9 remote_com_state()** ==
1886 +== **9.9{{id name="_Toc22824"/}} remote_com_state()** ==
1778 1778  )))
1779 1779  
1780 1780  **Function:**
... ... @@ -1788,4 +1788,4 @@
1788 1788  1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
1789 1789  1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
1790 1790  
1791 -Failed: multi
1900 +{{id name="OLE_LINK9"/}}Failed: multi