Changes for page 01 Lua Functions

Summary

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

Details

Page properties

Title

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

Parent

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

Author

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

Content

...	...	@@ -1,70 +1,66 @@
1		-= **1 Interface Description** =
	1	+= **1 Interface description** =
2	2
3		-== **1.1 Data type definition** ==
	3	+== **Data type definition** ==
4	4
5		-
6	6	|=**Type**|=**Description**
7	7	|=nil|Null
8		-|=boolean|Boolean, the value is true or false
9		-|=number|Integer or floating point, signed or unsigned
	7	+|=boolean|Boolean (the value is true or false)
	8	+|=number|Integer or floating point (signed or unsigned)
10	10	|=string|String
11	11	|=table|Table
12	12	|=function|Functions
13	13
14		-== **1.2 Built-in function library clipping** ==
	13	+== **Built-in function library clipping** ==
15	15
16	16	Full features supported: coroutine/debug/ math/ package/ string/ table/ utf8
17	17
18		-//,,Some features supported (available in []):** **os[clock/ date/ difftime/ time],,//
	17	+//Some features supported (available in []):** **os[clock/ date/ difftime/ time]//
19	19
20		-//,,Not supported: io/ file,,//
	19	+//Not supported: io/ file//
21	21
22		-== **1.3 Return value description** ==
	21	+== **Return value description** ==
23	23
24	24	The function return type multi means multiple return values (at least 2), usually:
25	25
26		-//,,1st: nil;,,//
	25	+//1st: nil//
27	27
28		-//,,2nd: the error message;,,//
	27	+//2nd: the error message//
29	29
30	30	(((
31		-== **1.4 Function parameter description** ==
	30	+== **Function parameter description** ==
32	32	)))
33	33
34		-**Assume the function prototype:**
	33	+Suppose a function prototype is defined:
35	35
36		-|(((
37		-//student(string name, number age[, number class])//
	35	+{{code language="LUA"}}
	36	+student(string name, number age[, number class])
38	38
39		-**Function:**
	38	+Function:
40	40
41	41	Register a student
42	42
43		-**Parameters:**
	42	+Parameters:
44	44
45		-//name//: student name
	44	+name: student name
46	46
47		-//age//: student age
	46	+age: student age
48	48
49		-//[class=1]//: Student class
	48	+[class=1]: Student class
50	50
51		-**Return：**
	50	+Return：
52	52
53	53	Succeed: true
54	54
55	55	Failed: multi
56		-)))
	55	+{{/code}}
57	57
58		-**Comment**
	57	+**Explanation**
59	59
60		-1.string name indicates that the first parameter name is a string
	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.**
61	61
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		-
68	68	**Call example**
69	69
70	70	|(((
...	...	@@ -93,75 +93,66 @@
93	93
94	94	**Comment**
95	95
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.
	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.
97	97
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.
	95	+== **Modification of print function** ==
99	99
100		-== **1.5 Modification of the Print Function** ==
	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.
101	101
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:
	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;
103	103
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		-
110	110	Users should pay attention to avoid printing a lot of useless information, should minimize the debug output
111	111
112	112	In addition, please refer to the front-end documentation for how to use view debugging.
113	113
114	114	(((
115		-= **2 Address Operation** =
116		-
117		-**~ Form 2.1**
	108	+= **2 Address operation** =
118	118	)))
119	119
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
	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
126	126	)))
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
	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
150	150
151		-* If HLword enters any other value, it will be treated as invalid.
	141	+ Table 2-1
152	152
153		- Demo:  Reads a 32-bit floating-point number at position D0 of PLC
	143	+(% class="box infomessage" %)
	144	+(((
	145	+**✎Note: **If HLword enters any other value, it will be treated as invalid.
	146	+)))
154	154
	148	+== **addr_getshort(string addr[, number type, number hlword])** ==
155	155
156		-(% style="text-align:center" %)
157		-[[image:企业微信截图_20210506180640.png||class="img-thumbnail" height="301" width="600"]]
	150	+**Function:** Read 16-bit signed decimal address
158	158
159		-== **2.1 addr_getshort(string addr[, number type, number hlword])** ==
160		-
161		-**Function:**
162		-
163		-Read 16-bit signed decimal address
164		-
165	165	**Parameters:**
166	166
167	167	//addr//: address
...	...	@@ -179,13 +179,11 @@
179	179	Failed: multi
180	180
181	181	(((
182		-== **2.2 addr_setshort(string addr, number num[, number type, number hlword])** ==
	169	+== **addr_setshort(string addr, number num[, number type, number hlword])** ==
183	183	)))
184	184
185		-**Function:**
	172	+**Function:** Write 16-bit signed decimal address
186	186
187		-Write 16-bit signed decimal address
188		-
189	189	**Parameters:**
190	190
191	191	//addr//: address
...	...	@@ -203,13 +203,11 @@
203	203	Failed: multi
204	204
205	205	(((
206		-== **2.3 addr_getword(string addr[, number type, number hlword])** ==
	191	+== **addr_getword(string addr[, number type, number hlword])** ==
207	207	)))
208	208
209		-**Function:**
	194	+**Function:** Read 16-bit unsigned decimal address
210	210
211		-{{id name="OLE_LINK6"/}}Read 16-bit unsigned decimal address
212		-
213	213	**Parameters:**
214	214
215	215	//addr//: address
...	...	@@ -225,13 +225,11 @@
225	225	Failed: multi
226	226
227	227	(((
228		-== **2.4 addr_setword(string addr, number num[, number type, number hlword])** ==
	211	+== **addr_setword(string addr, number num[, number type, number hlword])** ==
229	229	)))
230	230
231		-**Function:**
	214	+**Function:**Write 16-bit unsigned decimal address
232	232
233		-Write 16-bit unsigned decimal address
234		-
235	235	**Parameters:**
236	236
237	237	//addr//: address
...	...	@@ -249,13 +249,11 @@
249	249	Failed: multi
250	250
251	251	(((
252		-== **2.5 addr_getint(string addr[, number type, number hlword])** ==
	233	+== **addr_getint(string addr[, number type, number hlword])** ==
253	253	)))
254	254
255		-**Function:**
	236	+**Function:** Read 32-bit signed decimal address
256	256
257		-Read 32-bit signed decimal address
258		-
259	259	**Parameters:**
260	260
261	261	//addr//: address
...	...	@@ -271,13 +271,11 @@
271	271	Failed: multi
272	272
273	273	(((
274		-== **2.6 addr_setint(string addr, number num[, number type, number hlword])** ==
	253	+== **addr_setint(string addr, number num[, number type, number hlword])** ==
275	275	)))
276	276
277		-**Function:**
	256	+**Function:** Write 32-bit signed decimal address
278	278
279		-Write 32-bit signed decimal address
280		-
281	281	**Parameters:**
282	282
283	283	//addr//: address
...	...	@@ -295,13 +295,11 @@
295	295	Failed: multi
296	296
297	297	(((
298		-== **2.7 addr_getdword(string addr[, number type, number hlword])** ==
	275	+== **addr_getdword(string addr[, number type, number hlword])** ==
299	299	)))
300	300
301		-**Function:**
	278	+**Function:** Read 32-bit unsigned decimal address
302	302
303		-{{id name="OLE_LINK7"/}}Read 32-bit unsigned decimal address
304		-
305	305	**Parameters:**
306	306
307	307	//addr//: address
...	...	@@ -317,13 +317,11 @@
317	317	Failed: multi
318	318
319	319	(((
320		-== **2.8 addr_setdword(string addr, number num[, number type, number hlword])** ==
	295	+== **addr_setdword(string addr, number num[, number type, number hlword])** ==
321	321	)))
322	322
323		-**Function:**
	298	+**Function:** Write 32-bit unsigned decimal address
324	324
325		-Write 32-bit unsigned decimal address
326		-
327	327	**Parameters:**
328	328
329	329	//addr//: address
...	...	@@ -341,13 +341,11 @@
341	341	Failed: multi
342	342
343	343	(((
344		-== **2.9 addr_getbit(string addr[, number type])** ==
	317	+== **addr_getbit(string addr[, number type])** ==
345	345	)))
346	346
347		-**Function:**
	320	+**Function:** Read a bit of the register address
348	348
349		-Read a bit of the register address
350		-
351	351	**Parameters:**
352	352
353	353	//addr//: address
...	...	@@ -363,13 +363,11 @@
363	363	Failed: multi
364	364
365	365	(((
366		-== **2.10 addr_setbit(string addr, number num[, number type])** ==
	337	+== **addr_setbit(string addr, number num[, number type])** ==
367	367	)))
368	368
369		-**Function:**
	340	+**Function:** Write a bit of the register address
370	370
371		-Write a bit of the register address
372		-
373	373	**Parameters:**
374	374
375	375	//addr//: address
...	...	@@ -376,7 +376,7 @@
376	376
377	377	//num//: value
378	378
379		-{{id name="OLE_LINK8"/}}[type = 0]not read through 1: read through
	348	+[type = 0]not read through 1: read through
380	380
381	381	[hlword = 0]  Don't convert，See Form 2.1
382	382
...	...	@@ -387,13 +387,11 @@
387	387	Failed: multi
388	388
389	389	(((
390		-== **2.11 addr_getfloat(string addr[, number type, number hlword])** ==
	359	+== **addr_getfloat(string addr[, number type, number hlword])** ==
391	391	)))
392	392
393		-**Function:**
	362	+**Function:** Read 32-bit floating address
394	394
395		-Read 32-bit floating address
396		-
397	397	**Parameters:**
398	398
399	399	//addr//: address
...	...	@@ -409,13 +409,11 @@
409	409	Failed: multi
410	410
411	411	(((
412		-== **2.12 addr_setfloat(string addr, number num[, number type, number hlword])** ==
	379	+== **addr_setfloat(string addr, number num[, number type, number hlword])** ==
413	413	)))
414	414
415		-**Function:**
	382	+**Function:** Write 32-bit floating address
416	416
417		-Write 32-bit floating address
418		-
419	419	**Parameters:**
420	420
421	421	//addr//: address
...	...	@@ -433,13 +433,11 @@
433	433	Failed: multi
434	434
435	435	(((
436		-== **2.13 addr_getdouble(string addr[, number type, number hlword])** ==
	401	+== **addr_getdouble(string addr[, number type, number hlword])** ==
437	437	)))
438	438
439		-**Function:**
	404	+**Function:** Read 64-bit floating address
