Skip to Content

Wiki source code of 08 Macro Script

Version 30.1 by Stone Wu on 2023/02/20 17:49
Show last authors
1 This chapter provides information about scripts in PIStudio.
2
3 = **Script type** =
4
5 Script is applied to realize complex control functions. HMI compile software provide powerful function, simple operation, reliable script system, the features of script are list as follow:
6
7 Similar to BASIC grammatical structure;
8
9 * BASIC work as the first computer language for the general public, it is easy and efficient to use.
10
11 Support all of program logic control structures;
12
13 * Software script supports three logic control structures: order, condition, loops. It could realize complexity procedures.
14
15 Powerful function; Functions of script are divided into two types: system and custom function.
16
17 * System function: the functions that system has been predefined for users.
18 * Custom function: users could define a function and apply to all scripts.
19
20 Support variety of data format;
21
22 * Script supports integer, floating, BCD code, byte, string and etc.
23
24 **Scripts Running Method**
25
26 1. **Background Script:** Run independently during start project, screen updates have no influence and valid of all scripts.
27 1. **Screen Script:** Only run under the designated screen. Screen script start running until screen is closed or switched.
28
29 And both screen and background have four modes for script
30
31 (% class="table-bordered" %)
32 |=**Property**|=**Description**
33 |Initialize|The script would be executed once during loading project.
34 |Close|The script would be run once during closing HMI project.
35 |Timing|The script would run under certain conditions after the HMI is started, until the condition ends.
36 |Bit trigger|Script would be repeat executed when meet the condition of bit trigger.
37
38 == Initialize ==
39
40 Initialize script divided into screen initialize script and background initialize script. Screen initialize script runs once during the initialization of screen; background initialize script runs during the loading of project.
41
42 **Operating procedures**
43
44 Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
45
46 (% style="text-align:center" %)
47 [[image:9.Scripts_html_96fb2991c0580f0f.gif||class="img-thumbnail"]]
48
49
50 (% style="text-align:center" %)
51 [[image:9.Scripts_html_3cebb8edeabbd760.gif||class="img-thumbnail"]]
52
53 Double click "initialize" to open script edit window, as below shows;
54
55 (% style="text-align:center" %)
56 [[image:9.Scripts_html_8d93c592be893fad.gif||class="img-thumbnail"]]
57
58 Enter scripts in edit window;
59
60 == Close ==
61
62 Close script divided into screen close script and background close script. Screen close script runs once During the destroying of screen because of closing or switching; background close script runs during the closing of project (such as restart HMI, into HMI setup).
63
64 **Operating procedures**
65
66 1. Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
67 1. Double click "Close" to open script edit window;
68 1. Enter scripts in edit window;
69
70 == Timing ==
71
72 The script would run for a designated time interval.
73
74 **Operating procedures of creating one**
75
76 Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
77
78 Double click "Timing", it would pop-up below setting window;
79
80 (% style="text-align:center" %)
81 [[image:9.Scripts_html_ca0d08792c31539e.gif||class="img-thumbnail"]]
82
83 (% class="table-bordered" %)
84 |=**Property**|=**Description**
85 |Cycle|Script runs at designated time interval, unit is 10 ms.
86 |Ok|Script created.
87 |Cancel|Cancel the current script setting.
88
89 Enter scripts in edit window;
90
91 **Operating procedures of editing**
92
93 1. Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
94 1. Select "Timing", and click [[image:9.Scripts_html_d1db672f9b0fe31.gif]] to modify the script execution interval;
95 1. Double click selected "Timing" to open editing window;
96
97 **Operating procedures of deleting**
98
99 Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
100
101 (% style="text-align:center" %)
102 [[image:9.Scripts_html_f7b5302abd3000e3.gif||class="img-thumbnail"]]
103
104 Select "Timing", and click  [[image:9.Scripts_html_75dc3ed25fdbc359.gif]] to change interval of script, it pops-up above window
105
106 Select "Yes" to execute operation or select "No" to cancel operation;
107
108 (% class="box infomessage" %)
109 (((
110 **✎Note:** The maximum number of timing script for each screen or background is 32.
111 )))
112
113 == Trigger bit ==
114
115 **Introduction**
116
117 Trigger control script is that software will check whether the designated bit meet trigger condition every 20ms. Script execute once condition is met until project closed.
118
119 **Operating procedures of creating one**
120
121 Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
122
123 Double click "Trigger bit", it pops-up below setting window;
124
125 (% style="text-align:center" %)
126 [[image:9.Scripts_html_5aa68df50f16cfa2.gif||class="img-thumbnail"]]
127
128 * Bit address: It sets trigger address for script;
129 * Condition: detailed information as below shows;
130
131 (% class="table-bordered" %)
132 |=**Condition**|=**Description**
133 |TRUE|Script execute once the bit value is TRUE, detects the bit every per approximately 20 ms;
134 |FALSE|Script execute once the bit value is FALSE, detects the bit every per approximately 20 ms;
135 |Bit changed|Execute once the trigger bit switches state;
136 |Rising|Script execute once the bit value from FALSE to TRUE, detects the bit every per approximately 20 ms;
137 |Falling|Script execute once the bit value from TURE to FALSE, detects the bit every per approximately 20 ms;
138
139 Set trigger bit and condition, click "OK" to open editing window.
140
141 **Operating procedures of editing**
142
143 * Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
144 * Select "Trigger script", and click [[image:9.Scripts_html_d1db672f9b0fe31.gif]] to change trigger bit and condition;
145 * Double click selected "Trigger script" to open editing window.
146
147 **Operating procedures of deleting**
148
149 * Click "Background script" in project manager to enter script editor screen, or click "Screen script" in right click menu of screen to enter script editor screen;
150 * Select "Trigger script", and click [[image:9.Scripts_html_75dc3ed25fdbc359.gif]] to change interval of script, it pops-up below window
151
152 (% style="text-align:center" %)
153 [[image:9.Scripts_html_f7b5302abd3000e3.gif||class="img-thumbnail"]]
154
155 * Select "Yes" to execute operation or select "No" to cancel operation;
156
157 (% class="box infomessage" %)
158 (((
159 **✎Note:** The maximum number of trigger script for each screen or background is 32.
160 )))
161
162 == Background function ==
163
164 Global function is a collection of codes;it can be called in any script.The method reference system function;
165
166 **Operating procedures**
167
168 Double click "Background function" in project manager;
169
170 (% style="text-align:center" %)
171 [[image:9.Scripts_html_6240f0610ba63eff.gif||class="img-thumbnail"]]
172
173 Set parameters;
174
175 (% style="text-align:center" %)
176 [[image:9.Scripts_html_d196f8a817949f3e.gif||class="img-thumbnail"]]
177
178 (% class="table-bordered" %)
179 |**Property**|**Description**
180 |Function name|Function name could not be the same as existing.
181 |Return type|None, string, integer, float.
182 |Parameter 1|The name of parameter 1.
183
184 **Operating procedures of editing**
185
186 * Click "Background function" in project manager to enter script editor screen;
187 * Select Function name, and click [[image:9.Scripts_html_c653b64bc266a016.gif]] to change parameters;
188 * Double click selected "Trigger script" to open editing window;
189
190 **Operating procedures of deleting**
191
192 * Click "Background function" in project manager to enter script editor screen;
193 * Select Function name, and click  [[image:9.Scripts_html_75dc3ed25fdbc359.gif]] to change interval of script, it pops-up below window
194
195 (% style="text-align:center" %)
196 [[image:9.Scripts_html_f7b5302abd3000e3.gif||class="img-thumbnail"]]
197
198 * Select "Yes" to execute operation or select "No" to cancel operation;
199
200 (% class="box infomessage" %)
201 (((
202 **✎Note:** The maximum parameters for each function are 4, and parameter name can't be unique;
203 )))
204
205 = Script usage =
206
207 Script can make project more convenient and flexible. Script is useful in realizing complex HMI function. If the script is used improperly, it may affect the efficiency of entire project. So pay attention to the follow issues:
208
209 * Do not use too much script loops, if the script loops that execute too many times; it might influence the efficiency of HMI.
210 * In the cycle scripts, avoid using external register, due to the relatively slow serial communication, frequent access to external registers may cause the execution of scripts severely reduced, even influence the screen respond efficiently. There is fine to use internal register.
211 * The maximum script length is 512 rows.
212
213 This section describes how to edit scripts and use some of the accompanying tools and features of the script editor.
214
215 == **Script access to d evice** ==
216
217 Software script supports an efficiency way to access the device address by using symbol @.
218
219 (% class="table-bordered" %)
220 |=**Writing**|=**Meaning**|=**Examples**
221 |@B_;@b_;|Access designated bit address|(((
222 @B_I0.0:access bit address I0.0
223
224 @b_HDX0.0:access bit address HDX0.0
225 )))
226 |@W_;@w_;|(% rowspan="2" %)(((
227 Access designated word address
228
229 HMI connect more than automatic control devices, "#"stands for choosing number before the symbol,":"stands for accessing the station number before symbol.
230
231 Access the first protocol without "#",access default station number1 without":".
232 )))|(((
233 @W_IW0:access word address IW0
234
235 @b_HDW0:access word address HDW0
236 )))
237 |@B_(the number of protocol connection)#(station number):address|(((
238 @B_2#2:I0.0:access the bit address I0.0, with the connection number 2 and station number 2;
239
240 @B_I0.0:access to bit address I0.0;
241 )))
242
243 The script can access with the device though: write and read.
244
245 **For example**
246
247 {{code language="basic"}}
248 If @B_HDX0.0 = 1 then 'read the value from address HDX0.0.
249
250 @B_HDX0.0 = 0 'write 0 to address HDX0.0
251
252 Else
253
254 @B_HDX0.0 = 1 'write 1 to address HDX0.0
255
256 Endif
257
258 @W_QW0 = @W_QW0 + 1 'read data from address QW0, add 1 to this value then write to address QW0
259 {{/code}}
260
261 == **Grammar checking** ==
262
263 **Operating procedures**
264
265 1. Select [[image:9.Scripts_html_2a530bda982b4281.gif]] from script tool bar;
266 1. System does not prompt grammar error if grammar is correct, or system will list all errors;
267 1. Check error information, and modify errors;
268
269 **Error information**
270
271 ~1. Identifier ~*~** contains invalid characters
272
273 2. Attempt to redeclare sub ~*~**
274
275 3. Attempt to redeclare function ~*~**
276
277 4. Attempt to use reserved word ~*~** as identifier
278
279 5. Attempt to use type ~*~** as identifier
280
281 6. Unexpected ')' while parsing arguments for function ~*~**
282
283 7. Could not parse expression (one of the arguments of function ~*~**)
284
285 8. Could not parse arguments of ~*~**
286
287 9. Too many arguments for function ~*~**
288
289 10. Not enough arguments for function ~*~**
290
291 ~11. '(' expected after sub name ~*~**
292
293 12. Unexpected '(' while parsing arguments for sub ~*~**
294
295 13. Could not parse expression (one of the arguments of sub ~*~**)
296
297 14. Could not parse arguments of ~*~**
298
299 15. Too many arguments for sub/function ~*~**
300
301 16. Not enough arguments for sub/function ~*~**
302
303 17. Could not parse expression
304
305 18. '(' expected after function name ~*~**
306
307 19. Unexpected use of sub ~*~** as a part of expression
308
309 20. Illegal statements preceding subs/functions declaration
310
311 21. Unexpected end of file while looking for 'endsub'
312
313 22. End of line expected after 'else'.
314
315 23. End of line expected after 'endif'.
316
317 24. End of line expected after 'next'.
318
319 25. End of line expected after 'wend'.
320
321 26. 'while', 'until' or end of line expected afte r'do'.
322
323 27. Could not parse expression after 'while'
324
325 28. Could not parse expression after 'until'
326
327 29. 'do' without 'loop'
328
329 30. Sub ~*~** contains invalid character'@'
330
331 31. Sub ~*~** already declared
332
333 32. Function ~*~** already declared
334
335 33. Sub name expected after 'sub'
336
337 34. Function name expected after 'function'
338
339 35. Variable name expected
340
341 36. Argument ~*~** contains invalid character '@'
342
343 37. 'integer', 'floating' or 'string' expected
344
345 38. ''',' or ')' expected
346
347 39. 'endsub' without 'sub'
348
349 40. 'end function' without 'function'
350
351 41. End of line expected after 'beep'
352
353 42. 'dim' unexpected here
354
355 43. Variable name expected after 'dim'
356
357 44. 'as' expected after variable name
358
359 45. 'integer' 'floating' or 'string' expected after 'as'
360
361 46. ',' or end of line expected after type in dim statement
362
363 47. Could not parse expression after 'while'
364
365 48. End of line expected after' while' condition
366
367 49. 'while' without 'wend'
368
369 50. End of line expected after 'wend'
370
371 51. 'wend' without 'while'
372
373 52. Variable name expected after' for'
374
375 53. '=' expected after variable name
376
377 54. Could not parse expression after 'for'
378
379 55. 'to' expected
380
381 56. Could not parse expression after 'to'
382
383 57. Could not parse expression after 'step'
384
385 58. End of line expected
386
387 59. 'for' without 'next'
388
389 60. End of line expected after 'next'
390
391 61. 'Next' without 'for'
392
393 62. Could not parse expression after'if'
394
395 63. 'then' expected
396
397 64. Unexpected end of file while looking for 'endif'
398
399 65. Unexpected end of file while looking for 'else' or 'endif'
400
401 66. 'else' without ‘if'
402
403 67. 'end if' without 'if'
404
405 68. Label name expected after 'goto'
406
407 69. Unexpected end of line while looking for ')' in function call
408
409 70. ',' expected
410
411 71. Missing ')'
412
413 72. Unexpected end of line in expression
414
415 73. Unexpected end of file in expression
416
417 = **Script function list** =
418
419 == Mathematical ==
420
421 (% class="table-bordered" %)
422 |=(% style="width: 181px;" %)**Function**|=(% style="width: 1308px;" %)**Introduction**
423 |[[Abs>>||anchor="HAbs"]]|Get absolute value
424 |[[ACos>>||anchor="HACos"]]|Compute the inverse cosine value
425 |[[Asc>>||anchor="HAsc"]]|Return the first character of the string in ASCII value
426 |[[ASin>>||anchor="HASin"]]|Calculate the arcsine value
427 |[[ATan>>||anchor="HATan"]]|Return an arctangent value,the radian ranges -pi/2 to pi/2
428 |[[ATan2>>||anchor="HATan2"]]|Return the arctangent value
429 |[[Cos>>||anchor="HCos"]]|Return a cosine value of an angle
430 |[[Exp>>||anchor="HExp"]]|
431 |[[Hypot>>||anchor="HHypot"]]|Calculate the value of the hypotenuse of a right triangle
432 |[[Tan>>||anchor="HTan"]]|Implement tan calculation to computing the value
433 |[[Sin>>||anchor="HSin"]]|Implement sin calculation to computing the value
434 |[[Sqr>>||anchor="HSqr"]]|Assign a square root value
435 |[[SignedInt16>>||anchor="HSignedInt16"]]|Assign the value to [val] from address A1 which is signed integer
436 |[[SignedInt32>>||anchor="HSignedInt32"]]|Assign the value to [val] from address A1 which is signed even integer
437
438 == Data migration ==
439
440 (% class="table-bordered" %)
441 |=(% style="width: 178px;" %)**Function**|=(% style="width: 1311px;" %)**Introduction**
442 |[[BMOV>>||anchor="HBMOV"]]|Copy data with a designated length from source address
443 |[[FILL>>||anchor="HFILL"]]|Write the same value to designated address constantly
444 |[[SetKeyMap>>||anchor="HSetKeyMap"]]|The key values of the keyboard are mapped so that multiple keyboard buttons perform the same function
445
446 == Process control ==
447
448 (% class="table-bordered" %)
449 |=(% style="width: 181px;" %)**Function**|=(% style="width: 1308px;" %)**Introduction**
450 |[[Goto>>||anchor="HGoto"]]|Go to the designated row unconditionally in a function body
451 |FOR|Execute a command repeatedly for designated times
452 |[[End>>||anchor="HEnd"]]|End the execution of script
453 |while|If the condition is true, then all the commands before Wend in the statement will be executed and then recheck the condition, if the condition is false, the command after Wend will be executed
454
455 == Data conversion ==
456
457 (% class="table-bordered" %)
458 |=(% style="width: 182px;" %)**Function**|=(% style="width: 1307px;" %)**Introduction**
459 |[[A2H>>||anchor="HA2H"]]|Convert string A1 to hexadecimal number
460 |[[AsFloating>>||anchor="HAsFloating"]]|Convert parameter to a float
461 |[[AsInteger>>||anchor="HAsInteger"]]|Convert parameter to a integer
462 |[[AsString>>||anchor="HAsString"]]|Convert parameter to a string
463 |[[B2W>>||anchor="HB2W"]]|Convert an array
464 |[[BCD>>||anchor="HBCD"]]|Convert binary to BCD, save the result as return value
465 |[[BIN>>||anchor="HBIN"]]|Convert BCDto binary, save the result in return value
466 |[[Chr>>||anchor="HChr"]]|Convert integer parameter into correspond ASCII character,return the character string
467 |[[D2F>>||anchor="HD2F"]]|Convert the 32 bit integer format data to float then output the result
468 |[[D2Float>>||anchor="HD2Float"]]|Convert the designated value to floating then assign to variable
469 |[[D2Int>>||anchor="HD2Int"]]|Output the 32-bit integer in the form of integer
470 |[[DegToRad>>||anchor="HDegToRad"]]|Convert the angle into correspond radian, and display
471 |[[F2D>>||anchor="HF2D"]]|Convert a 32 bit floating to integer format, and then output the result
472 |[[F2S>>||anchor="HF2S"]]|Output a format of floating that in the type of string
473 |[[Float2D>>||anchor="HFloat2D"]]|Copy floating value to the address
474 |[[H2A>>||anchor="HH2A"]]| of ASCII
475 |[[Int2D>>||anchor="HInt2D"]]|Write the 32-bit integer into the specified address
476 |[[Lcase>>||anchor="HLcase"]]|Convert all parameters to lowercase strings
477 |[[MAX>>||anchor="HMAX"]]|Compare the value of A2 and A3, assign the greater number to A1
478 |[[MIN>>||anchor="HMIN"]]|Compare the value of A2 and A3, assign the smaller number to A1
479 |[[RadToDeg>>||anchor="HRadToDeg"]]|Convert radiant value to degree
480 |[[S2F>>||anchor="HS2F"]]|Convert string to floating in the specified format
481 |[[SWAP>>||anchor="HSWAP"]]|Exchange the high and low bytes of the parameter
482 |[[W2B>>||anchor="HW2B"]]|Combine the high byte of the value of two consecutive addresses into a new value
483 |[[W2D>>||anchor="HW2D"]]|Convert the unsigned Word to unsigned Dword and save the result
484 |[[W2F>>||anchor="HW2F"]]|Convert a 16bit integer to a 32bit floating, and then save to the next word address
485 |[[W2S>>||anchor="HW2S"]]|Convert integer word text as S1 format, and then save
486
487 == String processing ==
488
489 (% class="table-bordered" %)
490 |=(% style="width: 180px;" %)**Function**|=(% style="width: 1309px;" %)**Introduction**
491 |[[A2I>>||anchor="HA2I"]]|A string of length is intercepted from A1 and converted to a single/double word integer, and then this integer is assigned to A2
492 |[[InStr>>||anchor="HInStr"]]|Return the position of str1 in str2
493 |[[Left>>||anchor="HLeft"]]|Return a string of the specified length from the left side of parameter
494 |[[Len>>||anchor="HLen"]]|Return the string length
495 |[[LTrim>>||anchor="HLTrim"]]|Remove the left empty part of the string and return
496 |[[Mid>>||anchor="HMid"]]|Returns a string contain a specified characters length from a string
497 |[[Right>>||anchor="HRight"]]|Return a string of the specified length from the right side of parameter
498 |[[RTrim>>||anchor="HRTrim"]]|Clear the empty part on the right side of string [str], then assign the empty part to val
499 |[[Trim>>||anchor="HTrim"]]|Return a value of an address without empty string next to it
500 |[[UCase>>||anchor="HUCase"]]|Capitalize the string data, and then assign the value to val
501
502 == Fixed constant ==
503
504 (% class="table-bordered" %)
505 |=**Function**|=**Introduction**
506 |Pi|pi = 3.14159265358979321
507 |True|TRUE = 1
508 |False|FALSE = 0
509 |Operator|Operator in scripts edit window
510 |Variable|A variable is any factor, trait, or condition that can exist in differing amounts or types
511
512 == **Bit control** ==
513
514 (% class="table-bordered" %)
515 |=(% style="width: 178px;" %)**Function**|=(% style="width: 1311px;" %)**Introduction**
516 |[[Clrb>>||anchor="HClrb"]]|Set the bit of A1 as FALSE
517 |[[InvB>>||anchor="HInvB"]]|The state of inverse bit
518 |[[SetB>>||anchor="HSetB"]]|Set the bit A1 ON
519
520 == File operation ==
521
522 (% class="table-bordered" %)
523 |(% style="width:177px" %)**Function**|(% style="width:1312px" %)**Introduction**
524 |[[HmiRegoperator>>||anchor="HHmiRegoperator"]]|Data of Upload/ Download address
525 |[[CopyFile>>||anchor="HCopyFile"]]|Copy the A3 file from the A1 directory to the A2 directory according to the format of A4 and A5
526 |[[DbToCSVFile>>||anchor="HDbToCSVFile"]]| file to csv format and export it
527 |[[FileCmpDir>>||anchor="HFileCmpDir"]]|The filename input and the filename in the folder whether is duplicate or not
528 |[[MyDeleteFile>>||anchor="HMyDeleteFile"]]|Delete the designated file
529 |[[WriteWordToFile>>||anchor="HWriteWordToFile"]]|Write data with designated length to designated file
530 |[[ReadWordFormFile>>||anchor="HReadWordFormFile"]]|Read data with designated length from designated file
531
532 == Comparison ==
533
534 (% class="table-bordered" %)
535 |=(% colspan="2" style="width: 389.5px;" %)Function|=Introduction
536 |(% rowspan="8" %)IF... THEN GOTO...|(% style="width:148.719px" %)IF=|(% rowspan="18" style="width:691.5px" %)Execute correspond instruction when fulfill condition. Condition will be tested during executing if. it will execute the next instruction block of then, if condition is true. Otherwise, execute the later of else. Complete the two instructions, next execute the later of End if.
537 |(% style="width:148.719px" %)IF<>
538 |(% style="width:148.719px" %)IF>
539 |(% style="width:148.719px" %)IF>=
540 |(% style="width:148.719px" %)IF<
541 |(% style="width:148.719px" %)IF<=
542 |(% style="width:148.719px" %)IF AND=0
543 |(% style="width:148.719px" %)IF AND<>0
544 |(% rowspan="8" style="width:255.281px" %)IF|(% style="width:148.719px" %)IF=
545 |(% style="width:148.719px" %)IF<>
546 |(% style="width:148.719px" %)IF>
547 |(% style="width:148.719px" %)IF>=
548 |(% style="width:148.719px" %)IF<
549 |(% style="width:148.719px" %)IF<=
550 |(% style="width:148.719px" %)IF AND=0
551 |(% style="width:148.719px" %)IF AND<>0
552 |(% colspan="2" style="width:389.5px" %)ELSE
553 |(% colspan="2" style="width:389.5px" %)ENDIF
554
555 == **Applicatio**n** type** ==
556
557 (% class="table-bordered" %)
558 |=(% style="width: 181px;" %)**Function**|=(% style="width: 1308px;" %)**Introduction**
559 |[[AddrStringCompare>>||anchor="HAddrStringCompare"]]|Compare the designated length of two character strings
560 |[[Beep>>||anchor="HBeep"]]|Enable buzzer
561 |[[IsFloating>>||anchor="HIsFloating"]]|whether a parameter is floating, return TRUE if it is floating, otherwise return FALSE
562 |[[IsInteger>>||anchor="HIsInteger"]]|whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE
563 |[[Log>>||anchor="HLog"]]|Log function: return the natural logarithm of the value
564 |[[Log10>>||anchor="HLog10"]]|Log function: return the natural logarithm of the value
565 |[[MSeconds>>||anchor="HMSeconds"]]|Display the current microseconds of system
566 |[[NewNoAddr>>||anchor="HNewNoAddr"]]|At the basic of source address A2,offset designated length,obtain a new address A1
567 |[[NewStatAddr>>||anchor="HNewStatAddr"]]|At the basic of source address A2,offset the designated length,to obtain a new station A1.
568 |[[NStringCompare>>||anchor="HNStringCompare"]]|Compare whether the designated length of two strings is the same,return 1 to A1 if yes,otherwise return 0
569 |[[Power>>||anchor="HPower"]]|The value of [expr2] to the power of [expr1] will be assigned to Var
570 |[[RAND>>||anchor="HRAND"]]|Generate a random number
571 |[[ReadAddr>>||anchor="HReadAddr"]]|Assign the value in the specified address to [word]
572 |[[SleepA>>||anchor="HSleepA"]]|Wait time T(ms)
573 |[[WriteAddr>>||anchor="HWriteAddr"]]|Assign the value from A2 to address A1
574
575 == Others ==
576
577 (% class="table-bordered" %)
578 |=(% style="width: 182px;" %)**Function**|=(% style="width: 1307px;" %)**Introduction**
579 |[[DIM...AS...>>||anchor="HDIM...AS..."]]|Declare a variable
580 |do|Condition determent instruction
581 |[[Function>>||anchor="HFunction"]]|Differ from internal function, need to declare the name, parameter, code of the function
582 |[[Sub>>||anchor="HSub"]]|Declare the name, parameters and codes of the Sub (sub function)
583 |[[PrintText>>||anchor="HPrintText"]]|Output the contents to the printer for printing
584 |[[PI_GetTickCount>>||anchor="HPI_GetTickCount"]]|Write the starting time in the set address as a 32-bit integer
585 |[[StAndFtChange>>||anchor="HStAndFtChange"]]|Calculate the number of seconds from January 1, 1970 to the current time
586 |[[GetServerDelayInfo>>||anchor="HGetServerDelayInfo"]]|Convert string to hexadecimal number
587
588 = **Function description** =
589
590 == A2H ==
591
592 **Function**
593
594 Val = A2H(A1)
595
596 **Description**
597
598 Convert string in the specified address to a hexadecimal number;
599
600 **Parameters**
601
602 * **A1:** Source data, only convert the first four digits of string
603 * **Val:** The value is hexadecimal number.
604
605 **Example**
606
607 {{code language="basic"}}
608 @W_HDW20=A2H(@W_HDW10) ' convert the string of HDW10 to hex then save in HDW20.
609 {{/code}}
610
611 **Input:** @W_HDW10=255
612
613 **Result:** @W_HDW20=255
614
615 (% class="box infomessage" %)
616 (((
617 **✎Note:**
618
619 * A1 needs to be address (such as:@W_HDW000002).
620 * Only [0~~1], [a~~f] can be converted, others will be converted to 0
621 )))
622
623 == A2I ==
624
625 **Function**
626
627 A2I (A1, A2, length, S)
628
629 **Description**
630
631 Intercept a string of the specified length from A1,convert it to a single/double word integer and assign this integer to A2.
632
633 **Parameters**
634
635 * **A1:** String to be intercepted
636 * **A2:** The final integer value
637 * **Length:** intercepts the length of the string
638 * **S:** Control single or double words.
639 ** S=0, indicating an integer single word; S=1, indicating an integer double word.
640
641 **Return value:** none
642
643 **Example**
644
645 {{code language="basic"}}
646 A2I("@W_HDW200","@W_HDW100",4,0) 'converts a string into a 16-bit (single word) decimal integer
647
648 A2I("@W_HDW600","@W_HDW500",4,1)' converts a string to a 32-bit (double word) decimal integer
649 {{/code}}
650
651 **Input: **@W_HDW200="12345", **Result:** @W_HDW100=1234
652
653 **Input: **@W_HDW600="12345", **Result:** @W_HDW500=1234
654
655 (% class="box infomessage" %)
656 (((
657 **✎Note:** A1 and A2 need to be address (such as:@W_HDW000002).
658 )))
659
660 == **Abs** ==
661
662 **Function**
663
664 val = Abs(A1)
665
666 **Description**
667
668 The absolute value of A1.
669
670 **Parameters**
671
672 * **A1: **the data of absolute value, need to be variable.
673 * **Val: **it is absolute value that is address or variable.
674
675 **Example**
676
677 {{code language="lua"}}
678 Dim a as integer 'a is defined as integer
679
680 a = SignedInt16("@W_HDW0")'convert the data of @W_HDW0 into signed data.
681
682 @W_HDW1 = Abs(a) 'assign the returned absolute value to @W_HDW1
683 {{/code}}
684
685 **Input: **@W_HDW0=-6
686
687 **Result: **@W_HDW1=6
688
689 (% class="box infomessage" %)
690 (((
691 **✎Note: SignedInt16** function is designed to convert unsigned to signed.
692 )))
693
694 == **ACos** ==
695
696 **Function**
697
698 val = ACos(A1)
699
700 **Description**
701
702 To compute the inverse cosine value of A1.
703
704 **Parameters**
705
706 * **A1: **floating value, can be an address or variable.
707 * **Val: **return value is floating, can be an address or variable.
708
709 **Example**
710
711 {{code language="lua"}}
712 Dim a ,b as floating'define two float variable a,b
713
714 a = 0.5 'assign the designated value to a
715
716 b = ACos(a) 'the inverse cosine value of "a" is a radian which assign to variable b.
717
718 'to add the following sentence if needed to view the return value:
719
720 float2d("@W_HDW200", b)'float b written into HDW200.
721 {{/code}}
722
723 **Result:** @W_HDW200=1.047
724
725 (% class="box infomessage" %)
726 (((
727 **✎Note:** Please call **RadToDeg** function to convert radian into angle.
728 )))
729
730 == **AddrStringCompare** ==
731
732 **Function**
733
734 val = AddrStringCompare(A1, A2, length)
735
736 **Description**
737
738 It is designed to compare the designated length of two character strings. The string value is 1 when the two strings are the same.
739
740 **Parameters**
741
742 * **A1, A2: **character string, need to be an address (such as:"@W_HDW000002")
743 * **Length: **The length of character string.
744 * **Val: **Return value, 0 or 1.
745
746 **Example**
747
748 {{code language="lua"}}
749 if AddrStringCompare("@W_HDW10","@W_HDW0",2)=1 then
750
751 'compare the character string of HDW10 and @W_HDW0 whether value are 1.
752
753 @W_HDW20=1 '@W_HDW20 display 1
754
755 else
756
757 @W_HDW20=0'@W_HDW20 display 0
758
759 Endif
760 {{/code}}
761
762 **Input: **@W_HDW10="1a2 ", @W_HDW0="1a2 ",
763
764 **Result:** @W_HDW20=1
765
766 **Input: **@W_HDW10="ab2 ", @W_HDW0="12a ",
767
768 **Result: **@W_HDW20=0
769
770 == **Asc** ==
771
772 **Function**
773
774 val = Asc(A1)
775
776 **Description**
777
778 Return the first character of the string in ASCII value.
779
780 **Parameters**
781
782 * **A1:**character string, it can be an address (such as: @W_HDW000002)
783 * **val:**return value,ASCII value,it could be an address or variable.
784
785 **Example**
786
787 {{code language="lua"}}
788 @W_HDW10 = Asc("A") 'return the ASCII value of A to HDW10
789
790 @W_HDW11 = Asc("a")'return the ASCII value of a to HDW11
791
792 @W_HDW12 = Asc("Apple") 'return the first character A of string Apple to HDW12
793
794 @W_HDW13 = Asc("123") 'return the first character ASCII value 1 of string 123 to HDW13.
795 {{/code}}
796
797 **Result:**
798
799 * @W_HDW10 = 65
800 * @W_HDW11 = 97
801 * @W_HDW12 = 65
802 * @W_HDW13 = 49
803
804 == **AsFloating** ==
805
806 **Function**
807
808 val = AsFloating(A1)
809
810 **Description**
811
812 Convert parameter A1 to a float.
813
814 **Parameters**
815
816 * A1: integer variable.
817 * **val: **return float value, can be a variable or address.
818
819 **Example**
820
821 {{code language="lua"}}
822 Dim a as integer 'define a integer variable {a}.
823
824 a = @W_HDW10 'assign @W_HDW10 to a
825
826 b = AsFloating(a) 'convert integer a to float then assign to b.
827
828 b = b/1.2 'add as following sentence when need to view the return value:
829
830 Float 2D("@W_HDW11",b) 'float variable b written into HDW11.
831 {{/code}}
832
833 **Input: **@W_HDW10=24,
834
835 **Result: **@W_HDW11=20.00(set two decimals)
836
837 == **ASin** ==
838
839 **Function**
840
841 val = ASin(A1)
842
843 **Description**
844
845 Calculate the arcsine value of A1.
846
847 **Parameters**
848
849 * **A1: **Float can be an address or variable.
850 * **Val: **Return float value, can be an address or variable.
851
852 **Example**
853
854 {{code language="lua"}}
855 Dim a, b as floating'define two float variable a,b
856
857 a = 0.5'assign the designated value to a
858
859 b=ASin(a) 'calculate the arcsine value of a ,assign the radian to b.
860
861 'Add the following command if need to view the return value:
862
863 float2d ("@W_HDW200", b) 'float variable b written into HDW200
864 {{/code}}
865
866 **Result: **@W_HDW200=0.524
867
868 (% class="box infomessage" %)
869 (((
870 **✎Note:** Pleasecall **RadToDeg** function to convert radian into angle.
871 )))
872
873 == **AsInteger** ==
874
875 **Function**
876
877 val = AsInteger(A1)
878
879 **Description**
880
881 Convert parameter A1 to integer value.
882
883 **Parameters**
884
885 * **A1: **floating need to be a variable.
886 * **Val: **the value returned could can be a variable or address.
887
888 **Example**
889
890 {{code language="lua"}}
891 Dim a as floating 'define floating variable a
892
893 a = D2Float("@W_HDW0",a) 'use D2Float function to save the float date of HDW0 in a
894
895 b= AsInteger(a) 'convert the float a into integer, the return value assigned to b
896
897 @W_HDW10=b 'save b to HDW10
898 {{/code}}
899
900 **Input:** @W_HDW0=20.12,
901
902 **Result:** @W_HDW10=20
903
904 == **AsString** ==
905
906 **Function**
907
908 val = AsString(A1)
909
910 **Description**
911
912 Convert parameter A1 to a character string.
913
914 **Parameters**
915
916 * A1: not string parameter, it can be a variable.
917 * Val: return string value, variable or address.
918
919 **Example**
920
921 Script 1:
922
923 {{code}}
924 a=123 'assign a value to a
925
926 b=234 'assign a value to b
927
928 c=AsString(a)+AsString(b) 'convert a and b to string then add up the two strings ,assign the result to c.
929
930 @W_HDW0=c 'assign c to HDW0
931
932 d=a+b 'plus a with b
933
934 @W_HDW100=d 'assign d to (HDW100)
935 {{/code}}
936
937 **Result: **
938
939 * @W_HDW0=123234
940 * @W_HDW100=357
941
942 Script 2:
943
944 {{code language="lua"}}
945 W2S("@W_HDW200","@W_HDW300","02d")
946
947 W2S("@W_HDW210","@W_HDW400","02d")
948
949 W2S("@W_HDW220","@W_HDW500","02d")
950
951 @W_HDW0=AsString(@W_HDW300)+AsString(@W_HDW400)+AsString(@W_HDW500)
952 {{/code}}
953
954 **Input: **@W_HDW200=12,@W_HDW210=34,@W_HDW220=56
955
956 **Result :**@W_HDW300=12,@W_HDW400=34,@W_HDW500=56,@W_HDW0=123456
957
958 (% class="box infomessage" %)
959 (((
960 **✎Note:** Ensure the data always is two words; otherwise occur error. reference the other chapter of W2S function
961 )))
962
963 == **ATan** ==
964
965 **Function**
966
967 var = ATan(A1)
968
969 **Description**
970
971 Return an arctangent value,the radian ranges -pi/2 to pi/2.
972
973 **Parameters**
974
975 * **A1: **Can be float, address or variable.
976 * **Val: **radian of return value.
977
978 **Example**
979
980 {{code language="basic"}}
981 @W_HDW20= Atan(@W_HDW10)'save the arctangent value of (HDW10) to (HDW20)
982 {{/code}}
983
984 **Input: **@W_HDW10=1.000,@W_HDW20=0.785
985
986 (% class="box infomessage" %)
987 (((
988 **✎Note:** Please call RadToDeg function convert radian to angle.
989 )))
990
991 == **ATan2** ==
992
993 **Function**
994
995 val = ATan2(A1,A2)
996
997 **Description**
998
999 Return the arctangent value of A1/A2,radian range
1000
1001 **Parameters**
1002
1003 * **A1, A2:** Address or variable.
1004 * **Val: **returned value is a radian, range -pi to pi.
1005 * **Notice: **ATan2 use sign of two parameters to define the quadrant of return value.
1006
1007 **Example**
1008
1009 //{{code language="lua"}}@W_HDW20= ATan2 (@W_HDW10,@W_HDW12)'save the arctangent value of (HDW10/HDW12) to (HDW20).{{/code}}//
1010
1011 **Input:**@W_HDW10=1.0,@W_HDW12=1.0,
1012
1013 **Result: **@W_HDW20=0.785
1014
1015 (% class="box infomessage" %)
1016 (((
1017 **✎Note:** Please call **RadToDeg** function convert radian to angle.
1018 )))
1019
1020 == **B2W** ==
1021
1022 **Function**
1023
1024 B2W(A1, A2, length)
1025
1026 **Description**
1027
1028 Convert an array (begins with A2, unit: byte, to another array (begins with A1, unit: word).
1029
1030 **Parameters**
1031
1032 * **A1: **Saving address after converting
1033 * **A2: **Address of the value be converted 
1034 * **Length:** The length of conversion
1035
1036 **Return value: **None
1037
1038 **Example**
1039
1040 //{{code language="lua"}}B2W(@W_HDW100,@W_HDW10,2) 'convert (@W_HDW10) to the length of 2,save as the result that begins with @W_HDW100.{{/code}}//
1041
1042 **Input: **@W_HDW10=1A2B
1043
1044 **Result: **
1045
1046 * @W_HDW100=2B
1047 * @W_HDW101=1A
1048
1049 (% class="box infomessage" %)
1050 (((
1051 **✎Note:**
1052
1053 * A1 and A2 need to be address(e.g.: @W_HDW000002);
1054 * Length could be address or variable;
1055 * This is a subprogram; it has no returned value.
1056 )))
1057
1058 == **BCD** ==
1059
1060 **Function**
1061
1062 val = BCD(A1)
1063
1064 **Description**
1065
1066 Convert A1(binary) to BCD, save the result as return value.
1067
1068 **Parameters**
1069
1070 * **A1: **The binary be converted; it can be an address or variable.
1071 * **Val: **Return value, BCD code; it can be an address or variable.
1072
1073 **Example**
1074
1075 //{{code language="lua"}}@W_HDW20=BCD(@W_HDW10) 'convert HDW10 (binary) to BCD code, then save in (HDW20){{/code}}//
1076
1077 **Input:** @W_HDW10=11111111(binary)
1078
1079 **Result:** @W_HDW20=255
1080
1081 (% class="box infomessage" %)
1082 (((
1083 **✎Note:** Return value is a word; it hexadecimal corresponds to BCD code.
1084 )))
1085
1086 == **Beep** ==
1087
1088 **Function**
1089
1090 Beep()
1091
1092 **Description**
1093
1094 Enable buzzer
1095
1096 **Parameters**
1097
1098 None
1099
1100 **Example**
1101
1102 {{code language="lua"}}
1103 if @B_HDX100.0=1 then 'beep when the bit switch HDX100.0 set ON
1104
1105 beep()
1106
1107 endif
1108 {{/code}}
1109
1110 **Result: **HMI beep when bit switch HDX100.0 set ON.
1111
1112 == **BIN** ==
1113
1114 **Function**
1115
1116 Val = BIN(A1)
1117
1118 **Description**
1119
1120 Convert A1 (BCD) into binary, save the result in return value.
1121
1122 **Parameters**
1123
1124 * **A1:** The BCD code is converted; it can be address or variable.
1125 * **Val:** Return binary value,it can be address or variable.
1126
1127 **Example**
1128
1129 //{{code language="lua"}}@W_HDW20=BIN(@W_HDW10) 'convert HDW10(BCD) to binary, save the result in (HDW20){{/code}}//
1130
1131 **Input:** @W_HDW10=255
1132
1133 **Result:** @W_HDW20=11111111 (binary)
1134
1135 == **BMOV** ==
1136
1137 **Function**
1138
1139 BMOV(A1, A2,length)
1140
1141 **Description**
1142
1143 Copy data with a designated length from source address A2 to A1.
1144
1145 **Parameter**
1146
1147 * **A1:** saving address;
1148 * **A2:** source address;
1149
1150 **length:** operating length;
1151
1152 **Example**
1153
1154 {{code language="lua"}}
1155 @W_HDW20 = 20 'assign value to HDW20
1156
1157 @W_HDW21 = 21 'assign value to HDW21
1158
1159 @W_HDW22 = 22 'assign value to HDW22
1160
1161 BMOV(@W_HDW10,@W_HDW20,3) 'assign the word address of HDW20, HDW21, HDW22 to HDW10, HDW11, HDW12
1162 {{/code}}
1163
1164 **Result:**
1165
1166 * @W_HDW10 = 20
1167 * @W_HDW11 = 21
1168 * @W_HDW12 = 22
1169
1170 **✎Note:**
1171
1172 * A1 and A2 need to be address
1173 * Length can be an integer variable or an address. When destAddr and srcAddr are PLC (external device) addresses, the length range is 1-2048, and the 2049th address would not be operated when the range is exceeded.
1174 * When destAddr and srcAddr are HMI addresses, the length range is 1-4096, and This function is invalid when out of range.
1175
1176 == **Chr** ==
1177
1178 **Function**
1179
1180 val = Chr(A1, A2, ...)
1181
1182 **Description**
1183
1184 Convert integer parameter into correspond ASCII character, return the character string.
1185
1186 **Parameters**
1187
1188 * **A1, A2....:** converted integer; it can be an address or variable.
1189 * **Val: **returned value, can be an address or variable.
1190
1191 **Example**
1192
1193 {{code language="lua"}}
1194 @W_HDW100=Chr(@W_HDW20, @W_HDW21, @W_HDW22, @W_HDW23, @W_HDW24)
1195
1196 'convert the value of(HDW20, HDW21 ,HDW22, HDW23, HDW24) to ASCII character, assign the value to (HDW100)
1197 {{/code}}
1198
1199 **Input** 72,69,76,76,79 step by step according to HDW20, HDW21, HDW22, HDW23, HDW24,
1200
1201 **Result: **returns HELLO to (@W_HDW100).
1202
1203 == **Clrb** ==
1204
1205 **Function**
1206
1207 ClrB(A1)
1208
1209 **Description**
1210
1211 Set the bit of A1 as FALSE (0).
1212
1213 **Parameters**
1214
1215 **A1:** System address(bit)
1216
1217 **✎Note:** subprogram has no return value.
1218
1219 **Example**
1220
1221 //{{code language="lua"}}ClrB(@B_HDX100.0) 'assign 0 to (@B_HDX100.0){{/code}}//
1222
1223 == **Constant** ==
1224
1225 **Description**
1226
1227 Script supported constant, users can use on script:
1228
1229 pi = 3.14159265358979321
1230
1231 TRUE = 1
1232
1233 FALSE = 0
1234
1235 **Example**
1236
1237 {{code language="lua"}}
1238 Dim a as integer 'define integer a
1239
1240 a = RadToDeg(pi) 'convert radian pi to angle then assign to a,RadToDeg function is used to convert radian to angle.
1241
1242 @W_HDW11 = a 'assign a to (HDW11)
1243 {{/code}}
1244
1245 **Result: **@W_HDW11=180
1246
1247 == **CopyFile** ==
1248
1249 **Function**
1250
1251 A6=CopyFile(A1,A2,A3,A4,A5)
1252
1253 **Description**
1254
1255 Copy the A3 file from the A1 directory to the A2 directory according to the format of A4 and A5, and write returned value status to A6.
1256
1257 **Parameters**
1258
1259 * **A1: **the source path of the file to be copied.
1260 * **A2: **target path.
1261 * **A3:** the name of the file to be copied.
1262 * **A4: **copy type (0: copy file, 1: copy directory).
1263 * **A5: **Whether to overwrite the file with the same name when copying (0: Yes, 1: No).
1264 * **A6: **returned value.
1265 ** 0: copy failed
1266 ** 1: copy succeeded
1267 ** 2: Parameter error
1268 ** 3: U disk does not exist
1269 ** 4: SD card does not exist
1270 ** 5: Path error
1271
1272 **Example**
1273
1274 Copy a single file:
1275
1276 {{code language="lua"}}
1277 @W_HDW100 = " test.csv"
1278
1279 CopyFile("UDisk/Test","Flash/Test","test.csv",0,0) 'Copy the Test.csv file in the UDisk/Test directory to the Flash/Test directory.
1280
1281 Can also be written as CopyFile("UDisk/Test","Flash/Test",@W_HDW100,0,0)
1282
1283 (2) Copy the entire directory file:
1284
1285 CopyFile("UDisk/Test","Flash/Test","",1,0) ' Copy the files in the UDisk/Test
1286
1287 directory to the Flash/Test directory.
1288 {{/code}}
1289
1290 (% class="box infomessage" %)
1291 (((
1292 **✎Note:**
1293
1294 * Both source and destination paths need to begin with UDisk or Flash or SDCard;
1295 * A1 and A2 could be string (requires double quotes) or variable, maximum character length 127 allowed in path;
1296 * A3 could be a string, such as: [FileName] (requires double quotes); or address, such as: @W_HDW100 (no need to add double quotes);
1297 * A4 and A5 could be values, addressesor variable;
1298 * A6 could be address or variable.
1299 )))
1300
1301 == **Cos** ==
1302
1303 **Function**
1304
1305 Val = Cos(A1)
1306
1307 **Description**
1308
1309 Return a cosine value of an angle.
1310
1311 **Parameters**
1312
1313 * **A1: **a float radian of angle, it can be an address or variable.
1314 * **Val: **return float value, it can be an address or variable.
1315
1316 **Example**
1317
1318 {{code language="lua"}}
1319 Dim a, b as floating 'define float a, b
1320
1321 b = pi/3 'convert the value of HDW11 to float and assign to 'b'.
1322
1323 a=Cos(b) 'return the cosine value of'b' and assign the result to 'a'.
1324
1325 'to add the following sentence if need to view the return value:
1326
1327 Float2D("@W_HDW20",a) 'the float value of a written into HDW13.
1328 {{/code}}
1329
1330 **Result: **@W_HDW20=0.5
1331
1332 (% class="box infomessage" %)
1333 (((
1334 **✎Note:** Please call **RadToDeg** function convert radian to angle.
1335 )))
1336
1337 == **D2F** ==
1338
1339 **Function**
1340
1341 D2F (A1, A2) or A1= D2F (A1, A2)
1342
1343 **Description**
1344
1345 Convert the 32-bit integer format data to float then output the result.
1346
1347 **Parameters**
1348
1349 * **A1: **required data, begin with"@";
1350 * **A2: **source data, begin with"@";
1351
1352 **Example**
1353
1354 {{code language="lua"}}
1355 D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).
1356
1357 @W_HDW2=D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).
1358 {{/code}}
1359
1360 **Result: **HDW0=100, HDW2=100
1361
1362 == **D2Float** ==
1363
1364 **Function**
1365
1366 F= D2Float("A1",F)
1367
1368 **Description**
1369
1370 Convert the designated value to floating then assign to variable.
1371
1372 **Parameters**
1373
1374 * **A1:** Source data;
1375 * **F:** User-defined floating variable
1376
1377 **Example**
1378
1379 {{code language="lua"}}
1380 dim F as floating 'define F as floating
1381
1382 F=D2Float("@W_HDW10",F) 'assign the value of (HDW10) to F in floating
1383
1384 Float2D("@W_HDW12",F) 'copy the floating value of F to HDW12 register,use to display result.
1385 {{/code}}
1386
1387 **Result: **
1388
1389 * HDW10=200,
1390 * HDW12=200.
1391
1392 (% class="box infomessage" %)
1393 (((
1394 **✎Note:** A1 needs to be address;
1395 )))
1396
1397 == **D2Int** ==
1398
1399 **Function**
1400
1401 A2= D2Float("A1",A2)
1402
1403 **Description**
1404
1405 Output the 32-bit integer in the form of integer.
1406
1407 **Parameters**
1408
1409 * **A1:** Source data can only be the HMI internal or external register starting with "@".
1410 * **A2: **Target data can only use theinteger variable defined by script.
1411
1412 **Example**
1413
1414 {{code language="basic"}}
1415 dim var1 as integer 'define var1 as integer
1416
1417 var1=D2Int("@W_HDW0",var1) 'Read out the 32-bit integer in HDW0 and save the result in var1.
1418
1419 HDW0=9999999
1420 {{/code}}
1421
1422 **Result:** Var1=9999999
1423
1424 == **DataLogToUorSD** ==
1425
1426 **Function**
1427
1428 DataLogToUorSD (A1, A2, A3, A4, A5, A6, A7, A8)
1429
1430 **Description**
1431
1432 The data record (database file) is exported to db or csv format file, and register HSW1853 can be used to control the exported file type．
1433
1434 (HSW1853 = 0: when db format is exported, filename format: Start time-end time-group name.db)
1435
1436 (HSW1853 = 1: when csv format is exported, filename format: Start time-end time-group name.csv)
1437
1438 **Parameters**
1439
1440 * A1: Data record group name address (string, address is required)
1441
1442 Such as: " @ W_HDW30 "
1443
1444 * A2: Start time address (string, address is required)
1445
1446 Such as: " @ W_HDW40 "
1447
1448 * A3: End time address (string, address is required)
1449
1450 Such as: " @ W_HDW50 "
1451
1452 * A4: db file save location (value is an integer)
1453
1454 ~= 1: Saved on SD card
1455
1456 ~= 2: Save in USB flash drive
1457
1458 * A5: Return value address (string, address is required)
1459
1460 Such as: " @ W_HDW60 "
1461
1462 The return result of the script will be written to this address;
1463
1464 Meaning of value in address:
1465
1466 ~= 1: Script executed successfully
1467
1468 ~= 100: U disk or SD card unplugged
1469
1470 ~= 101: U disk or SD card does not exist
1471
1472 ~= 102: Script executed unsuccessfully
1473
1474 ~= 201: db export failed
1475
1476 ~= 203: Script is being executed (previous executed script doesn’t exit)
1477
1478 * A6: Script running mode (value is an integer)
1479
1480 ~= 1: Wait for script execution before exiting
1481
1482 ~= Others: Exit without waiting for the result of script execution (when the data record volume is large, it takes some time to execute the script, and when you wait for the result of script execution, it may affect the execution of other scripts)
1483
1484 * A7: Directory name address (string, address is required)
1485
1486 Such as: " @ W_HDW70 "
1487
1488 The script will automatically prefix the directory name HMI_, for example:
1489
1490 @ W_HDW70 = "Log", the db file will be saved under the directory of HMI_Log in U disk or SD.
1491
1492 * A8: Reserved address (string, address is required)
1493
1494 Such as:" @ W_HDW80 "
1495
1496 This address is temporarily useless but needs to be set.
1497
1498 **Example**
1499
1500 {{code language="basic"}}
1501 @W_HDW30 = "Record test" 'Data record group name
1502 @W_HDW40 = 2021
1503 @W_HDW41 = 04
1504 @W_HDW42 = 30
1505 @W_HDW43 = 09
1506 @W_HDW44 = 0
1507 @W_HDW45 = 0
1508 'Start time 2021-04-30 09:00:00
1509 @W_HDW50 = 2021
1510 @W_HDW51 = 04
1511 @W_HDW52 = 30
1512 @W_HDW53 = 20
1513 @W_HDW54 = 0
1514 @W_HDW55 = 0
1515 'End time 2021-04-30 20:00:00
1516 @W_HDW70 = "Log" 'Directory name
1517
1518 DataLogToUorSD ("@ W_HDW30", "@ W_HDW40", "@ W_HDW50", 2, "@ W_HDW60", 1, "@ W_HDW70", "@ W_HDW80")
1519
1520 'Export the data records collected from 2021-04-30 09:00:00 to 2021-04-30 20:00:00 under the group name of the record test to the HMI_Log directory of the U disk with the file name being 20210430090000-20210430200000-record tests. db. (HSW1853 is 0).
1521 {{/code}}
1522
1523 == **DbToCSVFile** ==
1524
1525 **Function**
1526
1527 A8=DbToCSVFile(A1,A2,A3,A4,A5,A6,A7)
1528
1529 **Description**
1530
1531 Convert db (database file) file to csv format and export it.
1532
1533 **Parameters**
1534
1535 * **A1: **db file save path (value is integer);
1536 ** =0: Alarm record file in HMI flash;
1537 ** =1: Alarm record file in UDisk (USB flash disk);
1538 ** =2: Alarm record file in SD card;
1539 ** =3: Data record file in HMI flash;
1540 ** =4: Data record file in UDisk (USB flash disk);
1541 ** =5: Data record file in SD card;
1542 * **A2: **group numer of db file (value is integer);
1543 ** Used during exporting data record file, the group number could be seen in the data record setting interface;
1544 * **A3:** csv file save path (value is integer);
1545 ** =0: Save in UDisk (USB flash disk);
1546 ** =1: Save in SD card;
1547 * **A4: **csv name;
1548 * **A5: **start time of data recordin db file(string), consecutive 6 word addresses (the values in the address are year, month, day, hour, minute, second);
1549 * **A6:** end time of data recordin db file(string), consecutive 6 word addresses (the values in the address are year, month, day, hour, minute, second);
1550 * **A7:** csv encoding format;
1551 ** =0 UTF8 format;
1552 ** =1 GBK format;
1553 * **A8:** returned value;
1554 ** =0: Failed to export;
1555 ** =1: Exported;
1556 ** =2: db file path error;
1557 ** =3: U disk or SD card does not exist;
1558 ** =4: csv name error;
1559 ** =5: db file does not exist;
1560 ** =6: csv file already exists;
1561
1562 **Example**
1563
1564 * @W_HDW100 = 2018
1565 * @W_HDW101 = 12
1566 * @W_HDW102 = 25
1567 * @W_HDW103 = 19
1568 * @W_HDW104 = 10
1569 * @W_HDW105 = 30
1570 * @W_HDW200 = 2018
1571 * @W_HDW201 = 12
1572 * @W_HDW202 = 25
1573 * @W_HDW203 = 20
1574 * @W_HDW204 = 10
1575 * @W_HDW205 = 30
1576
1577 **Export data record file**
1578
1579 {{code language="basic"}}
1580 DbToCsvFile(3,2,0,"123.csv","@W_HDW100","@W_HDW200",0)
1581 'In the HMI flash, the group number is 2, and the data records collected in the time of 2010.12.25 19:10:30-2018.12.25 20:10:30
1582 'are exported to the 123.csv file in the Udisk in UTF8 format.
1583 {{/code}}
1584
1585 **Export alarm record file**
1586
1587 {{code language="basic"}}
1588 DbToCsvFile(0,0,0,"456.csv","@W_HDW100","@W_HDW200",1)
1589 'The alarm records generated in HMI Flash at 2018.12.25 19:10:30-2018.12.25 20:10:30
1590 'are exported to the 456.csv file in the Udisk in GBK format
1591 {{/code}}
1592
1593 (% class="box infomessage" %)
1594 (((
1595 **✎Note:**
1596
1597 * A1 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;
1598 * A2 can be an address or a variable or a value;
1599 * A3 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;
1600 * A4 can be an address or variables or string, and the length of the file name (sum of values, English, Chinese) could not exceed 127;
1601 * A5 need to be an address;
1602 * A6 need to be an address;
1603 * A7 can be an address or a variable or a value;
1604 )))
1605
1606 == **DegToRad** ==
1607
1608 **Function**
1609
1610 A2 = DegToRad(A1)
1611
1612 **Description**
1613
1614 Convert the angle into correspond radian, and display.
1615
1616 **Parameters**
1617
1618 * **A1:** inputting angle supports address, other variable or floating.
1619 * **A2: **outputting radian supports address, other variable or floating.
1620
1621 **Example**
1622
1623 Script 1
1624
1625 //{{code language="lua"}}@W_HDW12=DegToRad(@W_HDW10) 'input angle on (HDW10),convert to correspond redian and copy to (HDW12){{/code}}//
1626
1627 **Result: **HDW10=180; HDW12=3.14159
1628
1629 Script 2
1630
1631 {{code language="lua"}}
1632 dim a as floating 'set variable
1633
1634 dim b as floating 'set variable
1635
1636 b=30 'input angle
1637
1638 a=DegToRad(b) 'convert the length of radian and copy to variable {a}
1639
1640 float2d("@W_HDW0", a) 'display the value of floating on(HDW0)
1641 {{/code}}
1642
1643 **Result:** HDW0=0.52360
1644
1645 == **DIM ... AS ...** ==
1646
1647 **Function**
1648
1649 Dim "variable" as "date type"
1650
1651 **Description**
1652
1653 Declare a variable, stable the type of data.
1654
1655 **Parameters**
1656
1657 * **Variable: **begin with letter, other character can be letter, numbers, underscores ('_'), need to begin with '@' if it is address;
1658 * **Data type: **string,floating,integer;
1659
1660 **Example**
1661
1662 {{code language="lua"}}
1663 dim a as integer 'define a as integer
1664
1665 dim @W_HDW0 as floating 'define @W_HDW0 as floating
1666
1667 dim hi as string 'define "hi" as string
1668 {{/code}}
1669
1670 **Result:**
1671
1672 a is integer
1673
1674 @W_HDW0 is floating
1675
1676 hi is string
1677
1678 (% class="box infomessage" %)
1679 (((
1680 **✎Note:** Use the variable of Dim during running, could not change the type, Dim will be missed if the type of variable is no difined. Variable could be declared in once.
1681 )))
1682
1683 == **DO ... LOOP** ==
1684
1685 **Function**
1686
1687 Do [While | Until condition]
1688
1689 [statements]
1690
1691 Loop
1692
1693 or
1694
1695 Do
1696
1697 [statements]
1698
1699 Loop [While | Until condition]
1700
1701 **Description**
1702
1703 Condition determent instruction.
1704
1705 * Do while.loop executes an instruction of block repeatedly when condition is true.
1706 * Do until.loop executes an instruction of block repeatedly until condition is false.
1707
1708 **Parameters**
1709
1710 **Condition: **determine condition; obtain the expression of True or False.
1711
1712 **Statements: **execute one or more instructions repeatedly when condition is True or until condition is True.
1713
1714 If condition is true, all statements are executed until the Wend statement is encountered. Control then returns to the While statement and condition is again checked. If condition is still True, the process is repeated. If it is not true, execution resumes with the statement following the Wend statement.
1715
1716 **Example**
1717
1718 {{code language="lua"}}
1719 dim i as integer 'end DO loop when i=100
1720
1721 do while i<100
1722
1723 i=i+1
1724
1725 @W_HDW0=i
1726
1727 loop
1728 {{/code}}
1729
1730 **Result: **HDW0=100
1731
1732 == **End** ==
1733
1734 **Function**
1735
1736 Terminates the script immediately.
1737
1738 **Description**
1739
1740 End the execution of script.
1741
1742 **Parameters**
1743
1744 **Statement:** Judging condition, use with IF together. end script when meet condition.
1745
1746 **Example**
1747
1748 //{{code language="lua"}}If a = 10 Then End 'end script when a=10.{{/code}}//
1749
1750 **Result:** End the script program.
1751
1752 == **Exp** ==
1753
1754 **Function**
1755
1756 A1=Exp(A2)
1757
1758 **Description**
1759
1760 Returns the power value of e (natural logarithm), save the outputting result to A1, e=2.71828182846.
1761
1762 **Parameters**
1763
1764 * **A1: **the goal date: the power floating value of returning, need to begin with '@'([[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__e.g.@W_HDW10__>>path:mailto:'@'(e.g.@W_HDW10]](%%));
1765 * **A2: **Source data, natural exponential function, need to be integer or variable. Could not not begin with the address of "@"(e.g.@W_HDW10)
1766
1767 **Example**
1768
1769 {{code language="lua"}}
1770 dim a as integer'define a as integer
1771
1772 a = @W_HDW2 ' assign the value of (HDW2) to variable a
1773
1774 @W_HDW0= Exp(a)'exponential is the value of (HDW2),save result to(HDW0)
1775 {{/code}}
1776
1777 **Result:**
1778
1779 * HDW2=2,
1780 * HDW0=7.38905600
1781
1782 == **F2D** ==
1783
1784 **Function**
1785
1786 F2D (A1, A2)
1787
1788 **Description**
1789
1790 Convert a 32 bit floating to integer format, then output the result.
1791
1792 **Parameters**
1793
1794 * **A1: **Destination, the value can be an address(e.g.@W_HDW12).
1795 * **A2: **source date, it can be an address or other variable.
1796
1797 **Example**
1798
1799 //{{code language="lua"}}F2D(@W_HDW12,@W_HDW10) 'convert the floating of (HDW10) to integer, save in (HDW12).{{/code}}//
1800
1801 **Result:**
1802
1803 * HDW10=200,
1804 * HDW12=200
1805
1806 == **F2S** ==
1807
1808 **Function**
1809
1810 F2S (A1,A2,s1)
1811
1812 **Description**
1813
1814 Output a format of floating that in the type of string.
1815
1816 **Parameters**
1817
1818 * **A1:** Source address, used to store floating, the value is an address(e.g.@W_HDW200);
1819 * **A2:** Destination address, used to store string after converted, value is an address(e.g.@W_HDW100).
1820 * **S1:** the format of displaying goal data. such as the format of 03.03f,f, used for outputting a single-precision in the form of decimal.m.nf:means m column and n decimals when outputting.
1821
1822 **Example**
1823
1824 //{{code language="lua"}}F2S("@W_HDW200", "@W_HDW100", "03.03f") '(HDW200) is floating input,(HDW100) is text output;{{/code}}//
1825
1826 **Result: **
1827
1828 * HDW200=1.22365,
1829 * HDW100=1.224
1830
1831 == **FileCmpDir** ==
1832
1833 **Function**
1834
1835 FileCmpDir(A1, A2, A3, A4, A5, A6, A7, A8, A9)
1836
1837 **Description**
1838
1839 The filename input and the filename in the folder whether is duplicate or not.
1840
1841 **Parameters**
1842
1843 A1: file path (value is integer);
1844
1845 In HMI:
1846
1847 * =0: Recipe folder in HMI flash;
1848 * =1: Custom folder in UDisk (USB flash disk);
1849 * =2: Custom folder in SD card.
1850 * =3: Custom folder in HMI flash;
1851
1852 In simulator:
1853
1854 * = 0: D:/Recipe/
1855 * = 1: C:/WECON/CustomFileDir/
1856 * = 2: C:/WECON/CustomFileDir/
1857 * = 3: C:/WECON/CustomFileDir/
1858
1859 **✎Note:**
1860
1861 A1 can be an address,variable or fixed value.
1862
1863 A2: file name (value is string);
1864
1865 The file name would be compared;
1866
1867 **✎Note: **
1868
1869 A2 can be an address, variable or string. The length of file name cannot exceed 32 characters.
1870
1871 A3: folder name (value is integer);
1872
1873 The folder name would be compared;
1874
1875 **✎Note: **
1876
1877 A3 can be an address, variable or string. The length of file name cannot exceed 32 characters.
1878
1879 A4:file name display address (value is a string);
1880
1881 Display the specified number of file names in the specified folder.
1882
1883 **✎Note:**
1884
1885 A4 Can only use address here. And the length of the file name cannot exceed 32 characters.
1886
1887 A5: Function type (value is an integer)
1888
1889 ~= 0: compare whether the file name in the folder and the file name input are duplicated or not.
1890
1891 ~= 1: return list of file names.
1892
1893 ~= 100: compare file names, without input suffix .csv
1894
1895 **✎Note: **
1896
1897 A5 can be an address, variable or value.
1898
1899 A6: Return value (value is an integer)
1900
1901 ~= 1: Successfully opened the folder.
1902
1903 ~= 2: Failed to open the folder.
1904
1905 ~= 3: The file has duplicate names
1906
1907 **✎Note:**
1908
1909 A6 must be an address.
1910
1911 A7: File number (value is an integer)
1912
1913 Display the number of files in the folder (up to 100)
1914
1915 **✎Note: **
1916
1917 A7 must be an address.
1918
1919 A8: File creation time (value is a string);
1920
1921 Display the time of file creation, time occupies 32 characters
1922
1923 A9: The maximum number of files to read (value is an integer)
1924
1925 Set the maximum number of files to read (up to 100 files)
1926
1927 **✎Note:** A9 can be an address, variable or value.
1928
1929 **Example**
1930
1931 Read the specified number of files in the folder.
1932
1933 (% class="box" %)
1934 (((
1935 FileCmpDir(@W_HDW1254, @W_HDW50, "File", "", 0, "@W_HDW0", "", "", 10)'Determine whether there is a file with the same name as @W_HDW50 in the file directory of HDW1254.@W_HDW0=3 is Yes.@W_HDW0 = 1 is No.@W_HDW0=2 is comparison failed.
1936 )))
1937
1938 Compare filename input and the filename in the folder whether is duplicate or not.
1939
1940 (% class="box" %)
1941 (((
1942 FileCmpDir(@W_HDW1254, "", "File", "@W_HDW200", 1, "@W_HDW0", "@W_HDW300", "@W_HDW400", 10)’The file name under the directory File in the flash is written to the continuous address begin from @W_HDW200, the file creation time is written to the continuous address begin from @W_HDW400, the number of files is written to the address @W_HDW300, the maximum number of files is 10
1943 )))
1944
1945 Compare the csv file name in the folder and the csv file name input whether is duplicated or not.
1946
1947 (% class="box" %)
1948 (((
1949 FileCmpDir(@W_HDW1254, @W_HDW50, "File", "", 100, "@W_HDW0", "", "", 10)' Judge whether there is a file in the directory File in the flash is same with following: @W_HDW50, @W_HDW50.csv, @ W_HDW50.CSV , @W_HDW0=3 is Yes, @W_HDW0 = 1 is No ,@W_HDW0=2 is comparison failed
1950 )))
1951
1952 == **FILL** ==
1953
1954 **Function**
1955
1956 FILL (A1, A2, A3)
1957
1958 **Description**
1959
1960 Write the same value to designated address constantly.
1961
1962 **Parameters**
1963
1964 **A1:** The beginning address, it can be an address (e.g.@ W_ HDW25);
1965
1966 **A2:** Source data, it needs to be written in continuous value, the value can be an address, variable or constant;
1967
1968 **A3:** The number of operation, writing address number, it can be an address, variable or constant;
1969
1970 When the PLC (external device) address is used in this function, the length range is 1-2048, and only the 2048th address can be operated when the range is exceeded.
1971
1972 When the HMI internal address is used in this function, the length range is 1-4096. If the function is out of range, then the function is invalid.
1973
1974 **Example**
1975
1976 //FILL (@W_HDW25, 10, 3) 'At the beginning three address of @W_ HDW25 is 10.//
1977
1978 **Result: **At the beginning three address of @W_ HDW25 is 10, @W_ HDW25=10, @W_ HDW26=10, @W_ HDW27=10.
1979
1980 == **Float2D** ==
1981
1982 **Function**
1983
1984 Float2D (A1,A2);
1985
1986 **Description**
1987
1988 Copy floating value to the address.
1989
1990 **Parameters**
1991
1992 * **A1: **Goal address, the value need to be address (e.g.@W_HDW102);
1993 * **A2:** Source data, it can be floating;
1994
1995 **Example**
1996
1997 {{code language="lua"}}
1998 dim f as floating 'define f as floating
1999
2000 f=1.1 'assign a designated value to f
2001
2002 Float2D ("@W_HDW102",f) 'assign the value f to HDW102
2003 {{/code}}
2004
2005 **Result:** HDW102=1.1
2006
2007 == **For. to. step. next** ==
2008
2009 **Function**
2010
2011 For counter = start to end Step
2012
2013 [Statements]
2014
2015 Next
2016
2017 **Description**
2018
2019 Execute a command repeatedly for designated times.
2020
2021 **Parameters**
2022
2023 * **counter: **Work as a variable for loop counter;
2024 * **start: **The start value of counter, it could be any variable type or expression;
2025 * **end: **The end value of counter, it could be any variable type or expression;
2026 * **step: **Every loop, the changed value of counter is step value, step default if it is not designation. Step default as below:
2027 ** if start>end, step default is 1;
2028 ** if start< end. It could be any variable type or expression;
2029 * **statements: **Between For with Next, execute instruction set of designated times;
2030 ** Set a loop of for...Next in another loop, it can nest call the loop of for...Next. Different from a while, for only search once value from end. Empty for loop will be ignored, and could not delay time.
2031
2032 **Example**
2033
2034 {{code language="lua"}}
2035 'Use HDX2.0 to trigger the loop
2036
2037 for i=100 to 0 step -5 ' set the start is 100,end is 0,subtract 5 every time, execute 20 times totally.
2038
2039 @W_HDW100=@W_HDW100+1 ' execute (HDW100+1) 21 times totally, the final result is 21.
2040
2041 Next
2042
2043 @B_HDX2.0=0
2044 {{/code}}
2045
2046 **Result: **HDW100=21
2047
2048 == **Function** ==
2049
2050 **Function**
2051
2052 * Function name (arglist)
2053 * statements
2054 * name = expression
2055 * statements
2056 * End Function
2057
2058 **Description**
2059
2060 Unlike internal function, it needs to declare the name, parameter, code of the function.
2061
2062 **Parameters**
2063
2064 * **Name: **function name.
2065 * **arglist: **stands for the variable list of parameter, this parameter will be entered during calling function. use comma to separate.
2066 * **statements: **a set of code in running function body.
2067
2068 **Notice: **it could not define a function program at any other program body. Write name first and then follow with parameter list, when calling function. Declare function need to before be calling. in the internal function body, it could be assigned to a function name from returned value at any place. Return value is 0 if not assign function name. Functions can recursive, but it may lead to stack overflow.
2069
2070 **Example**
2071
2072 {{code language="lua"}}
2073 Function sincos (angle as floating)
2074
2075 sincos = sin(angle) + cos(angle)
2076
2077 End Function<
2078
2079 ........
2080
2081 @W_0002 = sincos(pi/2)
2082
2083 ........
2084 {{/code}}
2085
2086 == **GetServerDelayInfo** ==
2087
2088 **Function**
2089
2090 A3=GetSerVerDelayInfo(A1,A2)
2091
2092 **Description**
2093
2094 Convert string A1 to hexadecimal number.
2095
2096 **Parameters**
2097
2098 **A1:** The starting address, save the delay data of each server (10 consecutive addresses, the last 7 addresses are reserved), when the server testing fails, the value in the corresponding address is -1. The unit is ms (signed decimal number).
2099
2100 (% class="table-bordered" %)
2101 |=**Address**|=**Description**
2102 |A1|Delay data of the server configured in [Project Settings]
2103 |A1+1|Delay data of Server 1
2104 |A1+2|Delay data of Server 2
2105
2106 **A2: **Server test result address
2107
2108 (% class="table-bordered" %)
2109 |=(% style="width: 239px;" %)**Address**|=(% style="width: 1250px;" %)**Description**
2110 |(% style="width:239px" %)0 bit|(% style="width:1250px" %)Set ON, Server configured in [Project Settings] fails
2111 |(% style="width:239px" %)1^^st^^bit|(% style="width:1250px" %)Set ON, Server 1 fails
2112 |(% style="width:239px" %)2^^nd^^bit|(% style="width:1250px" %)Set ON, Server 2 fails
2113 |(% style="width:239px" %)3^^rd^^~~ 10^^th^^bits|(% style="width:1250px" %)Reserved
2114 |(% style="width:239px" %)11^^th^^bit|(% style="width:1250px" %)Set ON, network error, network port interface failure
2115
2116 **A3:**Returns the preferred server number or network status (automatically selects the server with the best connection network status).
2117
2118 * =0: Server configured in [Project Settings];
2119 * =1: Server 1;
2120 * =2: Server 2;
2121 * =3~~10: Reserved;
2122 * =100: Try again later (two test intervals need to wait 30 seconds);
2123 * =101: Failed to test Server;
2124
2125 **Example**
2126
2127 //{{code language="lua"}}@W_HDW200 = GetServerDelayInfo("@W_HDW100", "@W_HDW50"){{/code}}//
2128
2129 Result:
2130
2131 * HDW100: Delay data of the server configured in [Project Settings]
2132 * HDW101: Delay data of Server 1
2133 * HDW102: Delay data of Server 2
2134 * HDX50.0=1:Server configured in [Project Settings] fails
2135 * HDX50.1=1: Server 1 fails
2136 * HDX50.2=1:Server 2 fails;
2137 * HDX50.11= 1: network error, network port interface failure;
2138
2139 When the server signal is stable, the optimal server is automatically connected according to the network status @W_HDW200. When the server connection is abnormal, @W_HDW200=101, the server test fails or the test is abnormal.
2140
2141 (% class="box infomessage" %)
2142 (((
2143 **✎Note:** The time interval between executions of this function could not be less than 30 seconds, otherwise an error will occur.
2144 )))
2145
2146 == **Goto** ==
2147
2148 **Function**
2149
2150 Goto label
2151
2152 **Description**
2153
2154 Go to the designated row without any condition in a function body.
2155
2156 **Parameters**
2157
2158 * **Label:** target character, start with letter in row label, end with(:)of any string.row label has no sensitive to the format of letter.
2159
2160 **Example**
2161
2162 //Goto sd 'go to the row which start with "sd";//
2163
2164 **Result:** Go to sd row.
2165
2166 (% class="box infomessage" %)
2167 (((
2168 **✎Note:** Goto only can jump into the internal function that visible row.
2169 )))
2170
2171 == **H2A** ==
2172
2173 **Function**
2174
2175 A1 = H2A (A2)
2176
2177 **Description**
2178
2179 Convert a binary (16-bit) to hexadecimals (4-bit) of ASCII.
2180
2181 **Parameters**
2182
2183 * **A1: **Returned value, string, it could be an address or variable.
2184 * **A2: **Binary is needed to be converted, the value could be a address or variable.
2185
2186 **Example**
2187
2188 //{{code language="lua"}}@W_HDW100= H2A (@W_HDW0) ' convert the binary of (HDW0) to character and save in (HDW100).{{/code}}//
2189
2190 **Result:**
2191
2192 * HDW0=200,
2193 * HDW=100
2194
2195 == **HmiRegoperator** ==
2196
2197 **Function**
2198
2199 HmiRegoperator (A1,A2,A3,A4,A5,A6)
2200
2201 **Description**
2202
2203 Data of Upload/ Download address
2204
2205 **Parameters**
2206
2207 * **A1: **The start address of target
2208 * **A2: **Length, address length, unit: word, range: 1~~1000
2209 * **A3: s**torage
2210 ** A3=0, select USB flash disk as storage, and save files in Root directory;
2211 ** A3=1, select SD card as storage, and save files in Root directory;
2212 * **A4: **File name address, itneed to be address such as"@ W_HDW2"
2213 * **A5**: Upload / download data
2214 ** A5=0, save the data in the specified address as a file and store the file in the root directory;
2215 ** A5=1, Read data from file and it woule be written into specified address;
2216 * **A6:** State display, it needs to be address, such as "@ W_HDW2";
2217 ** A6=1, Normal
2218 ** A6=2, USB flash disk/ SD card does not exist
2219 ** A6=3, File doesn’t exist;
2220 ** A6=4, File name error;
2221 ** A6=5, Check error
2222 ** A6=6, Abnormal communication;
2223 ** A6=7, HUW register is not allowed;
2224 ** A6=8, Address length range error (address length range: 1-1000);
2225
2226 **Example**
2227
2228 Script 1
2229
2230 (% class="box" %)
2231 (((
2232 //HmiRegoperator("@W_HDW0",10,0,"@W_HDW2000",0,"@W_HDW3000")’The data in HDW0-HDW10 is saved as a file, the file name is set by HDW2000 and stored in a USB flash disk.//
2233 )))
2234
2235 Script 2
2236
2237 (% class="box" %)
2238 (((
2239 //HmiRegoperator("@W_HDW0",10,1,"@W_HDW2000",1,"@W_HDW3000")//
2240
2241 //Read the values from files which stored in the SD card (files named by the HDW2000), and write these values to the HDW0-HDW10.//
2242 )))
2243
2244 **✎Note:**
2245
2246 * The length of the file name is less than 32 characters, and the file name consists of numbers and letters (the file name does not meet this standard; WECON does not guarantee the accuracy of the data).
2247 * The interval of download function operation should be 5s or more.
2248 * A1 need to be address such as “@W_HDW2”.
2249 * Please use “Character Input/Display” object for it, and the file name consists of numbers and letters, could not be punctuated characters, maximum character length 32 allowed.
2250
2251 == **Hypot** ==
2252
2253 **Function**
2254
2255 Var = Hypot (expr1, expr2)
2256
2257 **Description**
2258
2259 Calculate the value of the hypotenuse of a right triangle.
2260
2261 **Parameters**
2262
2263 * **expr1, expr2: **Source data, the two sides of right triangle. it need to be address;
2264 * **Var:** Destination data,it need to be address;
2265
2266 **Example**
2267
2268 (% class="box" %)
2269 (((
2270 //@W_HDW200=Hypot (@W_HDW105,@W_HDW108) ' input the value of right-angle side at (HDW105) and (HDW108),and assign the result of the hypotenuse to (HDW200).//
2271 )))
2272
2273 **Result: **
2274
2275 * HDW105=3,
2276 * HDW108=4,
2277 * HDW200=5
2278
2279 (% class="box infomessage" %)
2280 (((
2281 **✎Note:** hypot function could support integer and floating when the format of source data and target data are the same.
2282 )))
2283
2284 == **IF ... THEN ... ELSE ... END IF** ==
2285
2286 **Function**
2287
2288 If condition Then
2289
2290 Statements
2291
2292 [Else
2293
2294 else statements]
2295
2296 End If
2297
2298 **Description**
2299
2300 Conditional judgments instruction. When the [Condition] defined by [IF] is TURN, the operation following [THEN] is performed. When [Condition] is FALSE, the operation after [ELSE] is executed.
2301
2302 **Parameters**
2303
2304 * **condition: **any expression, the value could be true or false.
2305 * **statement: **execute the instruction block when condition is true.
2306 * **else statement: **execute the instruction block when condition is false.
2307
2308 **Example**
2309
2310 {{code language="lua"}}
2311 if @W_HDW105=200 then ' judging condition: whether the value of (HDW105) is 200
2312
2313 @W_HDW108=1 'the value of (HDW108) is 1 if fulfil condition
2314
2315 else
2316
2317 @W_HDW200=1 ' the value of (HDW200) is 1 if not fulfil condition.
2318
2319 Endif
2320 {{/code}}
2321
2322 **Result:**
2323
2324 * HDW105=199;
2325 * HDW108=0;
2326 * HDW200=1
2327
2328 == **InStr** ==
2329
2330 **Function**
2331
2332 var = InStr ("str1", "str2")
2333
2334 **Description**
2335
2336 Returned the position of str1 in str2(start with 0), set -1 if no result.
2337
2338 **Parameters**
2339
2340 * **str1:** source string, it could only be string, not address;
2341 * **str2:** target string, it could only be string, not address;
2342 * **var:** Returned value, the format of data needs to be string;
2343
2344 **Example**
2345
2346 {{code language="lua"}}
2347 dim a as floating
2348
2349 a = InStr ("Hello", "o") ' calculate the position of"o"in"hello".
2350
2351 float2d ("@W_HDW0",a) ' Returned value is 4.(start with 0)
2352 {{/code}}
2353
2354 **Result:** HDW0=4
2355
2356 == **Int2D** ==
2357
2358 **Function**
2359
2360 Int2D("A1",A2)
2361
2362 **Description**
2363
2364 Write the 32-bit integer into the target address
2365
2366 **Parameters**
2367
2368 * **A1: **Source data could only be the HMI internal or external register starting with "@".
2369 * **A2:** Target data could only use the integer variable defined by script.
2370
2371 **Example**
2372
2373 {{code language="lua"}}
2374 dim var1 as integer 'define var1 as integer
2375
2376 Int2D("@W_HDW0", var1)    'Read out the 32-bit integer in var1 and save the result in HDW0 .
2377
2378  var1=9999999,
2379 {{/code}}
2380
2381 **Result:** HDW0=9999999.
2382
2383 == **InvB** ==
2384
2385 **Function**
2386
2387 InvB (A1)
2388
2389 **Description**
2390
2391 The state of inverse bit, it is a sub function, no returned value. Achieve the state of switching address constantly.
2392
2393 **Parameters**
2394
2395 * **A1:** it is an address.
2396
2397 **Example**
2398
2399 //{{code language="lua"}}InvB (@B_HDX0.1) 'switch the state if (HDX0.1).{{/code}}//
2400
2401 **Result: **Switch the state of (HDX0.1) constantly.
2402
2403 == **IsFloating** ==
2404
2405 **Function**
2406
2407 A2=IsFloating (A1)
2408
2409 **Description**
2410
2411 Decide whether a parameter is floating, return true if it is floating, otherwise return FALSE.
2412
2413 **Parameter**
2414
2415 * **A1:** source data, variable;
2416 * **A2:** target data, variable;
2417
2418 **Example**
2419
2420 {{code language="lua"}}
2421 dim a as integer
2422
2423 dim b as floating
2424
2425 b= D2float ("@W_HDW200",b) 'assign the value of (HDW200) to b
2426
2427 a = IsFloating (b) 'judge whether b is floating or not
2428
2429 @W_HDW300=a 'save the result to (HDW300)
2430 {{/code}}
2431
2432 **Result: **HDW300=1
2433
2434 == **IsInteger** ==
2435
2436 **Function**
2437
2438 A2= IsInteger (A1)
2439
2440 **Description**
2441
2442 Determine whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE.
2443
2444 **Parameter**
2445
2446 * **A1:** Source date, it is variable or number;
2447 * **A2:** Target date, need to be variable, it could not be system address ;
2448
2449 **Example**
2450
2451 {{code language="lua"}}
2452 dim a as integer
2453
2454 a = IsInteger (20) 'determine whether 20 is integer
2455
2456 @W_HDW300=a ' display the result on (HDW300)
2457 {{/code}}
2458
2459 **Result:** HDW300=1
2460
2461 == **IsString** ==
2462
2463 **Function**
2464
2465 val = IsString(expr)
2466
2467 **Description**
2468
2469 Determine whether a parameter is string, return TRUE if it is string, otherwise return FALSE.
2470
2471 **Parameters**
2472
2473 * **Expr:** source string, it could be a variable or string, not address;
2474 * **Val:** target date, the result need to be variable, could not be address;
2475
2476 **Example**
2477
2478 {{code language="lua"}}
2479 dim a as integer 'define variable, display the result;
2480
2481 a= isstring ("hello") 'determine whether"hello"is string;
2482
2483 @W_HDW0=a 'assign the result to (HDW0)
2484 {{/code}}
2485
2486 **Result: **HDW=1
2487
2488 == **Lcase** ==
2489
2490 **Function**
2491
2492 A2 = LCase(A1)
2493
2494 **Description**
2495
2496 Convert all parameters to lowercase strings.
2497
2498 **Parameters**
2499
2500 * **A1: **source string, it could be an address or variable;
2501 * **A2: **outputting string, it could be an address or variable;
2502
2503 **Example**
2504
2505 (% class="box" %)
2506 (((
2507 //@W_HDW33 = LCase (@W_HDW25) 'input source sting on (HDW25), convert it to destination string and display the result on (HDW33);//
2508 )))
2509
2510 **Result:** HDW25=HELLO
2511
2512 HDW33=hello
2513
2514 == **Left** ==
2515
2516 **Function**
2517
2518 Val =Left (String, Length)
2519
2520 **Description**
2521
2522 Return a string of the specified length from the left side of parameter.
2523
2524 **Parameters**
2525
2526 * **String:** source string; it could be an address or string.
2527 * **Length: **return the number of character. It could be an address, integer or variable. Return empty string if length<1. return the whole string if length not less than the character number of string.
2528 * **Val: **destination string, outputting string, it could be an address or variable.
2529
2530 **Example**
2531
2532 (% class="box" %)
2533 (((
2534 //@W_HDW30=Left (@W_HDW36, @W_HDW40) '(HDW36) used to input source string,(HDW30) used to display the string result;//
2535 )))
2536
2537 Result:
2538
2539 * HDW36=hello,
2540 * HDW40=2,
2541 * HDW30=he
2542
2543 == **Len** ==
2544
2545 **Function**
2546
2547 Length=Len(String)
2548
2549 **Description**
2550
2551 Return the string length.
2552
2553 **Parameters**
2554
2555 * **String:** source string, it could be a address or string;
2556 * **Length:** target data, return value, it could be a address, variable, integer or floating;
2557
2558 **Example**
2559
2560 //{{code language="lua"}}@W_HDW30=Len (@W_HDW36) 'count the character number of (HDW36), save the result to (HDW30);{{/code}}//
2561
2562 **Result:**
2563
2564 * HDW36=hello
2565 * HDW30=5
2566
2567 == **Log** ==
2568
2569 **Function**
2570
2571 a= Logn (x)=Log(x)/Log(n)
2572
2573 **Description**
2574
2575 Log function:return the natural logarithm of the value.
2576
2577 **Parameters**
2578
2579 * **a: **source date,it could be a variable, but it could not be address;
2580 * **x, n:** source date, it could be a variable, but it could not be address;
2581
2582 **Example**
2583
2584 {{code language="lua"}}
2585 Dim a as integer 'define a as integer;
2586
2587 Dim b as integer 'define b as integer;
2588
2589 Dim c as integer 'define c as integer;
2590
2591 b=@W_HDW10 'assigns a value to b
2592
2593 c=@W_HDW20 'assigns a value to c
2594
2595 a=Log (b)/Log(c) 'calculate logarithm
2596
2597 @W_HDW0
2598
2599 =a 'assign the result to (HDW0)
2600 {{/code}}
2601
2602 **Result:**
2603
2604 * HDW10=27,
2605 * HDW20=3,
2606 * HDW0=3
2607
2608 == **Log10** ==
2609
2610 **Function**
2611
2612 a=Log10(x)= Log(x) / Log(10)
2613
2614 **Description**
2615
2616 Log function: return the natural logarithm.
2617
2618 **Parameters**
2619
2620 * **A:** target data, result could be variable, could not be address;
2621 * **x:** source data, it could be variable that needs to be the multiples of 10, can’t be address
2622
2623 **Example**
2624
2625 {{code language="lua"}}
2626 dim a as integer 'define a as integer
2627
2628 dim b as integer 'define b as integer
2629
2630 b=@W_HDW10 'assign a value to b
2631
2632 a= Log (b)/Log(10) 'result
2633
2634 @W_HDW0=a 'assign the result to (HDW0)
2635 {{/code}}
2636
2637 **Result: **
2638
2639 * HDW10=100,
2640 * HDW0=2
2641
2642 == **LTrim** ==
2643
2644 **Function**
2645
2646 val=LTrim("string")
2647
2648 **Description**
2649
2650 Remove the left empty part of the string and return.
2651
2652 **Parameters**
2653
2654 * **Val:** Destination string, it could be either a variable or address;
2655 * **string:** Source string, it could be either a variable or address;
2656
2657 **Example**
2658
2659 {{code language="lua"}}
2660 dim a as string
2661
2662 a=Ltrim("hello")
2663
2664 @W_HDW103=a
2665 {{/code}}
2666
2667 **Result:** HDW103=hello
2668
2669 == **MAX** ==
2670
2671 **Function**
2672
2673 A1=MAX(A2,A3)
2674
2675 **Description**
2676
2677 Compare the value of A2 and A3, assign the greater value to A1.
2678
2679 **Parameters**
2680
2681 * **A1:** Return value (used to store the greater value between A2 with A3).
2682 * **A2:** The first comparison value.
2683 * **A3:** The second comparison value.
2684
2685 (% class="box infomessage" %)
2686 (((
2687 **✎Note:** A1,A2,A3 should be only used in unsigned integer or unsigned address.
2688 )))
2689
2690 **Example**
2691
2692 {{code language="lua"}}
2693 DIM A1 as integer
2694
2695 @W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.
2696
2697 @W_HDW107=5 'assign the value to (?@W_HDW107),unsigned decimal word.
2698
2699 A1 = Max(@W_HDW106,@W_HDW107)
2700
2701 @W_HDW105 = A1
2702 {{/code}}
2703
2704 **Result: **@W_HDW105 = 10
2705
2706 == **Mid** ==
2707
2708 **Function**
2709
2710 A1=mid(A2, start, length)
2711
2712 **Description**
2713
2714 Returns a string contain a specified characters length from a string.
2715
2716 **Parameters**
2717
2718 * **A1:** string contains the selected characters, it needs to be a string
2719 * **A2:** string to be selected, it needs to be a variable or address
2720 * **Start:** the start position of string, it needs to be a variable or address, it means that count begin with 0.
2721 * **Length:** the designated length of string, maximum character length 127 allowed
2722
2723 **Example**
2724
2725 {{code language="lua"}}
2726 DIM A1 as string
2727
2728 A1 = Mid("hellokitty",1,2) 'select the string of in "
2729
2730 @W_HDW106=A1
2731 {{/code}}
2732
2733 **Result: **@W_HDW106 'display "el" on text input and output window
2734
2735 == **MIN** ==
2736
2737 **Function**
2738
2739 A1=MIN(A2,A3)
2740
2741 **Description**
2742
2743 Compare the value of A2 and A3, assign the smaller value to A1.
2744
2745 **Parameters**
2746
2747 * **A1: **Return value (used to store the snaker value between A2 with A3).
2748 * **A2: **The first comparison value.
2749 * **A3: **The second comparison value.
2750
2751 **Example**
2752
2753 {{code language="lua"}}
2754 DIM A1 as integer
2755
2756 @W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.
2757
2758 @W_HDW107=5 'assign the value to (@W_HDW107), unsigned decimal word.
2759
2760 A1 = Min(@W_HDW106,@W_HDW107)
2761
2762 @W_HDW105 = A1
2763 {{/code}}
2764
2765 **Result:** @W_HDW105 = 5
2766
2767 **✎Note:** A1, A2,A3 only used in unsigned integer or unsigned address.
2768
2769 == **MSeconds** ==
2770
2771 **Function**
2772
2773 A1=MSeconds( )
2774
2775 **Description**
2776
2777 A1 is used to display the current milliseconds of system.
2778
2779 **Parameters**
2780
2781 * **A1: **used to store the current milliseconds of system.
2782
2783 **Example**
2784
2785 {{code language="lua"}}
2786 DIM A1 as integer
2787
2788 @W_HDW0= 10 'assign a value to (@W_HDW0), unsigned decimal word
2789
2790 A1=MSeconds() 'return the current milliseconds of system to A1
2791
2792 @W_HDW0=A1
2793
2794 @W_HDW1=A1>>16 'display milliseconds on screen, (HDW0) is an 32-bit unsigned decimal integer address
2795 {{/code}}
2796
2797 **Result:** @W_HDW0 will generate the time value of changing milliseconds unit.
2798
2799 (% class="box infomessage" %)
2800 (((
2801 **✎Note:**
2802
2803 * A1 is 32-bit unsigned integer variable or unsigned integer address;
2804 * MSeconds() function rolls back over to zero once the maximum value has been reached (4294967295->0, 1,2,....4294967295->0, 1, 2,....4294967295->0, 1, 2);
2805 )))
2806
2807 == **MyDeleteFile** ==
2808
2809 **Function**
2810
2811 MyDeleteFile (A1,A2,A3,A4,A5)
2812
2813 **Description**
2814
2815 Delete the specified file
2816
2817 **Parameters**
2818
2819 A1: File location (value is an integer);
2820
2821 In HMI:
2822
2823 * =0: Recipe folder in HMI flash;
2824 * =1: Custom folder in UDisk (USB flash disk);
2825 * = 2: Custom folder in SD card.
2826 * =3: Custom folder in HMI flash;
2827
2828 In simulator:
2829
2830 * = 0: D:/Recipe/
2831 * = 1: C:/WECON/CustomFileDir/
2832 * = 2: C:/WECON/CustomFileDir/
2833 * = 3: C:/WECON/CustomFileDir/
2834
2835 **✎Note:**
2836
2837 A1 can be an address, variable or value.
2838
2839 A2: filename (value is string);
2840
2841 Input the name of the file want to delete.
2842
2843 **✎Note: **
2844
2845 A2 can be an address , variable or a character string, and the length of the file name cannot exceed 32 characters.
2846
2847 A3: folder name (value is integer);
2848
2849 Input the folder where the file want to delete.
2850
2851 **✎Note: **
2852
2853 A3 can be an address , variable or a character string, and the length of the folder name cannot exceed 32 characters.
2854
2855 A4: Delete function type (value is integer)
2856
2857 * = 0: Delete the specified file.
2858 * = 1: Delete all files.
2859
2860 **✎Note: **
2861
2862 A4 can be an address , variable or value.
2863
2864 A5: Return value (value is an integer)
2865
2866 * = 0: parameter error
2867 * = 1: Delete successfully
2868 * = 2: Delete failed
2869 * = 3: Failed to open file
2870
2871 **✎Note:** A5 must be an address.
2872
2873 **Example**
2874
2875 (% class="box" %)
2876 (((
2877 MyDeleteFile(@W_HDW1254,@W_HDW4200,@W_HDW4300,@W_HDW1250,"@W_HDW1252")
2878
2879 ‘According to the value of @W_HDW1250, delete the designated file @W_HDW4200 in the folder @W_HDW4300 or delete all files in the folder @W_HDW4300.
2880 )))
2881
2882 == **NewNoAddr** ==
2883
2884 **Function**
2885
2886 A1= NewNoAddr (A2, length)
2887
2888 **Description**
2889
2890 At the basic of source address A2, offset designated length, obtain a new address A1.
2891
2892 **Parameters**
2893
2894 * **A1: **address after offsetting, it must be String type variable.
2895 * **A2:** source address, it must be an address(e.g.:"@W_HDW2")
2896 * **Length: **offset length, it must be a constant or an integer variable.
2897
2898 **Example**
2899
2900 {{code language="lua"}}
2901 DIM A1 as string
2902
2903 A1=NewNoAddr("@W_HDW0",50) '(HDW0) offsets 50 words address (16 bit), and save the result to A1
2904
2905 @W_HDW1=A1 '(HDW50) save in A1
2906 {{/code}}
2907
2908 **Result: **(@W_HDW1) character input/display will show @W_HDW50
2909
2910 == **NewStatAddr** ==
2911
2912 **Function**
2913
2914 A1= NewStatAddr (A2, length)
2915
2916 **Description**
2917
2918 At the basic of source address A2, offset the designated length, to obtain a new station A1.
2919
2920 **Parameters**
2921
2922 * **A1: **The address after offsetting, it needs to be variable.
2923 * **A2:** Source station address, it needs to be address (e.g.:"@W_1:10").
2924 * **Length: **offset length
2925
2926 **Example**
2927
2928 {{code language="lua"}}
2929 DIM A1 as string
2930
2931 A1=NewStatAddr("@W_1:10",2) 'address 10 of station address 1 that offset 2 station addresses, then save the result to A1
2932
2933 @W_HDW1=A1 'address 3:10 is saved in A1
2934 {{/code}}
2935
2936 **Result: **@W_HDW1 character input/display will show @W_3:10
2937
2938 == **NStringCompare** ==
2939
2940 **Function**
2941
2942 A1= NStringCompare (A2, A3, length)
2943
2944 **Description**
2945
2946 Compare whether the designated length of two strings is the same, return 1 to A1 if yes, otherwise return 0.
2947
2948 **Parameters**
2949
2950 * **A1: **Returned value (compare the designated length of two strings, display 1 when equal, else 0). It could be an address or variable.
2951 * **A2: **the address of string to be compared, it needs to be address.
2952 * **A3: **source string, it needs to be variable or constant string.
2953 * **Length: **string length to be compared
2954
2955 **Example**
2956
2957 {{code language="lua"}}
2958 @W_HDW1= NStringCompare("@W_HDW0","87654",5)
2959
2960 if @W_HDW1=1 then
2961
2962 @B_HDX10.0=1 'result: HDX10.0 set ON 'when the two strings are the same.
2963
2964 endif
2965
2966 if @W_HDW1=0 then
2967
2968 @B_HDX10.0=0 'result:HDX10.0 set OFF 'when not equal.
2969
2970 Endif
2971 {{/code}}
2972
2973 == **Operator** ==
2974
2975 (% class="table-bordered" %)
2976 |=(% scope="row" %)**Operation**|=**Symbol**|=**Example**|=**Return type**
2977 |=Addition|+|A1=A2+A3|Return type depending on the type of variable or address of the addition
2978 |=Subtraction|-|A1=A2-A3|Return type depending on the type of variable or address of the subtraction
2979 |=Multiplication|*|A1=A2*A3|Return type depending on the type of variable or address of the multiplication
2980 |=Division|/|A1=A2/A3|Return type depending on the type of variable or address of the division
2981 |=Remainder|Mod ~(%)|(((
2982 A1=A2 mod A3
2983
2984 A1=A2%A3
2985 )))|Returns the remainder of the division of two numbers. The type of the return value is an integer
2986 |=Logical OR|Or(~|)|(((
2987 A1=A2 or A3
2988
2989 A1=A2|A3
2990 )))|Returns the result of a logical OR. The type of the return value is an integer.
2991 |=Logic AND|And (&)|(((
2992 A1=A2 and A3
2993
2994 A1=A2&A3
2995 )))|Returns the result of a logical AND. The type of the return value is an integer.
2996 |=Logical XOR|Xor (^)|(((
2997 A1=A2 xor A3
2998
2999 A1=A2^A3
3000 )))|Returns the result of a logical XOR. The type of the return value is an integer.
3001 |=Logical reversal|Not (!)|(((
3002 A1=not A1
3003
3004 A1=A2!A3
3005 )))|Returns the result of a logical reversal. The type of the return value is an integer.
3006 |=Left shift|<<|A1=A2<<A3|Shift the value of A2 to the left by A3 digits and return the displacement result. The type of the return value is an integer.
3007 |=Right shift|>>|A1=A2>>A3|Shift the value of A2 to the right by A3 digits and return the displacement result. The type of the return value is an integer.
3008 |=Bit reversal|~~|A1=~~A1|Perform a bit reversal on a value. The type of the return value is an integer.
3009
3010 == **PI_GetTickCount** ==
3011
3012 **Function**
3013
3014 PI_GetTickCount (A1, A2)
3015
3016 **Description**
3017
3018 Writethe startingtime tothe set address asa 32-bit integer.
3019
3020 **Parameters**
3021
3022 * **A1: **Source data could only be the HMI internal or external register starting with "@".
3023 * **A2: **=0: Unit of time for returning 0ms;(the value will become 0 after 49.7 days and so on)
3024 ** =1: Unit of time for returning 10 ms;(the value will become 0 after 497 days and so on)
3025 ** =2: Unit of time for returning 100 ms;(the value will become 0 after 4970 days and so on)
3026 ** =3: Unit of time for returning 1000ms;(the value will become 0 after 49700 days and so on)
3027
3028 (% class="box infomessage" %)
3029 (((
3030 **✎Note: **If user restarts the hmi,all value will be 0.
3031 )))
3032
3033 **Example**
3034
3035 (% class="box" %)
3036 (((
3037 //PI_GetTickCount("@W_HDW100",0)'save the starting time in HDW100 address as a 32-bit integer.//
3038 )))
3039
3040 **Result: **HDW100=123456(different returned data for each moment)
3041
3042 == **Power** ==
3043
3044 **Function**
3045
3046 var = power (expr1, expr2)
3047
3048 **Description**
3049
3050 The value of [expr2] to the power of [expr1] will be assigned to Var.
3051
3052 **Parameters**
3053
3054 * **var:** returned value.
3055 * **expr 1:** base number.
3056 * **expr 2:** power number.
3057
3058 **Example**
3059
3060 {{code language="lua"}}
3061 Dim a as floating
3062
3063 a=power (2, 3) 'the value of 3 to the power of 2 is assigned to a.
3064
3065 Float2D("@W_HDW10",a) 'assign the float value of a to @W_HDW10
3066 {{/code}}
3067
3068 **Result: **@W_HDW10=8
3069
3070 == **PrintText** ==
3071
3072 **Function**
3073
3074 PrintText(A)
3075
3076 **Description**
3077
3078 Print the content of A or locates in A.
3079
3080 **Parameters**
3081
3082 **A:** source data. A could be a variable or a string ( text information),not a register address.
3083
3084 **Example**
3085
3086 A is text information
3087
3088 //PrintText("HMI 8070”)//
3089
3090 **Result: **Printer will print out “HMI 8070”
3091
3092 * A is variable
3093
3094 //Dim a as string//
3095
3096 //a= “HMI 8070”//
3097
3098 //PrintText(a)//
3099
3100 **Result:** Printer will print out “HMI 8070”
3101
3102 **✎Note:**
3103
3104 source data length range:1-128 characters.
3105
3106 == **RadToDeg** ==
3107
3108 **Function**
3109
3110 Var= RadToDeg(expr)
3111
3112 **Description**
3113
3114 Convert radiant value to degree, then assigned to Var.
3115
3116 **Parameters**
3117
3118 * **Var:** return degree value.
3119 * **expr:** input radiant value.
3120
3121 **Example**
3122
3123 {{code language="lua"}}
3124 Dim a as floating
3125
3126 a = RadToDeg(pi)           'assignt the degree value of ? to a.
3127
3128 Float2D("@W_HDW4",a) 'assign the degree value to address "@W_HDW4".
3129 {{/code}}
3130
3131 **Result:** @W_HDW4=180
3132
3133 == **RAND** ==
3134
3135 **Function**
3136
3137 Var = rand(expr1)
3138
3139 **Description**
3140
3141 Generate a random number.
3142
3143 **Parameter**
3144
3145 * **Var:** generated random number.
3146 * **Expr1:** the base number.
3147
3148 **Example**
3149
3150 (% class="box" %)
3151 (((
3152 //@W_HDW0=rand(@W_HDW0) 'Set the value of address@W_HDW0 as the base number to generate random number.//
3153 )))
3154
3155 **Result:** @W_HDW0 random number.
3156
3157 == **ReadAddr** ==
3158
3159 **Function**
3160
3161 Word = ReadAddr(A1)
3162
3163 **Description**
3164
3165 Assigned the red value from A1 to word.
3166
3167 **Parameter**
3168
3169 * **Word: **return value
3170
3171 **Example**
3172
3173 {{code language="lua"}}
3174 Dim word as integer
3175
3176 @W_HDW100=10
3177
3178 word = ReadAddr("@W_HDW100") 'Read the value of address @W_HDW100 and assign to word.
3179
3180 @W_HDW200=word
3181 {{/code}}
3182
3183 **Result:** @W_HDW200=10
3184
3185 == **ReadWordFormFile** ==
3186
3187 **Function**
3188
3189 ReadWordFormFile (A1, A2, A3, A4, A5, A6)
3190
3191 **Description**
3192
3193 Read data of specified length from specified file
3194
3195 **Parameters**
3196
3197 A1: File location (value is an integer);
3198
3199 In HMI:
3200
3201 * =0: Recipe folder in HMI flash;
3202 * =1: Custom folder in UDisk (USB flash disk);
3203 * = 2: Custom folder in SD card.
3204 * =3: Custom folder in HMI flash;
3205
3206 In simulator:
3207
3208 * = 0: D:/Recipe/
3209 * = 1: C:/WECON/CustomFileDir/
3210 * = 2: C:/WECON/CustomFileDir/
3211 * = 3: C:/WECON/CustomFileDir/
3212
3213 **✎Note:** A1 can be an address, variable or value.
3214
3215 A2: File name (value is a string);
3216
3217 Input the file name want to write.
3218
3219 **✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.
3220
3221 A3: Data start address (value is a string);
3222
3223 Input the data want to write
3224
3225 **✎Note: **A3 must be the address.
3226
3227 A4: Data length (value is an integer)
3228
3229 Set the length of the data to be written (unit:word)
3230
3231 **✎Note: **A4 can be an address , variable or value.
3232
3233 A5: Return value (value is an integer)
3234
3235 ~= 1: Successfully read
3236
3237 ~= 2: Failed to open the folder
3238
3239 ~= 3: Read address error
3240
3241 ~= 4: File reading error
3242
3243 **✎Note: **A5 must be an address.
3244
3245 A6: Folder name (value is a string);
3246
3247 Input the folder where to be written the file.
3248
3249 **✎Note:** A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters
3250
3251 **Example**
3252
3253 (% class="box" %)
3254 (((
3255 ReadWordFormFile(@W_HDW1254,"@W_HDW4200","@W_HDW2000",@W_HDW4000,"@W_HDW4100", @W_HDW4300)'Write the @W_HDW4000 words in the file @W_HDW4200 in the directory @W_HDW4300 into the address @W_HDW2000 specified location by @W_HDW1254
3256 )))
3257
3258 == **Right** ==
3259
3260 **Function**
3261
3262 val = Right (string, length)
3263
3264 **Description**
3265
3266 Return a string of the specified length from the right side of parameter.
3267
3268 **Parameter**
3269
3270 * **string: **the operated string.
3271 * **length:** the designated number of byte required to return, count from the right side.
3272
3273 **Example**
3274
3275 //@W_HDW103= Right("Hello", 3) 'return "llo"//
3276
3277 **Result: **@W_HDW103="llo"
3278
3279 == **RTrim** ==
3280
3281 **Function**
3282
3283 val = RTrim(str)
3284
3285 **Description**
3286
3287 Clear the empty part on the right side of string [str], then assign the empty part to val
3288
3289 **Parameter**
3290
3291 * **val: **returned value.
3292 * **str:** the string needs to be operated.
3293
3294 **Example**
3295
3296 (% class="box" %)
3297 (((
3298 //@W_HDW0 = RTrim("   -Hell  o-  ") 'retrun"   -Hell  o-"//
3299 )))
3300
3301 **Result:** @W_HDW0display "   -Hell  o-"
3302
3303 == **S2F** ==
3304
3305 **Function**
3306
3307 S2F (A1,A2,s1)
3308
3309 **Description**
3310
3311 S2F is used to translate the string stored in A1 to floating and store the floating number in A2 according to the data format shown in A2.
3312
3313 **Parameters**
3314
3315 * **A1:** initial data address, used to store the string data, it should be the internal address of HMI or external address that started with “@”,like @W_HDW0
3316 * **A2:** destination address, used to store the floating number data. It should be the internal address of HMI or external address that started with “@”,like @W_HDW0
3317 * **S1:** display format of target data, for example m.nf, m means the length of string is m, n means the decimal places, f is the format used to output single precision number. (Since the floating point number is up to 7 digits, the decimal point in the string is also a bit, so it is recommended that the length should not exceed 8 bits)
3318
3319 **Return value:** none
3320
3321 **Example**
3322
3323 (% class="box" %)
3324 (((
3325 The lengTh of string is 8
3326
3327 //@W_HDW0="12345.67"//'Assign the string “12345.67" to HDW1
3328
3329 //S2F("@W_HDW0","@W_HDW100","8.2f") 'read string "12345.67 "from HDW0and convert it into a floating point with 2 decimal places, store in the HDW100//
3330 )))
3331
3332 **Result: **@W_HDW100 address displays “12345.67”.
3333
3334 (% class="box" %)
3335 (((
3336 The length of string is less than 8
3337
3338 //@W_HDW0="1234.5 67"‘assign the string“1234.567”to HDW1//
3339
3340 //S2F("@W_HDW0","@W_HDW100","6.2f") ' read string "1234 .5"from HDW0and convert it into a floating point with 2 decimal places, store in the HDW100 .//
3341 )))
3342
3343 **Result: **the floating value of @W_HDW100 is 1234.50
3344
3345 (% class="box" %)
3346 (((
3347 The length of string is more than 8
3348
3349 //@W_HDW0="12345.6789"’assign the string “12345.6789” to HDW1//
3350
3351 //S2F("@W_HDW0","@W_HDW100","8.2f") ' read string "12345 .67" from HDW0 and convert it into a floating point with 2 decimal places, store in the HDW100 .//
3352 )))
3353
3354 **Result: **the floating value of @W_HDW100 is 12345.67
3355
3356 == **SetB** ==
3357
3358 **Function**
3359
3360 SetB(A1)
3361
3362 **Description**
3363
3364 Set the bit A1 ON.
3365
3366 **Parameters**
3367
3368 * **A1:**Bit address
3369
3370 **Example**
3371
3372 (% class="box" %)
3373 (((
3374 //SetB(@B_HDX100.0) 'Set the address {@B_HDX100.0} ON//
3375 )))
3376
3377 **Result: **@B_HDX100.0=1
3378
3379 == **SetKeyMap** ==
3380
3381 **Function**
3382
3383 SetKeyMap(A1,A2,A3)
3384
3385 **Description**
3386
3387 The key values of the keyboard are mapped so that multiple keyboard buttons perform the same function.
3388
3389 **Parameters**
3390
3391 * **A1:** The starting address of the source key;It needs to be an address format;
3392 * **A2: **The starting address of the mapped value; It needs to be an address format;
3393 * **A3: **Mapping length (continuous length of mapped address); It needs to be a value, the maximum mapping range: 108 key values;
3394
3395 **Example**
3396
3397 (% class="box" %)
3398 (((
3399 //@W_HDW3000 = 3 ' The starting address of the source key//
3400
3401 //@W_HDW3001 = 5//
3402
3403 //@W_HDW3002 = 7//
3404
3405 //@W_HDW3003 = 9//
3406
3407 //@W_HDW3004 = 61//
3408
3409 //@W_HDW4100 = 103 'The starting address of the mapped value//
3410
3411 //@W_HDW4101 = 105//
3412
3413 //@W_HDW4102 = 106//
3414
3415 //@W_HDW4103 = 108//
3416
3417 //@W_HDW4104 = 28//
3418
3419 //SetKeyMap("@W_HDW3000","@W_HDW4100",5) ' Map the values of the HDW4000~~HDW4004 addresses to the HDW3000~~HDW3004 addresses.//
3420 )))
3421
3422 **Result**
3423
3424 Map the value of the HDW4000~~HDW4004 address (mapped to 103 105 106 108 28) to the value of the HDW3000~~HDW3004 address (source key value 3 5 7 9 61)
3425
3426 Button 2 (key value 3) is mapped to the direction key (key value is 103), button 4 (key value 5) is mapped to the left arrow key (key value is 105), and so on. When using the keyboard, the function of input 2 could be performed on both the button 2 and the direction button.
3427
3428 == **SignedInt16** ==
3429
3430 **Function**
3431
3432 val = SignedInt16(A1)
3433
3434 **Description**
3435
3436 Assign the value to {val} from address A1 which is signed integer.
3437
3438 **Parameters**
3439
3440 * **A1: **contain signed integer as "@W_HDW000002"
3441 * **Val: **returned value
3442
3443 **Example**
3444
3445 {{code language="lua"}}
3446 Dim a as integer 'Integer variable a
3447
3448 a = SignedInt16("@W_HDW0") 'read signed integer from HDW0 addresses and assign the value to a
3449
3450 @W_HDW2=a'assign the value a to HDW2
3451 {{/code}}
3452
3453 **Input: **@W_HDW0=-2:
3454
3455 **Result:** @W_HDW2=-2.
3456
3457 == **SignedInt32** ==
3458
3459 **Function**
3460
3461 val = SignedInt32 (A1)
3462
3463 **Description**
3464
3465 Assign the value to {val} from address A1 which is signed even integer.
3466
3467 **Parameters**
3468
3469 * **A1: **the address contains signed even integer
3470 * **Val:** Returned value
3471
3472 **Example**
3473
3474 {{code language="lua"}}
3475 Dim a as integer 'define {a} as a integer
3476
3477 a = SignedInt32("@W_HDW0") 'read signed even integer from HDW0, then assign this value to a.
3478
3479 @W_HDW2=a 'assign the value of a to HDW2
3480
3481 @W_HDW3=a>>16
3482 {{/code}}
3483
3484 **Input: **@W_HDW0=-2
3485
3486 **Result:**
3487
3488 * @W_HDW2=-2
3489 * @W_HDW13=-1
3490
3491 == **Sin** ==
3492
3493 **Function**
3494
3495 val = Sin(A1)
3496
3497 **Description**
3498
3499 Get the sine value of A1, and copy result to val.
3500
3501 **Parameters**
3502
3503 * **A1: **A1 needs to be an angle.
3504 * **Val: **Returned value.
3505
3506 **Example**
3507
3508 {{code language="lua"}}
3509 Dim a as floating 'floating variable a,b
3510
3511 a=sin(pi/6) 'return sinb to a
3512
3513 Float2D("@W_HDW13",a) 'assign the value of the floating variable a to address HDW13.
3514 {{/code}}
3515
3516 **Result:** @W_HDW13=0.5
3517
3518 == **SleepA** ==
3519
3520 **Function**
3521
3522 SleepA(T)
3523
3524 **Description**
3525
3526 Wait time T(ms).
3527
3528 **Parameters**
3529
3530 * **T:** wait time, the unit is [ms]
3531
3532 **Returned value:** none.
3533
3534 **Example**
3535
3536 (% class="box" %)
3537 (((
3538 //SleepA(10) 'wait 10ms//
3539 )))
3540
3541 **Result:** When the script runs to SleepA(10), it means the scripts would go running after waiting 10ms
3542
3543 == **Sqr** ==
3544
3545 **Function**
3546
3547 val = Sqr(A1)
3548
3549 **Description**
3550
3551 Assign a square root value of A1 to val.
3552
3553 **Parameters**
3554
3555 * **A1: **the data need to be operated
3556 * **Val: **Returned value
3557
3558 **Example**
3559
3560 (% class="box" %)
3561 (((
3562 //@W_HDW0 = Sqr(4) 'calculate the square root of HDW0//
3563 )))
3564
3565 **Result:** @W_HDW0=2
3566
3567 == **StAndFtChange** ==
3568
3569 **Function**
3570
3571 StAndFtChange(A1,A2,A3)
3572
3573 **Description**
3574
3575 Calculate the number of seconds from January 1, 1970 to the current time, and also be invertible.
3576
3577 **Parameters**
3578
3579 * **A1: **The start address of curren t time (Enter or output year, month, day, minute, and second); It needs to begin with address"@", and occupies 6 addresses;
3580 * **A2: **The number of seconds; It needs to begin with address “@", data format 32-bit unsigned.
3581 * **A3: **conversion method;
3582 ** A3=0, convert time to seconds;
3583 ** A3=1, convert seconds to time;
3584
3585 **Returned value: **none;
3586
3587 **Example**
3588
3589 Script 1
3590
3591 (% class="box" %)
3592 (((
3593 //StAndFtChange("@W_HDW10","@W_HDW20",0) // //‘use HDW10 as start address, and enter year, month, day, hour, minute, second. The script calculates the number of seconds from January 1, 1970 to the time of the entry, and stores the result in HDW20//
3594 )))
3595
3596 **Input: **HDW10 = 2017,HDW11 = 12, HDW12 = 9 , HDW13 = 15, HDW14 = 15, HDW15 = 0
3597
3598 **Output:** 1512832500
3599
3600 Script 2
3601
3602 (% class="box" %)
3603 (((
3604 //StAndFtChange("@W_HDW30","@W_HDW20",1) ‘read number of seconds from HDW20, and the script calculates the date time, and stores the result start from HDW30//
3605 )))
3606
3607 **Input:** 1512833760
3608
3609 **Output:** HDW30 = 2017, HDW31 = 12, HDW32 = 9, HDW33 = 15, HDW34 = 36, HDW35 = 0
3610
3611 == **Sub** ==
3612
3613 **Function**
3614
3615 Sub name (arglist)
3616
3617 statements
3618
3619 End Sub
3620
3621 **Description**
3622
3623 Declare the name, parameters and codes of the Sub (sub function)
3624
3625 **Parameters**
3626
3627 * **Name: **naming rules refer to variable.
3628 * **Arglist: **variable list.
3629 * **Statements:** the code set of the sub function.
3630
3631 **Example**
3632
3633 {{code language="lua"}}
3634 sub samesub(a,b as integer) ' samesub and integer variable a,b
3635
3636 c=a+b
3637
3638 @W_HDW0=c
3639
3640 endsub
3641
3642 samesub(1,12) 'call function samesub
3643 {{/code}}
3644
3645 **Result:** @W_HDW0=13
3646
3647 == **SWAP** ==
3648
3649 **Function**
3650
3651 SWAP(A1,length)
3652
3653 **Description**
3654
3655 Swap the big-endian with the little-endian from address A1, swap length is adjustable.
3656
3657 **Parameters**
3658
3659 * **A1: **the swapped high endian, need to be an address as HDW_000002.
3660 * **Length: **swap length.
3661
3662 **Returned value:** None.
3663
3664 **Example**
3665
3666 {{code language="lua"}}
3667 @W_HDW103=0x1234 'assign value to HDW103
3668
3669 @W_HDW104=0x2345 'assign value to HDW104
3670
3671 @W_HDW105=0x2565 'assign value to HDW105
3672
3673 @W_HDW106=0x2675 'assign value to HDW106
3674
3675 SWAP(@W_HDW103,4) 'swap the high and low endian for the 4 adjacent addresses start with HDW103.
3676 {{/code}}
3677
3678 **Result:**
3679
3680 * @W_HDW103=0x3412
3681 * @W_HDW104=0x4523
3682 * @W_HDW105=0x6525
3683 * @W_HDW106=0x7526
3684
3685 == **Tan** ==
3686
3687 **Function**
3688
3689 val = Tan(A1)
3690
3691 **Description**
3692
3693 Get the returned tagent value of A1, and then assign to val.
3694
3695 **Parameters**
3696
3697 * **A1: **A1 needs to be an angle.
3698 * **Val: **Returned value.
3699
3700 **Example**
3701
3702 {{code language="lua"}}
3703 Dim a as floating 'define a floating variable a
3704
3705 a=TAN(pi/3) 'calculate the tangent value of pi/3 and assign to a
3706
3707 Float2D("@W_HDW16",a) 'assign the value of a to HDW16
3708 {{/code}}
3709
3710 **Result:** @W_HDW13=1.732
3711
3712 == **Trim** ==
3713
3714 **Function**
3715
3716 val = Trim(A1)
3717
3718 **Description**
3719
3720 Return A string in A1 without empty string next to it.
3721
3722 **Parameters**
3723
3724 * **A1: **The operated string
3725 * **val: **Returned value
3726
3727 **Example**
3728
3729 //{{code language="lua"}}@W_HDW1=Trim(" ab "){{/code}}//
3730
3731 **Result: **@W_HDW1="ab"
3732
3733 == **UCase** ==
3734
3735 **Function**
3736
3737 val = UCase(A1)
3738
3739 **Description**
3740
3741 Capitalize the string data, and then assign the value to val.
3742
3743 **Parameters**
3744
3745 * **A1: **Operated string, address or variable.
3746 * **Val: **Returned value
3747
3748 **Example**
3749
3750 //{{code language="lua"}}@W_HDW1=ucase("abcd") 'Capitalize abcd then assign the value to HDW1{{/code}}//
3751
3752 **Result: **@W_HDW1="ABCD"
3753
3754 == **Variable** ==
3755
3756 **Description**
3757
3758 A variable is any factor, trait, or condition that could exist in differing amounts or types.
3759
3760 **Define variable**
3761
3762 Use Dim to define variable in script. The variable could be string, floating, integer.
3763
3764 **Example:**
3765
3766 {{code language="lua"}}
3767 Dim a as floating ‘define variable {a} as a floating.
3768
3769 Dim b,c,d as integer‘define variable {b,c,d} as integer
3770 {{/code}}
3771
3772 **Naming rules**
3773
3774 The first letter needs to be English letter.
3775
3776 No symbols.
3777
3778 Maximum character length 15 allowed.
3779
3780 == **W2B** ==
3781
3782 **Function**
3783
3784 W2B(A1, A2, A3)
3785
3786 **Description**
3787
3788 Replace the high endian of [A2]+1 with the high endian of A2.
3789
3790 **Parameters**
3791
3792 * **A1:** operated address.
3793 * **A2:** source address.
3794 * **A3: **the conversion length.
3795
3796 **Returned value:** none.
3797
3798 **Example**
3799
3800 {{code language="lua"}}
3801 @W_HDW0 = 4660 'assign 16bit value 1234 to HDW0.
3802
3803 @W_HDW1=0x5678 'assign 16bit value 5678 to HDW1.
3804
3805 @W_HDW2 = 0x2425 'assign 16bit value 2425 to HDW1.
3806
3807 @W_HDW3 = 0x3536 'assign 16bit value 3536 to HDW0.
3808
3809 @W_HDW4 = 0x1415 'assign 16bit value 1415 to HDW0.
3810
3811 W2B(@W_HDW20,@W_HDW0, @W_HDW10)
3812
3813 @W_HDW10=1 ‘save the high endian {34} of HDW0 to HDW20.
3814 {{/code}}
3815
3816 **Result:** @W_HDW20=0x34, @W_HDW21=0, @W_HDW22=0
3817
3818 == **W2D** ==
3819
3820 **Function**
3821
3822 W2D(A1, A2)
3823
3824 **Description**
3825
3826 Convert the unsigned Word to unsigned Dword and save the result in A1.
3827
3828 **Parameters**
3829
3830 * **A1: **operated address .
3831 * **A2:** source address.
3832
3833 Returned value.
3834
3835 **Example**
3836
3837 Unsigned decimal word
3838
3839 (% class="box" %)
3840 (((
3841 //@W_HDW0 = 1234 'assign 1234 to HDW0.//
3842
3843 //W2D(@W_HDW2, @W_HDW0) 'convert unsigned word {1234} from HDW0 to Dword and save in HDW2//
3844 )))
3845
3846 **Result:** @W_HDW0=12345, @W_HDW2=12345, @W_HDW3=0
3847
3848 Signed decimal word
3849
3850 (% class="box" %)
3851 (((
3852 //@W_HDW0 = -12345 'assign value to HDW0: convert {-12344} to unsigned decimal word is {53191}.//
3853
3854 //W2D(@W_HDW2, @W_HDW0) 'save unsigned Dword to HDW0//
3855 )))
3856
3857 **Result: **@W_HDW0=-12345,@W_HDW2=53191,@W_HDW3=0
3858
3859 == **W2F** ==
3860
3861 **Function**
3862
3863 A1 = W2F (A2)
3864
3865 **Description**
3866
3867 Convert a 16bit integer to a 32bit floating, and then save to the next word of A1.
3868
3869 Parameters
3870
3871 * **A1:** operated address.
3872 * **A2:** source address.
3873
3874 **Returned value:** none.
3875
3876 **Example**
3877
3878 A1, A2 are addresses
3879
3880 (% class="box" %)
3881 (((
3882 //@W_HDW0 = 1234 ' assign unsigned word {1234} HDW0 @W_HDW1=W 2F(@W_HDW0) ‘ Convert {1234} to a 32bit floating and then save to HDW1, HDW2.//
3883 )))
3884
3885 **Result: **@W_HDW1=1234'32bit floating
3886
3887 {{code language="lua"}}
3888 A1 is an address,A2 is variable
3889
3890 dim a as integer
3891
3892 a=134 'define a integer 134 to a,
3893
3894 @W_HDW2=W2F (a) 'convert to 32bit floating save to HDW1, HDW2.
3895 {{/code}}
3896
3897 **Result: **@W_HDW1=134' 32bit floating
3898
3899 == **W2S** ==
3900
3901 **Function**
3902
3903 W2S(A1,A2,S1)
3904
3905 **Description**
3906
3907 Convert integer word in address A1 text as S1 format, and then save to A2.
3908
3909 **Parameters**
3910
3911 * **A1:** operated address.
3912 * **A2:** source address.
3913 * **S1:** saving format.
3914 ** d format: Decimal format.d: Real data length.Md: Designated data length. 0md: Designated data length if the length is shorter than m adds 0 at the left.
3915 ** format: Unsigned octal format. Mo and 0mo is also applied.
3916 ** x format: unsigned Hex integer format ?Mx and 0mx is also applied.
3917 ** c format: ASCII format.
3918
3919 **Example**
3920
3921 Decimal format
3922
3923 {{code language="lua"}}
3924 @W_HDW1=1456'assign value {1456} to HDW1.
3925
3926 W2S("@W_HDW1", "@W_HDW10", "6d") ' convert{1456} to decimal text and save to HDW10.
3927 {{/code}}
3928
3929 **Result: **@W_HDW10 shown "1456"
3930
3931 0md
3932
3933 {{code language="lua"}}
3934 @W_HDW1=1456 ' assign value {1456} to HDW1
3935
3936 W2S("@W_HDW1", "@W_HDW10", "06d") ' convert{1456} to integer decimal text and add 2 {0} on the left of the data then save to HDW10.
3937 {{/code}}
3938
3939 **Result:** @W_HDW10 show text "001456"
3940
3941 == **WaitEthernetStart** ==
3942
3943 **Function**
3944
3945 WaitEthernetStart (A1)
3946
3947 **Description**
3948
3949 Waiting for Ethernet to start, it will extend the HMI start up time (only added in PI i series, Ethernet start up is earlier than HMI in other PI series)
3950
3951 **Parameters**
3952
3953 * **A1: **Waiting timeout (1~~20s)
3954 ** If A1=0, the wait timeout is 10s;
3955 ** If A1>20, the wait timeout is 20s;
3956
3957 **Returned value:** None
3958
3959 **Example**
3960
3961 //WaitEthernetStart (15)//
3962
3963 ‘The maximum waiting time is 15 seconds. If Ethernet is not started within 15 seconds, HMI will start the system and no longer wait for ethernet.
3964
3965 == **WHILE ... WEND** ==
3966
3967 **Function**
3968
3969 While condition
3970
3971 [statements]
3972
3973 Wend
3974
3975 **Description**
3976
3977 If the condition is true, then all the commands before Wend in the statement will be executed then recheck the condition, if the condition is false, the command after Wend will be executed.
3978
3979 **Parameters**
3980
3981 * **Condition: **Number or string, the result represents as True or False.
3982
3983 **Returned value:** None.
3984
3985 **Example**
3986
3987 {{code language="lua"}}
3988 while @W_HDW1>50 'the condition is the value of HDW1 bigger than 50.
3989
3990 @W_HDW1=@W_HDW1-1 'when the condition is true, execute subtract 1 from 1HDW.
3991
3992 wend
3993
3994 @W_HDW2=@W_HDW2+1 ' when the condition is false, execute add 1 from 1HDW.
3995 {{/code}}
3996
3997 **Result:** If HDW1=60, after executed; HDW1=50, if the condition is true.
3998
3999 == **WriteAddr** ==
4000
4001 **Function**
4002
4003 WriteAddr(A1,A2)
4004
4005 **Description**
4006
4007 Assign the value from A2 to address A1.
4008
4009 **Parameters**
4010
4011 * **A1:** operated address
4012 * **A2:** source address
4013
4014 **Returned value:** None.
4015
4016 **Example**
4017
4018 {{code language="lua"}}
4019 dim f as integer ' integer f
4020
4021 f=13 ' assign the value 13 to f
4022
4023 WriteAddr("@W_HDW1",f) ' write the value to HDW1.
4024
4025 WriteAddr("@W_HDW10",@W_HDW2) ' write the value from HDW2 to HDW10.
4026 {{/code}}
4027
4028 **Result:**
4029
4030 * HDW1=13
4031 * HDW10= HDW2'IF HDW2=1456,Then HDW10=1456;IF HDW2=-123,Then HDW10=-123
4032
4033 == **WriteWordToFile** ==
4034
4035 **Function**
4036
4037 WriteWordToFile (A1,A2,A3,A4,A5,A6)
4038
4039 **Description**
4040
4041 Write data of designated length to specified file
4042
4043 **Parameters**
4044
4045 A1: File location (value is an integer);
4046
4047 In HMI:
4048
4049 * =0: Recipe folder in HMI flash;
4050 * =1: Custom folder in UDisk (USB flash disk);
4051 * = 2: Custom folder in SD card.
4052 * =3: Custom folder in HMI flash;
4053
4054 In simulator:
4055
4056 * = 0: D:/Recipe/
4057 * = 1: C:/WECON/CustomFileDir/
4058 * = 2: C:/WECON/CustomFileDir/
4059 * = 3: C:/WECON/CustomFileDir/
4060
4061 **✎Note: **A1 can be an address, variable or value.
4062
4063 A2: File name (value is a string);
4064
4065 Input the file name want to write.
4066
4067 **✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.
4068
4069 A3: Data start address (value is a string);
4070
4071 Input the data want to write
4072
4073 **✎Note: **A3 must be the address.
4074
4075 A4: Data length (value is an integer)
4076
4077 Set the length of the data to be written (unit:word)
4078
4079 **✎Note: **A4 can be an address , variable or value.
4080
4081 A5: Return value (value is an integer)
4082
4083 * = 1: Successfully written
4084 * = 2: Failed to open the folder
4085 * = 3: Read address error
4086 * = 4: File writing error
4087 * = 5: The file already exists
4088
4089 **✎Note: **A5 must be an address.
4090
4091 A6: Folder name (value is a string);
4092
4093 Input the folder where to be written the file.
4094
4095 (% class="box infomessage" %)
4096 (((
4097 **✎Note: **A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters
4098 )))
4099
4100 **Example**
4101
4102 (% class="box" %)
4103 (((
4104 WriteWordToFile(@W_HDW1254,"@W_HDW4200","@W_HDW1000",@W_HDW4000,"@W_HDW4100", @W_HDW4300)'Write the @W_HDW4000 words in the address @W_HDW1000 to the file @W_HDW4200 in directory @W_HDW4300 specified location by @W_HDW1254
4105 )))