440	440
441		-Read 64-bit floating address
442		-
443	443	**Parameters:**
444	444
445	445	//addr//: address
...	...	@@ -455,13 +455,11 @@
455	455	Failed: multi
456	456
457	457	(((
458		-== **2.14 addr_setdouble(string addr, number num[, number type, number hlword])** ==
	421	+== **addr_setdouble(string addr, number num[, number type, number hlword])** ==
459	459	)))
460	460
461		-**Function:**
	424	+**Function:** Write 64-bit floating address
462	462
463		-Write 64-bit floating address
464		-
465	465	**Parameters:**
466	466
467	467	addr: address
...	...	@@ -479,13 +479,11 @@
479	479	Failed: multi
480	480
481	481	(((
482		-== **2.15 addr_getstring(string addr, number length[, number type, number hlbyte])** ==
	443	+== **addr_getstring(string addr, number length[, number type, number hlbyte])** ==
483	483	)))
484	484
485		-**Function:**
	446	+**Function:** Read the specified length string from address
486	486
487		-Read the specified length string from address
488		-
489	489	**Parameters:**
490	490
491	491	//addr//: address
...	...	@@ -503,13 +503,11 @@
503	503	Failed: multi
504	504
505	505	(((
506		-== **2.16 addr_setstring(string addr, string str[, number type, number hlbyte])** ==
	465	+== **addr_setstring(string addr, string str[, number type, number hlbyte])** ==
507	507	)))
508	508
509		-**Function:**
	468	+**Function:** Write the specified length string to address
510	510
511		-Write the specified length string to address
512		-
513	513	**Parameters:**
514	514
515	515	//addr//: address
...	...	@@ -527,13 +527,11 @@
527	527	Failed: multi
528	528
529	529	(((
530		-== **2.17 addr_bmov(string dst, string src, number length)** ==
	487	+== **addr_bmov(string dst, string src, number length)** ==
531	531	)))
532	532
533		-**Function:**
	490	+**Function:** Copy data from source address to destination address
534	534
535		-Copy data from source address to destination address
536		-
537	537	**Parameters:**
538	538
539	539	//dst//: destination address
...	...	@@ -549,13 +549,11 @@
549	549	**Failed: multi**
550	550
551	551	(((
552		-== **2.18 addr_fill(string addr, number num, number length)** ==
	507	+== **addr_fill(string addr, number num, number length)** ==
553	553	)))
554	554
555		-**Function:**
	510	+**Function:** Write the same value to consecutive addresses
556	556
557		-Write the same value to consecutive addresses
558		-
559	559	**Parameters:**
560	560
561	561	//addr//: address
...	...	@@ -571,13 +571,11 @@
571	571	Failed: multi
572	572
573	573	(((
574		-== **2.19 addr_newnoaddr(string addr, number offset)** ==
	527	+== **addr_newnoaddr(string addr, number offset)** ==
575	575	)))
576	576
577		-**Function:**
	530	+**Function:** Offset address value relative to //addr//
578	578
579		-Offset address value relative to //addr//
580		-
581	581	**Parameters:**
582	582
583	583	//addr//: address
...	...	@@ -591,13 +591,11 @@
591	591	Failed: multi
592	592
593	593	(((
594		-== **2.20 addr_newstataddr(string addr, number offset)** ==
	545	+== **addr_newstataddr(string addr, number offset)** ==
595	595	)))
596	596
597		-**Function:**
	548	+**Function:** Offset station number relative to //addr //station number
598	598
599		-Offset station number relative to //addr //station number
600		-
601	601	**Parameters:**
602	602
603	603	//addr//: address
...	...	@@ -610,12 +610,10 @@
610	610
611	611	Failed: multi
612	612
613		-== **2.21 addr_gethex64(string addr[, number type, number hlword])** ==
	562	+== **addr_gethex64(string addr[, number type, number hlword])** ==
614	614
615		-**Function:**
	564	+**Function:** Read 64-bit hexadecimal numbers
616	616
617		-Read 64-bit hexadecimal numbers
618		-
619	619	**Parameters:**
620	620
621	621	//addr//: address
...	...	@@ -630,12 +630,10 @@
630	630
631	631	Failed: multi
632	632
633		-== **2.22 addr_sethex64(string addr, number num[, number type, number hlword])** ==
	580	+== **addr_sethex64(string addr, number num[, number type, number hlword])** ==
634	634
635		-**Function:**
	582	+**Function:** Write 64-bit hexadecimal addresses
636	636
637		-Write 64-bit hexadecimal addresses
638		-
639	639	**Parameters:**
640	640
641	641	//addr//: address
...	...	@@ -656,18 +656,19 @@
656	656
657	657	Operations on the serial port such as read, write, etc. must use ':' for full mode calls, ie operations on an open serial object.
658	658
659		-**Serial port name and mode:**
	604	+**Serial port name and mode**
660	660
661	661	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.
662	662
663		-Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below
	608	+Attempting to use a script to open a serial port in an unsupported mode will result in an error directly, as below.
664	664
665	665	|(((
	611	+{{code language="LUA"}}
666	666	local setup = {
667	667
668	668	name = "COM2",
669	669
670		-mode = 422, ~-~- COM2 does not support RS422
	616	+mode = 422, -- COM2 does not support RS422
671	671
672	672	...
673	673
...	...	@@ -674,6 +674,7 @@
674	674	}
675	675
676	676	serial.open(setup)
	623	+{{/code}}
677	677	)))
678	678
679	679	**Data bit:**
...	...	@@ -682,13 +682,11 @@
682	682	1. When the data bit is 8, the maximum value of data transmission is 255 (0xFF), which supports the transmission of any character.
683	683
684	684	(((
685		-== **3.1 serial.open(table setup)** ==
	632	+== **serial.open(table setup)** ==
686	686	)))
687	687
688		-**Function:**
	635	+**Function:** Enable one serial port
689	689
690		-Enable one serial port
691		-
692	692	**Parameters:**
693	693
694	694	//Setup// is a Lua table; it needs to contain the following fields
...	...	@@ -722,17 +722,13 @@
722	722	Failed: multi
723	723
724	724	(((
725		-== **3.2 serial.close(serial obj)** ==
	670	+== **serial.close(serial obj)** ==
726	726	)))
727	727
728		-**Function:**
	673	+**Function:** Disable the serial port
729	729
730		-Disable the serial port
	675	+**Parameters: **//Obj //is the object returned by serial.open
731	731
732		-**Parameters:**
733		-
734		-//Obj //is the object returned by serial.open
735		-
736	736	**Return：**
737	737
738	738	Succeed: true
...	...	@@ -740,13 +740,11 @@
740	740	Failed: multi
741	741
742	742	(((
743		-== **3.3 serial:read(number bytes[, number timeout])** ==
	684	+== **serial:read(number bytes[, number timeout])** ==
744	744	)))
745	745
746		-**Function:**
	687	+**Function:** Read the specified byte length serial port data
747	747
748		-Read the specified byte length serial port data
749		-
750	750	**Parameters:**
751	751
752	752	//bytes//: number of bytes
...	...	@@ -760,15 +760,13 @@
760	760	Failed: multi
761	761
762	762	(((
763		-== **3.4 serial:write(string data)** ==
	702	+== **serial:write(string data)** ==
764	764	)))
765	765
766		-**Function:**
	705	+**Function:** Write the specified byte length to serial port data
767	767
768		-Write the specified byte length to serial port data
	707	+**Parameters: **
769	769
770		-**Parameters:**
771		-
772	772	//data//: serial port data
773	773
774	774	**Return：**
...	...	@@ -778,13 +778,11 @@
778	778	Failed: multi
779	779
780	780	(((
781		-== **3.5 serial:flush([number flag])** ==
	718	+== **serial:flush([number flag])** ==
782	782	)))
783	783
784		-**Function:**
	721	+**Function:** Clear the serial port buffer
785	785
786		-Clear the serial port buffer
787		-
788	788	**Parameters:**
789	789
790	790	//[flag=2]// clear option: 0: read, 1: write, 2: read-write
...	...	@@ -796,17 +796,13 @@
796	796	Failed: multi
797	797
798	798	(((
799		-== **3.6 serial:close()** ==
	734	+== **serial:close()** ==
800	800	)))
801	801
802		-**Function:**
	737	+**Function:** Close the serial port object
803	803
804		-Close the serial port object
	739	+**Parameters:** None
805	805
806		-**Parameters:**
807		-
808		-None
809		-
810	810	**Return：**
811	811
812	812	Succeed: true
...	...	@@ -823,12 +823,10 @@
823	823
824	824	**QoS value:**
825	825
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.
	757	+* 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	+* 1: The message is delivered at least once, but the message may be delivered repeatedly.
	759	+* 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.
827	827
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		-
832	832	**Retain flag:**
833	833
834	834	0: not reserved;
...	...	@@ -836,13 +836,11 @@
836	836	1: reserved
837	837
838	838	(((
839		-== **4.1 mqtt.create(string serverurl, string clientid)** ==
	768	+== **mqtt.create(string serverurl, string clientid)** ==
840	840	)))
841	841
842		-**Function:**
	771	+**Function:** Create an MQTT object
843	843
844		-Create an MQTT object
845		-
846	846	**Parameters:**
847	847
848	848	//serverurl //Server url
...	...	@@ -864,17 +864,13 @@
864	864	Failed: multi
865	865
866	866	(((
867		-== **4.2 mqtt.close(mqtt obj)** ==
	794	+== **mqtt.close(mqtt obj)** ==
868	868	)))
869	869
870		-**Function:**
	797	+**Function:** Close the specified MQTT object (if the connected server will be disconnected automatically)
871	871
872		-Close the specified MQTT object (if the connected server will be disconnected automatically)
	799	+**Parameters: **//Obj //is the objeced returned by mqtt.create
873	873
874		-**Parameters:**
875		-
876		-//Obj //is the objeced returned by mqtt.create
877		-
878	878	**Return：**
879	879
880	880	Succeed: true
...	...	@@ -882,32 +882,25 @@
882	882	Failed: multi
883	883
884	884	(((
885		-== **4.3 mqtt:connect(table conn[, table lwt, table cart])** ==
	808	+== **mqtt:connect(table conn[, table lwt, table cart])** ==
886	886	)))
887	887
888		-**Function:**
	811	+**Function:**Establish a connection to the server
889	889
890		-Establish a connection to the server
891		-
892	892	**Parameters:**
893	893
894	894	//conn //is a Lua table and needs to contain the following fields
895	895
896		-//string conn.username//, user name
	817	+* //string conn.username//, user name
	818	+* //string conn.password//, password
	819	+* //number [conn.netway=0]//, networking method, if set error number will use Ethernet method
	820	+** 0: Ethernet
	821	+** 1: WIFI
	822	+** 2: 4G
	823	+** 3: 2G
	824	+* //number [conn.keepalive=60]//, keep connected heartbeat interval, in seconds
	825	+* //number [conn.cleansession=1]//, empty the session as described below:
897	897
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		-
911	911	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:
912	912
913	913	* 1 (Empty): If a session exists and is 1, the previous session messages on the client and server are emptied.
...	...	@@ -915,14 +915,11 @@
915	915
916	916	//lwt// (Last Will and Testament) is a Lua table and needs to contain the following fields
917	917
918		-//string lwt.topic//, topic
	834	+* //string lwt.topic//, topic
	835	+* //string lwt.message//, message
	836	+* //number [lwt.qos=0]//, qos value
	837	+* //number [lwt.retain=0]//, retain flag
919	919
920		-//string lwt.message//, message
921		-
922		-//number [lwt.qos=0]//, qos value
923		-
924		-//number [lwt.retain=0]//, retain flag
925		-
926	926	**Return：**
927	927
928	928	Succeed: true
...	...	@@ -930,17 +930,13 @@
930	930	Failed: multi
931	931
932	932	(((
933		-== **4.4 mqtt:disconnect([number timeout])** ==
	846	+== **mqtt:disconnect([number timeout])** ==
934	934	)))
935	935
936		-**Function:**
	849	+**Function:** Disconnect from the MQTT server
937	937
938		-Disconnect from the MQTT server
	851	+**Parameters: **//[timeout=10000] //Disconnect waiting timeout, in milliseconds
939	939
940		-**Parameters:**
941		-
942		-//[timeout=10000] //Disconnect waiting timeout, in milliseconds
943		-
944	944	**Return：**
945	945
946	946	Succeed: true
...	...	@@ -948,17 +948,13 @@
948	948	Failed: multi
949	949
950	950	(((
951		-== **4.5 mqtt:isconnected()** ==
	860	+== **mqtt:isconnected()** ==
952	952	)))
953	953
954		-**Function:**
	863	+**Function:** Test whether or not a client is currently connected to the MQTT server
955	955
956		-Test whether or not a client is currently connected to the MQTT server
	865	+**Parameters:** None
957	957
958		-**Parameters:**
959		-
960		-None
961		-
962	962	**Return：**
963	963
964	964	Succeed: true ~-~-Connected
...	...	@@ -966,13 +966,11 @@
966	966	Failed: false ~-~- Unconnected and other unknowns
967	967
968	968	(((
969		-== **4.6 mqtt:subscribe(string topic, number qos)** ==
	874	+== **mqtt:subscribe(string topic, number qos)** ==
970	970	)))
971	971
972		-**Function:**
	877	+**Function: **Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
973	973
974		-Subscribe to the topic (before the subscription, the user must first call the connect method to connect to the server)
975		-
976	976	**Parameters:**
977	977
978	978	//topic//, topic name
...	...	@@ -986,13 +986,11 @@
986	986	Failed: multi
987	987
988	988	(((
989		-== **4.7 mqtt:unsubscribe(string topic)** ==
	892	+== **mqtt:unsubscribe(string topic)** ==
990	990	)))
991	991
992		-**Function:**
	895	+**Function:** Unsubscribe topic
993	993
994		-Unsubscribe topic
995		-
996	996	**Parameters:**
997	997
998	998	//topic//, topic name
...	...	@@ -1004,13 +1004,11 @@
1004	1004	Failed: multi
1005	1005
1006	1006	(((
1007		-== **4.8 mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
	908	+== **mqtt:publish(string topic, string message, number qos, number retain[, number timeout])** ==
1008	1008	)))
1009	1009
1010		-**Function:**
	911	+**Function:** Publish message
1011	1011
1012		-Publish message
1013		-
1014	1014	**Parameters:**
1015	1015
1016	1016	//topic//, topic name
...	...	@@ -1030,17 +1030,13 @@
1030	1030	Failed: multi
1031	1031
1032	1032	(((
1033		-== **4.9 mqtt:close()** ==
	932	+== **mqtt:close()** ==
1034	1034	)))
1035	1035
1036		-**Function:**
	935	+**Function:** Close the mqtt object (the connection to the server will be automatically disconnected)
1037	1037
1038		-Close the mqtt object (the connection to the server will be automatically disconnected)
	937	+**Parameters:** None
1039	1039
1040		-**Parameters:**
1041		-
1042		-None
1043		-
1044	1044	**Return：**
1045	1045
1046	1046	Succeed: true
...	...	@@ -1048,13 +1048,11 @@
1048	1048	Failed: multi
1049	1049
1050	1050	(((
1051		-== **4.10 mqtt:on(string method, function callback)** ==
	946	+== **mqtt:on(string method, function callback)** ==
1052	1052	)))
1053	1053
1054		-**Function:**
	949	+**Function:** Register event callback function
1055	1055
1056		-Register event callback function
1057		-
1058	1058	**Parameters:**
1059	1059
1060	1060	//method//, It can be message/arrived/offline, these 3 types of events
...	...	@@ -1067,20 +1067,17 @@
1067	1067
1068	1068	Parameter:
1069	1069
1070		-//Topic//, topic name
	963	+* //Topic//, topic name
	964	+* //Message//, content
1071	1071
1072		-//Message//, content
	966	+**2."arrived" is published by publish, this function will be called after the publication arrives**
1073	1073
1074		-**2.**"arrived" is published by publish, this function will be called after the publication arrives
1075		-
1076	1076	//Callback// prototype~:// function ()//
1077	1077
1078		-Parameter:
	970	+Parameter: None
1079	1079
1080		-None
	972	+**3.This function will be called after the "offline" connection is lost**
1081	1081
1082		-**3.**This function will be called after the "offline" connection is lost
1083		-
1084	1084	//Callback// prototype~:// function (string cause)//
1085	1085
1086	1086	Parameter:
...	...	@@ -1094,17 +1094,13 @@
1094	1094	Failed: multi
1095	1095
1096	1096	(((
1097		-== **4.11 mqtt:setup_cfg()** ==
	987	+== **mqtt:setup_cfg()** ==
1098	1098	)))
1099	1099
1100		-**Function:**
	990	+**Function:** Cloud mode interface, to obtain MQTT information configured by the cloud platform
1101	1101
1102		-Cloud mode interface, to obtain MQTT information configured by the cloud platform
	992	+**Parameters:** None
1103	1103
1104		-**Parameters:**
1105		-
1106		-None
1107		-
1108	1108	**Return:**
1109	1109
1110	1110	//serverurl, clientid, conn, lwt, cart //(5 returns, respectively, server address, client ID, connection table, last word table, certificate table)
...	...	@@ -1122,39 +1122,27 @@
1122	1122	Lua only has a table data structure, so all arrays and key-value objects of json will be returned as a table.
1123	1123
1124	1124	(((
1125		-== **5.1 json.encode( lua_object )** ==
	1011	+== **json.encode( lua_object )** ==
1126	1126	)))
1127	1127
1128		-**Function:**
	1014	+**Function: **Convert lua data type to json string
1129	1129
1130		-Convert lua data type to json string
	1016	+**Parameters: **Lua data type (including boolean, number, string, table)
1131	1131
1132		-**Parameters:**
	1018	+**Return：** Json format string
1133	1133
1134		-Lua data type (including boolean, number, string, table)
1135		-
1136		-**Return：**
1137		-
1138		-Json format string
1139		-
1140	1140	(((
1141		-== **5.2 json.decode(string json_string)** ==
	1021	+== **json.decode(string json_string)** ==
1142	1142	)))
1143	1143
1144		-**Function:**
	1024	+**Function:** Convert json string to lua data type
1145	1145
1146		-Convert json string to lua data type
	1026	+**Parameters: **//json_string//, string of json data structure
1147	1147
1148		-**Parameters:**
	1028	+**Return: **Lua data type
1149	1149
1150		-//json_string//, string of json data structure
1151		-
1152		-**Return：**
1153		-
1154		-Lua data type
1155		-
1156	1156	(((
1157		-== **5.3 json.null** ==
	1031	+== **json.null** ==
1158	1158	)))
1159	1159
1160	1160	**Function:**
...	...	@@ -1161,32 +1161,24 @@
1161	1161
1162	1162	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.
1163	1163
1164		-**Parameters:**
	1038	+**Parameters:** None
1165	1165
1166		-None
	1040	+**Return: **None
1167	1167
1168		-**Return：**
1169		-
1170		-None
1171		-
1172	1172	= **6 Cloud mode** =
1173	1173
1174	1174	The cloud interface is only used in cloud mode, and V-NET mode is not available.
1175	1175
1176	1176	(((
1177		-== **6.1 bns_get_alldata()** ==
	1047	+== **bns_get_alldata()** ==
1178	1178	)))
1179	1179
1180		-**Function:**
	1050	+**Function:** Obtain all monitoring points (point table) data configured by the end user
1181	1181
1182		-Obtain all monitoring points (point table) data configured by the end user
	1052	+**✎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
1183	1183
1184		-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
	1054	+**Parameters:** None
1185	1185
1186		-**Parameters:**
1187		-
1188		-None
1189		-
1190	1190	**Return:**
1191	1191
1192	1192	Succeed: table two-dimensional array, the structure is as follows
...	...	@@ -1199,8 +1199,9 @@
1199	1199
1200	1200	If there is no custom configuration, return an empty table, otherwise, return with "field name/field content"
1201	1201
1202		-E.g:
	1068	+**For example:**
1203	1203
	1070	+{{code language="LUA"}}
1204	1204	{
1205	1205
1206	1206	[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5', [5]={"fruit"="apple"}},
...	...	@@ -1213,16 +1213,15 @@
1213	1213
1214	1214	}
1215	1215
1216		-Failed: //table// empty table
	1083	+Failed: table empty table
	1084	+{{/code}}
1217	1217
1218	1218	(((
1219		-== **6.2 bns_get_config(string from)** ==
	1087	+== **bns_get_config(string from)** ==
1220	1220	)))
1221	1221
1222		-**Function:**
	1090	+**Function:** Obtain custom configuration parameters with the specified from type
1223	1223
1224		-Obtain custom configuration parameters with the specified from type
1225		-
1226	1226	**parameter:**
1227	1227
1228	1228	from type, there are the following two categories, the string must be all lowercase
...	...	@@ -1240,13 +1240,11 @@
1240	1240	Failed~:// table// empty table
1241	1241
1242	1242	(((
1243		-== **6.3 bns_get_data(string name, string data)** ==
	1109	+== **bns_get_data(string name, string data)** ==
1244	1244	)))
1245	1245
1246		-**Function:**
	1112	+**Function:**write data to the name of the monitoring point
1247	1247
1248		-write data to the name of the monitoring point
1249		-
1250	1250	**parameter:**
1251	1251
1252	1252	//name //The name of the monitoring point
...	...	@@ -1260,7 +1260,7 @@
1260	1260	Failed: nil
1261	1261
1262	1262	(((
1263		-== **6.4 bns_get_data(string name)** ==
	1127	+== **bns_get_data(string name)** ==
1264	1264	)))
1265	1265
1266	1266	**Function:**
...	...	@@ -1278,17 +1278,13 @@
1278	1278	Failed: nil
1279	1279
1280	1280	(((
1281		-== **6.5 bns_get_datadesc()** ==
	1145	+== **bns_get_datadesc()** ==
1282	1282	)))
1283	1283
1284		-**Function:**
	1148	+**Function: **Obtain all configured communication ports and monitoring point information
1285	1285
1286		-Obtain all configured communication ports and monitoring point information
	1150	+**Parameters:** None
1287	1287
1288		-**Parameters:**
1289		-
1290		-None
1291		-
1292	1292	**Return:**
1293	1293
1294	1294	Succeed: table three-dimensional array, the structure is as follows
...	...	@@ -1301,13 +1301,15 @@
1301	1301
1302	1302	Type (1: switch, 2: number, 3: string)
1303	1303
1304		-E.g:
1305		- {
	1164	+**For example:**
1306	1306
1307		-[1]={~-~-The first communication port
	1166	+{{code language="LUA"}}
	1167	+{
1308	1308
1309		-[1]={~-~-monitoring point array of the first communication port
	1169	+[1]={--The first communication port
1310	1310
	1171	+[1]={--monitoring point array of the first communication port
	1172	+
1311	1311	[1]={[1]=11,[2]='data1',[3]=3,[4]=2},
1312	1312
1313	1313	[2]={[1]=12,[2]='data2',[3]=3,[4]=2},
...	...	@@ -1314,23 +1314,23 @@
1314	1314
1315	1315	...
1316	1316
1317		-[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},~-~-n monitoring points
	1179	+[n]={[1]=xx,[2]='datan',[3]=x,[4]=x},--n monitoring points
1318	1318
1319	1319	},
1320	1320
1321		-[2]=14, ~-~-ID
	1183	+[2]=14, --ID
1322	1322
1323		-[3]='Modbus TCP' ~-~-n monitoring points
	1185	+[3]='Modbus TCP' --n monitoring points
1324	1324
1325	1325	},
1326	1326
1327		-[2]={~-~-The second communication port
	1189	+[2]={--The second communication port
1328	1328
1329		-[1]={},~-~-The monitoring point of the second communication port is not configured and is empty
	1191	+[1]={},--The monitoring point of the second communication port is not configured and is empty
1330	1330
1331		-[2]=15, ~-~-ID
	1193	+[2]=15, --ID
1332	1332
1333		-[3]='WECON' ~-~-communication protocol name
	1195	+[3]='WECON' --communication protocol name
1334	1334
1335	1335	},
1336	1336
...	...	@@ -1337,21 +1337,18 @@
1337	1337	...n communication ports and so on
1338	1338
1339	1339	}
	1202	+{{/code}}
1340	1340
1341	1341	Failed~:// table// empty table
1342	1342
1343	1343	(((
1344		-== **6.6 bns_get_machineinfo()** ==
	1207	+== **bns_get_machineinfo()** ==
1345	1345	)))
1346	1346
1347		-**Function:**
	1210	+**Function:** get machine information
1348	1348
1349		-get machine information
	1212	+**Parameters:** None
1350	1350
1351		-**Parameters:**
1352		-
1353		-None
1354		-
1355	1355	**Return:**
1356	1356
1357	1357	Succeed: 3 string type results (model, machine code, software version)
...	...	@@ -1359,13 +1359,11 @@
1359	1359	Failed: nil
1360	1360
1361	1361	(((
1362		-== **6.7 bns_get_groupdata(string name)** ==
	1221	+== **bns_get_groupdata(string name)** ==
1363	1363	)))
1364	1364
1365		-**Function:**
	1224	+**Function:** Get all monitoring point data under the specified group name
1366	1366
1367		-Get all monitoring point data under the specified group name
1368		-
1369	1369	**parameter:**
1370	1370
1371	1371	//Name  // group name
...	...	@@ -1377,17 +1377,13 @@
1377	1377	Failed: //table// empty table
1378	1378
1379	1379	(((
1380		-== **6.8 bns_get_groupdesc()** ==
	1237	+== **bns_get_groupdesc()** ==
1381	1381	)))
1382	1382
1383		-**Function:**
	1240	+**Function:** Get all group information
1384	1384
1385		-Get all group information
	1242	+**Parameters:** None
1386	1386
1387		-**Parameters:**
1388		-
1389		-None
1390		-
1391	1391	**Return:**
1392	1392
1393	1393	Succeed: //table// two-dimensional array, the structure is as follows
...	...	@@ -1401,17 +1401,13 @@
1401	1401	Failed: //table  // empty table
1402	1402
1403	1403	(((
1404		-== **6.9 bns_get_onecache(string msg)** ==
	1257	+== **bns_get_onecache(string msg)** ==
1405	1405	)))
1406	1406
1407		-**Function:**
	1260	+**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.
1408	1408
1409		-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.
	1262	+**Parameters: **//msg// String
1410	1410
1411		-**Parameters:**
1412		-
1413		-//msg// String
1414		-
1415	1415	**Return:**
1416	1416
1417	1417	Succeed: true
...	...	@@ -1419,23 +1419,20 @@
1419	1419	Failed: nil
1420	1420
1421	1421	(((
1422		-== **6.10 bns_get_allcache()** ==
	1271	+== **bns_get_allcache()** ==
1423	1423	)))
1424	1424
1425		-**Function:**
	1274	+**Function:** Get all the cached content (once the internal cache file will be emptied)
1426	1426
1427		-Get all the cached content (once the internal cache file will be emptied)
	1276	+**Parameters:** None
1428	1428
1429		-**Parameters:**
1430		-
1431		-None
1432		-
1433	1433	**Return:**
1434	1434
1435	1435	Succeed: //table// one-dimensional array
1436	1436
1437		-E.g:
	1282	+**For example:**
1438	1438
	1284	+{{code language="LUA"}}
1439	1439	{
1440	1440
1441	1441	[1]="This is the oldest message", - the first is the oldest message
...	...	@@ -1447,6 +1447,7 @@
1447	1447	[n]="This is the latest message", - the last is the latest message
1448	1448
1449	1449	}
	1296	+{{/code}}
1450	1450
1451	1451	Failede: nil
1452	1452
...	...	@@ -1457,194 +1457,232 @@
1457	1457	Network communication includes Http request interface, this document does not provide interface description, please refer to the online document for how to use it.
1458	1458
1459	1459	(((
1460		-== **7.1 http request** ==
	1307	+== **http request** ==
1461	1461	)))
1462	1462
1463	1463	[[http:~~/~~/w3.impa.br/~~~~diego/software/luasocket/http.html#request>>url:http://w3.impa.br/~~diego/software/luasocket/http.html#request]]
1464	1464
1465		-(((
1466		-= **8 Internal register** =
1467		-)))
	1312	+== **https request** ==
1468	1468
1469		-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):
	1314	+**For example:**
1470	1470
1471		-**~1. **Access by word, prefix @W_HDW,
	1316	+{{code language="LUA"}}
	1317	+local json = require("json")
1472	1472
1473		-For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
	1319	+local https = require("https")
1474	1474
1475		-**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.
	1321	+functions https_demo.main()
1476	1476
1477		-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.
	1323	+local url = "https://XXXXXXXXXXXXXXXXXXXXXXXXXX"
1478	1478
1479		-**✎Note: **
	1325	+local body = {}
1480	1480
1481		-**~1. **The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
	1327	+body["XXXXXX"] = "XXXXX"
1482	1482
1483		-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.
	1329	+body["XXXXXXX"] = "XXXXXXXXXXX"
1484	1484
1485		-**2.**The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
	1331	+local bodyJson = json.encode(body)
1486	1486
1487		-(((
1488		-== **8.1 Data storage area（HDW/HDX）** ==
1489		-)))
	1333	+local header = {}
1490	1490
1491		-The system storage area (HDW) of the V-BOX is used to store temporary data:
	1335	+header["content-type"] = "application/json"
1492	1492
1493		-~1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
	1337	+local result_table, code, headers, status = https.request(url,
1494	1494
1495		-2. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
	1339	+bodyJson)
1496	1496
1497		-(((
1498		-== **8.2 Special data area (HSW/HSX)** ==
1499		-)))
	1341	+if code == 200 then
1500	1500
1501		-**✎Note: **
	1343	+print("https suc")
1502	1502
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).
	1345	+return true
1504	1504
1505		-//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.
	1347	+else
1506	1506
1507		-1.The system data area (HSW) of the box is used for system special registers (system reserved). Use //addr_getword// to obtain the following register information:
	1349	+print("https fail")
1508	1508
1509		-(% class="table-bordered" %)
1510		-|address|function|Read and write status: read only, write only, read and write
1511		-|@W_HSW0|restart|read and write
1512		-|@W_HSW1|Box time: year|read and write
1513		-|@W_HSW2|Box time: month|read and write
1514		-|@W_HSW3|Box time: day|read and write
1515		-|@W_HSW4|Box time: hour|read and write
1516		-|@W_HSW5|Box time: minute|read and write
1517		-|@W_HSW6|Box time: second|read and write
1518		-|@W_HSW7|Box time: week|read and write
1519		-|@W_HSW8|Ethernet IP1|read only
1520		-|@W_HSW9|Ethernet IP2|read only
1521		-|@W_HSW10|Ethernet IP3|read only
1522		-|@W_HSW11|Ethernet IP4|read only
1523		-|@W_HSW12|Ethernet Mask 1|read only
1524		-|@W_HSW13|Ethernet Mask 2|read only
1525		-|@W_HSW14|Ethernet Mask 3|read only
1526		-|@W_HSW15|Ethernet Mask 4|read only
1527		-|@W_HSW16|Ethernet Gateway 1|read only
1528		-|@W_HSW17|Ethernet Gateway 2|read only
1529		-|@W_HSW18|Ethernet Gateway 3|read only
1530		-|@W_HSW19|Ethernet Gateway 4|read only
1531		-|@W_HSW21|Ethernet MAC1|read only
1532		-|@W_HSW22|Ethernet MAC2|read only
1533		-|@W_HSW23|Ethernet MAC3|read only
1534		-|@W_HSW24|Ethernet MAC4|read only
1535		-|@W_HSW25|Ethernet MAC3|read only
1536		-|@W_HSW26|Ethernet MAC4|read only
1537		-|@W_HSW128|WIFI IP1|read only
1538		-|@W_HSW129|WIFI IP2|read only
1539		-|@W_HSW130|WIFI IP3|read only
1540		-|@W_HSW131|WIFI IP4|read only
1541		-|@W_HSW132|WIFI Mask 1|read only
1542		-|@W_HSW133|WIFI Mask 2|read only
1543		-|@W_HSW134|WIFI Mask 3|read only
1544		-|@W_HSW135|WIFI Mask 4|read only
1545		-|@W_HSW136|WIFI Gateway 1|read only
1546		-|@W_HSW137|WIFI Gateway 2|read only
1547		-|@W_HSW138|WIFI Gateway 3|read only
1548		-|@W_HSW139|WIFI Gateway 4|read only
1549		-|@W_HSW140|WIFI MAC1|read only
1550		-|@W_HSW141|WIFI MAC2|read only
1551		-|@W_HSW142|WIFI MAC3|read only
1552		-|@W_HSW143|WIFI MAC4|read only
1553		-|@W_HSW144|WIFI MAC5|read only
1554		-|@W_HSW145|WIFI MAC6|read only
1555		-|@W_HSW146|WIFI Signal value|read only
1556		-|@W_HSW148|4G IP1|read only
1557		-|@W_HSW149|4G IP2|read only
1558		-|@W_HSW150|4G IP3|read only
1559		-|@W_HSW151|4G IP4|read only
1560		-|@W_HSW152|4G Mask 1|read only
1561		-|@W_HSW153|4G Mask 2|read only
1562		-|@W_HSW154|4G Mask 3|read only
1563		-|@W_HSW155|4G Mask 4|read only
1564		-|@W_HSW156|4G Gateway 1|read only
1565		-|@W_HSW157|4G Gateway 2|read only
1566		-|@W_HSW158|4G Gateway 3|read only
1567		-|@W_HSW159|4G Gateway 4|read only
1568		-|@W_HSW160|4G MAC1|read only
1569		-|@W_HSW161|4G MAC2|read only
1570		-|@W_HSW162|4G MAC3|read only
1571		-|@W_HSW163|4G MAC4|read only
1572		-|@W_HSW164|4G MAC5|read only
1573		-|@W_HSW165|4G MAC6|read only
1574		-|@W_HSW166|4G Signal value|read only
	1351	+return nil
1575	1575
1576		-2. Other
	1353	+end
1577	1577
1578		-2.1 Access password: addr_getstring("@W_HSW27", 16)
	1355	+end
	1356	+{{/code}}
1579	1579
1580		-2.2 Machine code: addr_getstring("@W_HSW60", 64)
	1358	+(((
	1359	+= **8 Internal register** =
	1360	+)))
1581	1581
1582		-2.3 Positioning method (@W_HSW167): (read only)
	1362	+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):
1583	1583
1584		-~1. Latitude and longitude
	1364	+**Access by word, prefix @W_HDW.**
1585	1585
1586		-Longitude: addr_getdouble("@W_HSW168") (read only)
	1366	+For example: @W_HDW0 represents the first word of the system data area, @W_HDW1 represents the second word of the system data area.
1587	1587
1588		-Latitude: addr_getdouble("@W_HSW172") (read only)
	1368	+**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.**
1589	1589
1590		-2. Base station positioning
	1370	+**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.
1591	1591
1592		-LAC: addr_getdword("@W_HSW168") (read only)
	1372	+(% class="box infomessage" %)
	1373	+(((
	1374	+**✎Note: **
1593	1593
1594		-CI: addr_getdword("@W_HSW172") (read only)
	1376	+* The address in @B_HDX is taken from the word in @W_HDW, so pay special attention when using the address.
	1377	+** 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.
	1378	+* The address of the bit address @B_HDX has a decimal point, while the word address is an integer.
	1379	+)))
1595	1595
1596		-2.4 Convert base station to latitude and longitude via API
1597	1597
1598		-Longitude: addr_getdouble("@W_HSW187") (read only)
	1382	+(((
	1383	+== **Data storage area（HDW/HDX）** ==
	1384	+)))
1599	1599
1600		-Latitude: addr_getdouble("@W_HSW183") (read only)
	1386	+The system storage area (HDW) of the V-BOX is used to store temporary data:
1601	1601
1602		-2.5 Operator information: addr_getdword("@W_HSW181") (read only)
	1388	+1. Access by word, the number range is: "@W_HDW0"-"@W_HDW299999".
	1389	+1. Access in bit mode, the number range is: "@B_HDX0.0"-"@B_HDX299999.15".
1603	1603
1604		-2.6 Networking mode: addr_getword("@W_HSW177") (read only)
	1391	+(((
	1392	+== **Special data area (HSW/HSX)** ==
1605	1605
1606		-0: Ethernet, 1: WIFI, 2: 4G, 3: 2G
	1394	+(% class="box infomessage" %)
	1395	+(((
	1396	+**✎Note: **
1607	1607
1608		-2.7 Map fence flag: addr_getword("@W_HSW178") (read only)
	1398	+* //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).
	1399	+* //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.
	1400	+)))
	1401	+)))
1609	1609
1610		-0: No map fence is drawn
	1403	+The system data area (HSW) of the box is used for system special registers (system reserved). Use //addr_getword// to obtain the following register information:
1611	1611
1612		-1: Draw a map fence and the box is in the fence
	1405	+(% class="table-bordered" %)
	1406	+|=(% style="width: 151px;" %)address|=(% style="width: 169px;" %)function|=(% style="width: 456px;" %)Read and write status: read only, write only, read and write
	1407	+|(% style="width:151px" %)@W_HSW0|(% style="width:169px" %)restart|(% style="width:456px" %)read and write
	1408	+|(% style="width:151px" %)@W_HSW1|(% style="width:169px" %)Box time: year|(% style="width:456px" %)read and write
	1409	+|(% style="width:151px" %)@W_HSW2|(% style="width:169px" %)Box time: month|(% style="width:456px" %)read and write
	1410	+|(% style="width:151px" %)@W_HSW3|(% style="width:169px" %)Box time: day|(% style="width:456px" %)read and write
	1411	+|(% style="width:151px" %)@W_HSW4|(% style="width:169px" %)Box time: hour|(% style="width:456px" %)read and write
	1412	+|(% style="width:151px" %)@W_HSW5|(% style="width:169px" %)Box time: minute|(% style="width:456px" %)read and write
	1413	+|(% style="width:151px" %)@W_HSW6|(% style="width:169px" %)Box time: second|(% style="width:456px" %)read and write
	1414	+|(% style="width:151px" %)@W_HSW7|(% style="width:169px" %)Box time: week|(% style="width:456px" %)read and write
	1415	+|(% style="width:151px" %)@W_HSW8|(% style="width:169px" %)Ethernet IP1|(% style="width:456px" %)read only
	1416	+|(% style="width:151px" %)@W_HSW9|(% style="width:169px" %)Ethernet IP2|(% style="width:456px" %)read only
	1417	+|(% style="width:151px" %)@W_HSW10|(% style="width:169px" %)Ethernet IP3|(% style="width:456px" %)read only
	1418	+|(% style="width:151px" %)@W_HSW11|(% style="width:169px" %)Ethernet IP4|(% style="width:456px" %)read only
	1419	+|(% style="width:151px" %)@W_HSW12|(% style="width:169px" %)Ethernet Mask 1|(% style="width:456px" %)read only
	1420	+|(% style="width:151px" %)@W_HSW13|(% style="width:169px" %)Ethernet Mask 2|(% style="width:456px" %)read only
	1421	+|(% style="width:151px" %)@W_HSW14|(% style="width:169px" %)Ethernet Mask 3|(% style="width:456px" %)read only
	1422	+|(% style="width:151px" %)@W_HSW15|(% style="width:169px" %)Ethernet Mask 4|(% style="width:456px" %)read only
	1423	+|(% style="width:151px" %)@W_HSW16|(% style="width:169px" %)Ethernet Gateway 1|(% style="width:456px" %)read only
	1424	+|(% style="width:151px" %)@W_HSW17|(% style="width:169px" %)Ethernet Gateway 2|(% style="width:456px" %)read only
	1425	+|(% style="width:151px" %)@W_HSW18|(% style="width:169px" %)Ethernet Gateway 3|(% style="width:456px" %)read only
	1426	+|(% style="width:151px" %)@W_HSW19|(% style="width:169px" %)Ethernet Gateway 4|(% style="width:456px" %)read only
	1427	+|(% style="width:151px" %)@W_HSW21|(% style="width:169px" %)Ethernet MAC1|(% style="width:456px" %)read only
	1428	+|(% style="width:151px" %)@W_HSW22|(% style="width:169px" %)Ethernet MAC2|(% style="width:456px" %)read only
	1429	+|(% style="width:151px" %)@W_HSW23|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
	1430	+|(% style="width:151px" %)@W_HSW24|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
	1431	+|(% style="width:151px" %)@W_HSW25|(% style="width:169px" %)Ethernet MAC3|(% style="width:456px" %)read only
	1432	+|(% style="width:151px" %)@W_HSW26|(% style="width:169px" %)Ethernet MAC4|(% style="width:456px" %)read only
	1433	+|(% style="width:151px" %)@W_HSW128|(% style="width:169px" %)WIFI IP1|(% style="width:456px" %)read only
	1434	+|(% style="width:151px" %)@W_HSW129|(% style="width:169px" %)WIFI IP2|(% style="width:456px" %)read only
	1435	+|(% style="width:151px" %)@W_HSW130|(% style="width:169px" %)WIFI IP3|(% style="width:456px" %)read only
	1436	+|(% style="width:151px" %)@W_HSW131|(% style="width:169px" %)WIFI IP4|(% style="width:456px" %)read only
	1437	+|(% style="width:151px" %)@W_HSW132|(% style="width:169px" %)WIFI Mask 1|(% style="width:456px" %)read only
	1438	+|(% style="width:151px" %)@W_HSW133|(% style="width:169px" %)WIFI Mask 2|(% style="width:456px" %)read only
	1439	+|(% style="width:151px" %)@W_HSW134|(% style="width:169px" %)WIFI Mask 3|(% style="width:456px" %)read only
	1440	+|(% style="width:151px" %)@W_HSW135|(% style="width:169px" %)WIFI Mask 4|(% style="width:456px" %)read only
	1441	+|(% style="width:151px" %)@W_HSW136|(% style="width:169px" %)WIFI Gateway 1|(% style="width:456px" %)read only
	1442	+|(% style="width:151px" %)@W_HSW137|(% style="width:169px" %)WIFI Gateway 2|(% style="width:456px" %)read only
	1443	+|(% style="width:151px" %)@W_HSW138|(% style="width:169px" %)WIFI Gateway 3|(% style="width:456px" %)read only
	1444	+|(% style="width:151px" %)@W_HSW139|(% style="width:169px" %)WIFI Gateway 4|(% style="width:456px" %)read only
	1445	+|(% style="width:151px" %)@W_HSW140|(% style="width:169px" %)WIFI MAC1|(% style="width:456px" %)read only
	1446	+|(% style="width:151px" %)@W_HSW141|(% style="width:169px" %)WIFI MAC2|(% style="width:456px" %)read only
	1447	+|(% style="width:151px" %)@W_HSW142|(% style="width:169px" %)WIFI MAC3|(% style="width:456px" %)read only
	1448	+|(% style="width:151px" %)@W_HSW143|(% style="width:169px" %)WIFI MAC4|(% style="width:456px" %)read only
	1449	+|(% style="width:151px" %)@W_HSW144|(% style="width:169px" %)WIFI MAC5|(% style="width:456px" %)read only
	1450	+|(% style="width:151px" %)@W_HSW145|(% style="width:169px" %)WIFI MAC6|(% style="width:456px" %)read only
	1451	+|(% style="width:151px" %)@W_HSW146|(% style="width:169px" %)WIFI Signal value|(% style="width:456px" %)read only
	1452	+|(% style="width:151px" %)@W_HSW148|(% style="width:169px" %)4G IP1|(% style="width:456px" %)read only
	1453	+|(% style="width:151px" %)@W_HSW149|(% style="width:169px" %)4G IP2|(% style="width:456px" %)read only
	1454	+|(% style="width:151px" %)@W_HSW150|(% style="width:169px" %)4G IP3|(% style="width:456px" %)read only
	1455	+|(% style="width:151px" %)@W_HSW151|(% style="width:169px" %)4G IP4|(% style="width:456px" %)read only
	1456	+|(% style="width:151px" %)@W_HSW152|(% style="width:169px" %)4G Mask 1|(% style="width:456px" %)read only
	1457	+|(% style="width:151px" %)@W_HSW153|(% style="width:169px" %)4G Mask 2|(% style="width:456px" %)read only
	1458	+|(% style="width:151px" %)@W_HSW154|(% style="width:169px" %)4G Mask 3|(% style="width:456px" %)read only
	1459	+|(% style="width:151px" %)@W_HSW155|(% style="width:169px" %)4G Mask 4|(% style="width:456px" %)read only
	1460	+|(% style="width:151px" %)@W_HSW156|(% style="width:169px" %)4G Gateway 1|(% style="width:456px" %)read only
	1461	+|(% style="width:151px" %)@W_HSW157|(% style="width:169px" %)4G Gateway 2|(% style="width:456px" %)read only
	1462	+|(% style="width:151px" %)@W_HSW158|(% style="width:169px" %)4G Gateway 3|(% style="width:456px" %)read only
	1463	+|(% style="width:151px" %)@W_HSW159|(% style="width:169px" %)4G Gateway 4|(% style="width:456px" %)read only
	1464	+|(% style="width:151px" %)@W_HSW160|(% style="width:169px" %)4G MAC1|(% style="width:456px" %)read only
	1465	+|(% style="width:151px" %)@W_HSW161|(% style="width:169px" %)4G MAC2|(% style="width:456px" %)read only
	1466	+|(% style="width:151px" %)@W_HSW162|(% style="width:169px" %)4G MAC3|(% style="width:456px" %)read only
	1467	+|(% style="width:151px" %)@W_HSW163|(% style="width:169px" %)4G MAC4|(% style="width:456px" %)read only
	1468	+|(% style="width:151px" %)@W_HSW164|(% style="width:169px" %)4G MAC5|(% style="width:456px" %)read only
	1469	+|(% style="width:151px" %)@W_HSW165|(% style="width:169px" %)4G MAC6|(% style="width:456px" %)read only
	1470	+|(% style="width:151px" %)@W_HSW166|(% style="width:169px" %)4G Signal value|(% style="width:456px" %)read only
1613	1613
1614		-2: Draw a map fence and the box is not in the fence
	1472	+**Others**
1615	1615
1616		-2.8 SIM card status addr_getword("@W_HSW179") (read only)
	1474	+* Access password: addr_getstring("@W_HSW27", 16)
	1475	+* Machine code: addr_getstring("@W_HSW60", 64)
	1476	+* Positioning method (@W_HSW167): (read only)
	1477	+** Latitude and longitude
	1478	+*** Longitude: addr_getdouble("@W_HSW168") (read only)
	1479	+*** Latitude: addr_getdouble("@W_HSW172") (read only)
	1480	+** Base station positioning
	1481	+*** LAC: addr_getdword("@W_HSW168") (read only)
	1482	+*** CI: addr_getdword("@W_HSW172") (read only)
	1483	+* Convert base station to latitude and longitude via API
	1484	+** Longitude: addr_getdouble("@W_HSW187") (read only)
	1485	+** Latitude: addr_getdouble("@W_HSW183") (read only)
	1486	+* Operator information: addr_getdword("@W_HSW181") (read only)
	1487	+* Networking mode: addr_getword("@W_HSW177") (read only)
	1488	+** 0: Ethernet
	1489	+** 1: WIFI
	1490	+** 2: 4G
	1491	+** 3: 2G
	1492	+* Map fence flag: addr_getword("@W_HSW178") (read only)
	1493	+** 0: No map fence is drawn
	1494	+** 1: Draw a map fence and the box is in the fence
	1495	+** 2: Draw a map fence and the box is not in the fence
	1496	+* SIM card status addr_getword("@W_HSW179") (read only)
	1497	+** 1: No card detected
	1498	+** 2: Card insertion detected
	1499	+** 3: The card status is abnormal
	1500	+* MQTT status addr_getword("@W_HSW180") (read only)
	1501	+** 1: online, 2: offline
	1502	+* IO interface, X is read only, Y is read and write (H series)
	1503	+** addr_getbit(addr1), addr_setbit(addr2)
	1504	+** addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
	1505	+** addr2:"@B_Y0" "@B_Y1"
	1506	+* Obtaining IMEI (read only)
	1507	+** addr_getstring("@W_HSW191",17)
	1508	+* Obtaining ICCID (read only)
	1509	+** addr_getstring("@W_HSW225",15)
1617	1617
1618		-1: No card detected
	1511	+(((
	1512	+== **Power-down storage area (HAW/HAX)** ==
1619	1619
1620		-2: Card insertion detected
	1514	+The system storage area (HAW) is used for the system power-down hold registers:
1621	1621
1622		-3: The card status is abnormal
	1516	+1. Accessed as a word, numbered in the range: "@W_HAW0"-"@W_HAW199999".
	1517	+1. Accessed by bit, the numbering range is: "@B_HAX0.0"-"@B_HAX199999.15".
1623	1623
1624		-2.9 MQTT status addr_getword("@W_HSW180") (read only)
1625		-
1626		-1: online, 2: offline
1627		-
1628		-2.10 IO interface, X is read only, Y is read and write (H series)
1629		-
1630		-addr_getbit(addr1), addr_setbit(addr2)
1631		-
1632		-addr1:"@B_Y0" "@B_Y1" "@B_X0" "@B_X1"
1633		-
1634		-addr2:"@B_Y0" "@B_Y1"
1635		-
	1519	+(% class="box infomessage" %)
1636	1636	(((
	1521	+**✎Note:** HAW/HAX is a power-down hold, that is, the registers of this type can retain the data before power-down in case of power-down.
	1522	+)))
	1523	+
1637	1637	= **9 General Functions** =
1638	1638	)))
1639	1639
1640	1640	(((
1641		-== **9.1 send_sms_ira(string number, string message)** ==
	1528	+== **send_sms_ira(string number, string message)** ==
1642	1642	)))
1643	1643
1644		-**Function:**
	1531	+**Function:** Use IRA character set to send English text messages
1645	1645
1646		-Use IRA character set to send English text messages
1647		-
1648	1648	**Parameters:**
1649	1649
1650	1650	//number: //number (up to 32 characters, the excess will be discarded)
...	...	@@ -1658,7 +1658,7 @@
1658	1658	Failed: multi
1659	1659
1660	1660	(((
1661		-== **9.2 send_sms_ucs2(string number, string message)** ==
	1546	+== **send_sms_ucs2(string number, string message)** ==
1662	1662	)))
1663	1663
1664	1664	**Function:**
...	...	@@ -1678,13 +1678,11 @@
1678	1678	Failed: multi
1679	1679
1680	1680	(((
1681		-== **9.3 sms_get_state(number id)** ==
	1566	+== **sms_get_state(number id)** ==
1682	1682	)))
1683	1683
1684		-**Function:**
	1569	+**Function:** Get the status of the SMS
1685	1685
1686		-Get the status of the SMS
1687		-
1688	1688	**parameter:**
1689	1689
1690	1690	//id~:// SMS corresponding id
...	...	@@ -1696,13 +1696,11 @@
1696	1696	Failed: multi
1697	1697
1698	1698	(((
1699		-== **9.4 jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
	1582	+== **jwt_encode(table head, table payload, string aud, number iat, number exp, string key, int jwttype)** ==
1700	1700	)))
1701	1701
1702		-**Function:**
	1585	+**Function:** Convert data to JWT format
1703	1703
1704		-Convert data to JWT format
1705		-
1706	1706	**parameter:**
1707	1707
1708	1708	//aud: //project name
...	...	@@ -1747,19 +1747,20 @@
1747	1747
1748	1748	//key~:// the private key required for encryption
1749	1749
1750		-For example:
	1631	+**For example:**
1751	1751
	1633	+{{code language="LUA"}}
1752	1752	function jwt.main()
1753	1753
1754		-local PRIVATE_KEY = ~[~[~-~- Please enter the secret key~-~-]]
	1636	+local PRIVATE_KEY = [[-- Please enter the secret key--]]
1755	1755
1756	1756	local JWTType=0
1757	1757
1758		-local payload = ~{~{key="test1",value="test1",type="0"},
	1640	+local payload = {{key="test1",value="test1",type="0"},
1759	1759
1760	1760	{key="test",value="123122131",type="1"}}
1761	1761
1762		-local head = ~{~{ key="name",value="data",type="0"},
	1644	+local head = {{ key="name",value="data",type="0"},
1763	1763
1764	1764	{key="test2",value="test2",type="0"}}
1765	1765
...	...	@@ -1774,15 +1774,14 @@
1774	1774	print(en)
1775	1775
1776	1776	End
	1659	+{{/code}}
1777	1777
1778	1778	(((
1779		-== **9.5 convertohex(number type, number value)** ==
	1662	+== **convertohex(number type, number value)** ==
1780	1780	)))
1781	1781
1782		-**Function:**
	1665	+**Function:** Convert data into hexadecimal data
1783	1783
1784		-Convert data into hexadecimal data
1785		-
1786	1786	**parameter:**
1787	1787
1788	1788	//type~:// incoming data type 0:word 1:dword 2:float
...	...	@@ -1795,106 +1795,445 @@
1795	1795
1796	1796	Failed: multi
1797	1797
	1679	+== **crc.init(table prarm)** ==
	1680	+
	1681	+**Function:** Initialize the CRC
	1682	+
	1683	+**Parameters:**
	1684	+
	1685	+prarm is a Lua table and needs to contain the following fields.
	1686	+
	1687	+* string prarm name, see table 9-1 for details of the parameter model name When this parameter is passed in, the default table parameters are used and the poly,init,xorout,refin,and refout passed in are invalid.
	1688	+* number prarm.width: the width, i.e. the number of CRC bits.
	1689	+* number [prarm.poly]: short for the generated item in hexadecimal. For example, CRC-32 is 0x04C11DB7, ignoring the highest bit "1", i.e., the complete generation item is 0x104C11DB7.
	1690	+* number [prarm.init]: the initialization preset value of the register (crc) at the beginning of the algorithm in hexadecimal.
	1691	+* number [prarm.xorout]: the final CRC value obtained after heterodyning the calculation result with this parameter.
	1692	+* number [prarm.refin]: whether each byte of the data to be measured is inverted by bit, true or false.
	1693	+* number [prarm.refout]: after the calculation or before the heterodyning output, whether the whole data is inverted by bit, true or false.
	1694	+
	1695	+**Return:**
	1696	+
	1697	+Success: crc object
	1698	+
	1699	+Failure: multi, error code
	1700	+
1798	1798	(((
1799		-== **9.6 set_network(table config)** ==
	1702	+|=Parameter model name|=poly|=init|=xorout|=refin|=refout
	1703	+|crc8|0x07|0x00|0x00|false|false
	1704	+|crc8_cdma2000|0x9B|0xFF|0x00|false|false
	1705	+|crc8_darc|0x39|0x00|0x00|true|true
	1706	+|crc8_dvb_s2|0xD5|0x00|0x00|false|false
	1707	+|crc8_ebu|0x1D|0xFF|0x00|true|true
	1708	+|crc8_i_code|0x1D|0xFD|0x00|false|false
	1709	+|crc8_itu|0x07|0x00|0x55|false|false
	1710	+|crc8_maxim|0x31|0x00|0x00|true|true
	1711	+|crc8_rohc|0x07|0xFF|0x00|true|true
	1712	+|crc8_wcdma|0x9B|0x00|0x00|true|true
	1713	+|crc8_sae_j1850|0x1D|0xFF|0xFF|false|false
	1714	+|crc8_opensafety|0x2F|0x00|0x00|false|false
	1715	+|crc16_tms37157|0x1021|0x3791|0x0000|true|true
	1716	+|crc16_a|0x1021|0x6363|0x0000|true|true
	1717	+|crc16_riello|0x1021|0x554D|0x0000|true|true
	1718	+|crc16_ccitt_false|0x1021|0xFFFF|0x0000|false|false
	1719	+|crc16_arc|0x8005|0x0000|0x0000|true|true
	1720	+|crc16_arc_ccitt|0x1021|0x1D0F|0x0000|false|false
	1721	+|crc16_buypass|0x8005|0x0000|0x0000|false|false
	1722	+|crc16_cdma2000|0xC867|0xFFFF|0x0000|false|false
	1723	+|crc16_dds110|0x8005|0x800D|0x0000|false|false
	1724	+|crc16_dect_r|0x0589|0x0000|0x0001|false|false
	1725	+|crc16_dect_x|0x0589|0x0000|0x0000|false|false
	1726	+|crc16_dnp|0x3D65|0x0000|0xFFFF|true|true
	1727	+|crc16_en_13757|0x3D65|0x0000|0xFFFF|false|false
	1728	+|crc16_genibus|0x1021|0xFFFF|0xFFFF|false|false
	1729	+|crc16_maxim|0x8005|0x0000|0xFFFF|true|true
	1730	+|crc16_mcrf4xx|0x1021|0xFFFF|0x0000|true|true
	1731	+|crc16_t10_dif|0x8BB7|0x0000|0x0000|false|false
	1732	+|crc16_teledisk|0xA097|0x0000|0x0000|false|false
	1733	+|crc16_usb|0x8005|0xFFFF|0xFFFF|true|true
	1734	+|crc16_kermit|0x1021|0x0000|0x0000|true|true
	1735	+
	1736	+(% class="wikigeneratedid" %)
	1737	+Table 9-1
	1738	+
	1739	+== **crc:calc(string crcValue)** ==
	1740	+
	1741	+**Function:** Calculate CRC result
	1742	+
	1743	+**Parameter:**
	1744	+
	1745	+crcValue: the value to be calculated
	1746	+
	1747	+**Return:**
	1748	+
	1749	+Succeed: calculated result
	1750	+
	1751	+Failed: multi, error code
1800	1800	)))
1801	1801
1802		-**Function:**
	1754	+**For example:**
1803	1803
1804		-Set V-BOX network, take effect after restart
	1756	+{{code language="LUA"}}
	1757	+function crcTest.main()
1805	1805
1806		-**parameter:**
	1759	+local param = {
1807	1807
1808		-//config~:// incoming network configuration table
	1761	+name = '',
1809	1809
1810		-1. connectMode: the way V-BOX connects to the server, 0: Ethernet, 1: WIFI, 2: 4G, 3: 2G, it is not allowed to be empty.
1811		-1. ethernetEnable: Whether to enable Ethernet, 1: enable, 0: disable, and it is not allowed to be empty.
1812		-1. ethernetLanIp: Set the LAN IP address. Only V-BOX with three network ports support this configuration, and other models of V-BOX do not support setting LAN IP. This item is allowed to be empty.
1813		-1. ethernetIpMode: Whether to enable Ethernet static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1814		-1. ethernetIp: The IP address needs to be configured when the Ethernet static IP is used, and it is not allowed to be empty.
1815		-1. ethernetNetmask: The subnet mask needs to be configured when Ethernet static IP is used, and it is not allowed to be empty.
1816		-1. ethernetGateway: The gateway can be configured when Ethernet static IP is used.
	1763	+width = 64,
1817	1817
1818		-1. When using the Ethernet network, if the Gateway is empty, V-BOX will not connect to the server.
1819		-1. If you only use Ethernet to directly connect to the PLC for communication, you do not need to configure a gateway.
	1765	+poly = 0x42F0E1EBA9EA3693,
1820	1820
1821		-1. ethernetFirstDns: You can configure the preferred DNS server when the Ethernet static IP is used, and it is allowed to be empty. If you use the Ethernet network and do not fill in the DNS server, V-BOX will not be connected to the server.
1822		-1. ethernetSpareDns: Alternate DNS server can be configured when the Ethernet static IP is used, and it is allowed to be empty.
1823		-1. wifiEnable: Whether to enable WIFI, 1: enable, 0: disable, it is not allowed to be empty. If it is a model that does not include WIFI, directly disable it.
1824		-1. wifiName: WIFI name, if WIFI is enabled, it is not allowed to be empty.
1825		-1. wifiPassword: WIFI password, it is allowed to be empty.
1826		-1. wifiIpMode: Whether to enable WIFI static IP, 1: Enable static IP, 0: DHCP, not allowed to be empty.
1827		-1. wifiIp: IP address needs to be configured when WIFI static IP is used, it is not allowed to be empty.
1828		-1. wifiNetmask: The subnet mask needs to be configured when WIFI static IP is used, and it is not allowed to be empty.
1829		-1. wifiGateway: The gateway can be configured when WIFI static IP is used, and it is not allowed to be empty.
1830		-1. wifiFirstDns: You can configure the preferred DNS server when the WIFI static IP is used, and it is allowed to be empty. If you use the WIFI network and do not fill in the DNS server, V-BOX will not be connected to the server.
1831		-1. wifiSpareDns: Alternate DNS server can be configured when the WIFI static IP is used, and it is allowed to be empty.
1832		-1. mobileEnable: Whether to enable the mobile network, 1: enable, 0: disable, it is not allowed to be empty, if it does not include 4G models, directly disable it.
1833		-1. mobileApnMode: Whether to manually configure the APN, 0: Use the default APN, 1: Manually configure the APN, it is not allowed to be empty.
1834		-1. apnName: APN name, if you choose to manually configure APN, it is not allowed to be empty.
1835		-1. apnPassword: APN username, it is allowed to be empty.
1836		-1. apnUserName: APN number, it is allowed to be empty.
1837		-1. apnNumber: APN number, it is allowed to be empty.
	1767	+init = 0xFFFFFFFFFFFFFFFF,
1838	1838
	1769	+xorout = 0xFFFFFFFFFFFFFFFF,
	1770	+
	1771	+refin = 1,
	1772	+
	1773	+refout = 1
	1774	+
	1775	+}
	1776	+
	1777	+crc64,err = crc.init(param)
	1778	+
	1779	+if not crc64 then
	1780	+
	1781	+print("Crc init failed:", err)
	1782	+else
	1783	+
	1784	+crcvalue = crc64:calc("123456789")
	1785	+
	1786	+print(string.format("crc64 calc :0X%16X", crcvalue))
	1787	+
	1788	+end
	1789	+
	1790	+end
	1791	+{{/code}}
	1792	+
	1793	+= **10 Special function for V-NET** =
	1794	+
	1795	+== **normal_get_alldata()** ==
	1796	+
	1797	+**Function: **Obtain the data of all the monitoring points
	1798	+
	1799	+**Parameter: None**
	1800	+
1839	1839	**Return:**
1840	1840
1841		-Succeed: true
	1803	+Succeed: table two-dimensional arrays, as follows:
1842	1842
1843		-Faied: multi
	1805	+* Each item is a monitoring point and contains 4 attributes:
	1806	+** 1: ID
	1807	+** 2: status
	1808	+** 3: tag name
	1809	+** 4: value
	1810	+* Status contains 3 enumerated values
	1811	+** 0: offline
	1812	+** 1: online
	1813	+** 2: timeout
	1814	+* Customization returns an empty table if there is no configuration, otherwise returns "field name/field content"
1844	1844
1845		-(((
1846		-== **9.7 {{id name="_Toc22969"/}}remote_com_start(string config)** ==
1847		-)))
	1816	+**For example:**
1848	1848
1849		-**Function:**
	1818	+{{code language="LUA"}}
	1819	+{
1850	1850
1851		-start serial port pass-through
	1821	+[1]= {[1]=1234, [2]=1, [3]='temp', [4]='23.5'},
1852	1852
	1823	+[2]= {[1]=1235, [2]=1, [3]='humi', [4]='67'},
	1824	+
	1825	+...
	1826	+
	1827	+[n]= {[1]=xxxx, [2]=x, [3]='xxxx', [4]='xx.x'},
	1828	+
	1829	+}
	1830	+
	1831	+Failed: table, empty table
	1832	+{{/code}}
	1833	+
	1834	+== **normal_setdata_byname(string name, string data)** ==
	1835	+
	1836	+**Function:** Write data to the monitoring point name
	1837	+
1853	1853	**Parameter:**
1854	1854
1855		-//config: //incoming serial port parameter configuration, JSON format
	1840	+name: the name of monitoring point
1856	1856
1857		-1. type:0, serial port pass-through
1858		-1. port: serial port number marked on the V-BOX
1859		-1. comtype:0-RS232, 1-RS485, 2-RS422
1860		-1. baudrate: Baud Rate
1861		-1. data_length: Data Bits
1862		-1. stop_bit: Stop Bit
1863		-1. check_bit: Check Bit
	1842	+data: the data to be written
1864	1864
1865	1865	**Return:**
1866	1866
1867		-Succeed: true
	1846	+Succeed: string: The value of the monitor point before it is written
1868	1868
1869		-Failed: multi
	1848	+Failed: nil
1870	1870
1871		-(((
1872		-== **9.8 remote_com_stop()** ==
1873		-)))
	1850	+== **normal_getdata_byname(string name)** ==
1874	1874
1875		-**Function:**
	1852	+**Function:** Read the data of the monitoring point name
1876	1876
1877		-close serial port pass-through
	1854	+**Parameter:**
1878	1878
	1856	+name: the name of monitoring point
	1857	+
1879	1879	**Return:**
1880	1880
1881		-Succeed: true
	1860	+Succeed: string
1882	1882
	1862	+Failed: nil
	1863	+
	1864	+= **11 MySQL database operation** =
	1865	+
	1866	+== **luaMySql.init(string sourcename, string username, string password, string host, number port, string character)** ==
	1867	+
	1868	+**Function:** Configure database connection parameters
	1869	+
	1870	+**Parameter:**
	1871	+
	1872	+sourcename: the name of database
	1873	+
	1874	+username: the username of the connection
	1875	+
	1876	+password: the password of the connection
	1877	+
	1878	+host: the host name of the connection
	1879	+
	1880	+port: the host port of the connection
	1881	+
	1882	+character: the character set of the connection
	1883	+
	1884	+**Return:**
	1885	+
	1886	+Succeed: string
	1887	+
1883	1883	Failed: multi
1884	1884
1885		-(((
1886		-== **9.9{{id name="_Toc22824"/}} remote_com_state()** ==
1887		-)))
	1890	+== **luaMySql.exec(string statement)** ==
1888	1888
1889		-**Function:**
	1892	+**Function:** Execute the given SQL statement without returning the result set (add, delete, change)
1890	1890
1891		-query the serial port pass-through status and pass-through server domain name and port
	1894	+**Parameter:**
1892	1892
	1896	+statement: the given SQL statement
	1897	+
1893	1893	**Return:**
1894	1894
1895		-Succeed:
	1900	+Succeed: status: returns the number of rows affected by SQL statement execution.
1896	1896
1897		-1. number, current pass-through status: 0-none 1,2-starting pass-through 3-penetrating 4,5-finishing pass-through 6-pass-through error
1898		-1. string, pass-through server domain name and port number, xxxx (domain name): xxx (port number)
	1902	+Failed: nil, errorString
1899	1899
1900		-{{id name="OLE_LINK9"/}}Failed: multi
	1904	+== **luaMySql.execWithResult(string statement)** ==
	1905	+
	1906	+**Function:** Execute the given SQL statement returning the result set (check)
	1907	+
	1908	+**Parameter:**
	1909	+
	1910	+statement: the given SQL statement
	1911	+
	1912	+**Return:**
	1913	+
	1914	+Succeed: table: returns the result set
	1915	+
	1916	+Failed: nil, errorString
	1917	+
	1918	+**For example:**
	1919	+
	1920	+{{code language="LUA"}}
	1921	+mysql = require"mysqlclient"
	1922	+
	1923	+function DataInitRight()
	1924	+
	1925	+local dbName = "db_lua1"
	1926	+
	1927	+local user = "root"
	1928	+
	1929	+local pwd = "123456"
	1930	+
	1931	+local host = "192.168.56.186"
	1932	+
	1933	+local port = 3306
	1934	+local character = "UTF8"
	1935	+
	1936	+mysql.init(dbName, user, pwd, host, port, character)
	1937	+
	1938	+end
	1939	+
	1940	+function ExecFunc()
	1941	+
	1942	+status, errorString = mysql.exec("delete from tb_lua1 where mykey =
	1943	+
	1944	+10;")
	1945	+
	1946	+if nil == status then
	1947	+
	1948	+print("ExecFunc() error:", errorString)
	1949	+
	1950	+return -1
	1951	+
	1952	+else
	1953	+
	1954	+print("the number of rows affected by the command:", status)
	1955	+
	1956	+end
	1957	+
	1958	+return 0
	1959	+
	1960	+end
	1961	+
	1962	+function ExecWithResultFunc()
	1963	+
	1964	+status, errorString = mysql.execWithResult("select * from tb_lua1;")
	1965	+
	1966	+if nil == status then
	1967	+
	1968	+print("ExecWithResultFunc() error:", errorString)
	1969	+
	1970	+return -1
	1971	+
	1972	+else
	1973	+
	1974	+print("ExecWithResultFunc()
	1975	+
	1976	+success
	1977	+
	1978	+: status
	1979	+
	1980	+type
	1981	+
	1982	+=
	1983	+
	1984	+",
	1985	+
	1986	+type(status))
	1987	+
	1988	+print("ExecWithResultFunc() success : status len = ", #status)
	1989	+
	1990	+local num = #status
	1991	+
	1992	+local i = 1
	1993	+
	1994	+if num > 0 then
	1995	+
	1996	+for i = 1, num, 1 do
	1997	+
	1998	+local var = string.format("select result[%d] :mykey = %d,
	1999	+
	2000	+value = %s", i, status[i].mykey, status[i].value)
	2001	+
	2002	+print(var)
	2003	+
	2004	+end
	2005	+
	2006	+end
	2007	+
	2008	+print("---------------")
	2009	+
	2010	+end
	2011	+
	2012	+return 0
	2013	+end
	2014	+
	2015	+function luaMysql_apiTest.main()
	2016	+
	2017	+print("script running ...")
	2018	+
	2019	+DataInitRight()
	2020	+
	2021	+--use exec demo
	2022	+
	2023	+if ExecFunc() < 0 then
	2024	+
	2025	+return
	2026	+
	2027	+end
	2028	+
	2029	+--use execWithResult demo
	2030	+
	2031	+if ExecWithResultFunc() < 0 then
	2032	+
	2033	+return
	2034	+
	2035	+end
	2036	+
	2037	+print("script running success")
	2038	+
	2039	+end
	2040	+{{/code}}
	2041	+
	2042	+= **12 Message summary algorithm** =
	2043	+
	2044	+== **hmac(string hash_func, string key, string message)** ==
	2045	+
	2046	+**Function:** HMAC calculate
	2047	+
	2048	+**Function name**
	2049	+
	2050	+hash_func:
	2051	+
	2052	+* [md5, sha1, sha224, sha256, sha384, sha512]
	2053	+* [sha512_224, sha512_256, sha3_224, sha3_256]
	2054	+* [sha3_384, sha3_512]
	2055	+
	2056	+**Parameter:**
	2057	+
	2058	+key: the key
	2059	+
	2060	+message: message content
	2061	+
	2062	+**Return:**
	2063	+
	2064	+Succeed: string, calculation result
	2065	+
	2066	+Failed: nil
	2067	+
	2068	+**For example:**
	2069	+
	2070	+{{code language="LUA"}}
	2071	+local sha = require"sha2"
	2072	+
	2073	+function hmac_test.main()
	2074	+
	2075	+local hmac = sha.hmac
	2076	+
	2077	+print(hmac(sha.sha1,
	2078	+
	2079	+"your key", "your message"))
	2080	+
	2081	+end
	2082	+{{/code}}
	2083	+
	2084	+== **sha(string message** ==
	2085	+
	2086	+**Function:** SHA calculate
	2087	+
	2088	+**Function name:**
	2089	+
	2090	+sha:
	2091	+
	2092	+* sha1, sha224, sha256, sha384, sha512]
	2093	+* [sha512_224, sha512_256, sha3_224, sha3_256]
	2094	+* [sha3_384, sha3_512]
	2095	+
	2096	+**Parameter:**
	2097	+
	2098	+key: the key
	2099	+
	2100	+message: message content
	2101	+
	2102	+**Return:**
	2103	+
	2104	+Succeed: string, calculation result
	2105	+
	2106	+Failed: nil
	2107	+
	2108	+For example:
	2109	+
	2110	+{{code language="LUA"}}
	2111	+local sha = require"sha2"
	2112	+
	2113	+function sha_test.main()
	2114	+
	2115	+local sha256 = sha.sha256
	2116	+
	2117	+print(sha256("your message"))
	2118	+
	2119	+end
	2120	+{{/code}}