Skip to Content

Wiki source code of 08 Macro Script

Version 15.2 by Stone Wu on 2022/08/02 15:47
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="lua"}}
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 |(% style="width:178px" %)ClrB|(% style="width:1311px" %)Set the bit of A1 as FALSE
517 |(% style="width:178px" %)InvB|(% style="width:1311px" %)The state of inverse bit
518 |(% style="width:178px" %)SetB|(% style="width:1311px" %)Set the bit A1 ON
519
520 == File operation ==
521
522 (% class="table-bordered" %)
523 |(% style="width:177px" %)**Function**|(% style="width:1312px" %)**Introduction**
524 |(% style="width:177px" %)HmiRegOperator|(% style="width:1312px" %)Data of Upload/ Download address
525 |(% style="width:177px" %)CopyFile|(% style="width:1312px" %)Copy the A3 file from the A1 directory to the A2 directory according to the format of A4 and A5
526 |(% style="width:177px" %)DbToCsvFile|(% style="width:1312px" %)Convert db (database file) file to csv format and export it
527 |(% style="width:177px" %)FileCmpDir|(% style="width:1312px" %)The filename input and the filename in the folder whether is duplicate or not
528 |(% style="width:177px" %)MyDeleteFile|(% style="width:1312px" %)Delete the designated file
529 |(% style="width:177px" %)WriteWordToFile|(% style="width:1312px" %)Write data with designated length to designated file
530 |(% style="width:177px" %)ReadWordFormFile|(% style="width:1312px" %)Read data with designated length from designated file
531
532 == Comparison ==
533
534 (% class="table-bordered" %)
535 |(% colspan="2" style="width:389.5px" %)**Function**|(% style="width:691.5px" %)**Introduction**
536 |(% rowspan="8" style="width:255.281px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__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" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__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 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__AddrStringCompare__|(% style="width:1308px" %)Compare the designated length of two character strings
560 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__beep__|(% style="width:1308px" %)Enable buzzer
561 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__IsFloating__|(% style="width:1308px" %)whether a parameter is floating, return TRUE if it is floating, otherwise return FALSE
562 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__IsInteger__|(% style="width:1308px" %)whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE
563 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Log__|(% style="width:1308px" %)Log function: return the natural logarithm of the value
564 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Log10__|(% style="width:1308px" %)Log function: return the natural logarithm of the value
565 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__MSeconds__|(% style="width:1308px" %)Display the current microseconds of system
566 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__NewNoAddr__|(% style="width:1308px" %)At the basic of source address A2,offset designated length,obtain a new address A1
567 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__NewStatAddr__|(% style="width:1308px" %)At the basic of source address A2,offset the designated length,to obtain a new station A1.
568 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__NStringCompare__|(% style="width:1308px" %)Compare whether the designated length of two strings is the same,return 1 to A1 if yes,otherwise return 0
569 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Power__|(% style="width:1308px" %)The value of [expr2] to the power of [expr1] will be assigned to Var
570 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Rand__|(% style="width:1308px" %)Generate a random number
571 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__ReadAddr__|(% style="width:1308px" %)Assign the value in the specified address to [word]
572 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__SleepA__|(% style="width:1308px" %)Wait time T(ms)
573 |(% style="width:181px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__WriteAddr__|(% style="width:1308px" %)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 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Dim...as...__|(% style="width:1307px" %)Declare a variable
580 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__do__|(% style="width:1307px" %)Condition determent instruction
581 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Function__|(% style="width:1307px" %)Differ from internal function, need to declare the name, parameter, code of the function
582 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__Sub__|(% style="width:1307px" %)Declare the name, parameters and codes of the Sub (sub function)
583 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__PrintText__|(% style="width:1307px" %)Output the contents to the printer for printing
584 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__PI_GetTickCount__|(% style="width:1307px" %)Write the starting time in the set address as a 32-bit integer
585 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__StAndFtChange__|(% style="width:1307px" %)Calculate the number of seconds from January 1, 1970 to the current time
586 |(% style="width:182px" %)(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__GetServerDelayInfo__|(% style="width:1307px" %)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="lua"}}@W_HDW20=A2H(@W_HDW10) ' convert the string of HDW10 to hex then save in HDW20.{{/code}}//
608
609 **Input:** @W_HDW10=255
610
611 **Result:** @W_HDW20=255
612
613 (% class="box infomessage" %)
614 (((
615 **✎Note:**
616
617 * A1 needs to be address (such as:@W_HDW000002).
618 * Only [0~~1], [a~~f] can be converted, others will be converted to 0
619 )))
620
621 == A2I ==
622
623 **Function**
624
625 A2I (A1, A2, length, S)
626
627 **Description**
628
629 Intercept a string of the specified length from A1,convert it to a single/double word integer and assign this integer to A2.
630
631 **Parameters**
632
633 * **A1:** String to be intercepted
634 * **A2:** The final integer value
635 * **Length:** intercepts the length of the string
636 * **S:** Control single or double words.
637 ** S=0, indicating an integer single word; S=1, indicating an integer double word.
638
639 **Return value:** none
640
641 **Example**
642
643 {{code language="lua"}}
644 A2I("@W_HDW200","@W_HDW100",4,0) 'converts a string into a 16-bit (single word) decimal integer
645
646 A2I("@W_HDW600","@W_HDW500",4,1)' converts a string to a 32-bit (double word) decimal integer
647 {{/code}}
648
649 **Input: **@W_HDW200="12345", **Result:** @W_HDW100=1234
650
651 **Input: **@W_HDW600="12345", **Result:** @W_HDW500=1234
652
653 (% class="box infomessage" %)
654 (((
655 **✎Note:** A1 and A2 need to be address (such as:@W_HDW000002).
656 )))
657
658 == **Abs** ==
659
660 **Function**
661
662 val = Abs(A1)
663
664 **Description**
665
666 The absolute value of A1.
667
668 **Parameters**
669
670 * **A1: **the data of absolute value, need to be variable.
671 * **Val: **it is absolute value that is address or variable.
672
673 **Example**
674
675 {{code language="lua"}}
676 Dim a as integer 'a is defined as integer
677
678 a = SignedInt16("@W_HDW0")'convert the data of @W_HDW0 into signed data.
679
680 @W_HDW1 = Abs(a) 'assign the returned absolute value to @W_HDW1
681 {{/code}}
682
683 **Input: **@W_HDW0=-6
684
685 **Result: **@W_HDW1=6
686
687 (% class="box infomessage" %)
688 (((
689 **✎Note: SignedInt16** function is designed to convert unsigned to signed.
690 )))
691
692 == **ACos** ==
693
694 **Function**
695
696 val = ACos(A1)
697
698 **Description**
699
700 To compute the inverse cosine value of A1.
701
702 **Parameters**
703
704 * **A1: **floating value, can be an address or variable.
705 * **Val: **return value is floating, can be an address or variable.
706
707 **Example**
708
709 {{code language="lua"}}
710 Dim a ,b as floating'define two float variable a,b
711
712 a = 0.5 'assign the designated value to a
713
714 b = ACos(a) 'the inverse cosine value of "a" is a radian which assign to variable b.
715
716 'to add the following sentence if needed to view the return value:
717
718 float2d("@W_HDW200", b)'float b written into HDW200.
719 {{/code}}
720
721 **Result:** @W_HDW200=1.047
722
723 (% class="box infomessage" %)
724 (((
725 **✎Note:** Please call **RadToDeg** function to convert radian into angle.
726 )))
727
728 == **AddrStringCompare** ==
729
730 **Function**
731
732 val = AddrStringCompare(A1, A2, length)
733
734 **Description**
735
736 It is designed to compare the designated length of two character strings. The string value is 1 when the two strings are the same.
737
738 **Parameters**
739
740 * **A1, A2: **character string, need to be an address (such as:"@W_HDW000002")
741 * **Length: **The length of character string.
742 * **Val: **Return value, 0 or 1.
743
744 **Example**
745
746 {{code language="lua"}}
747 if AddrStringCompare("@W_HDW10","@W_HDW0",2)=1 then
748
749 'compare the character string of HDW10 and @W_HDW0 whether value are 1.
750
751 @W_HDW20=1 '@W_HDW20 display 1
752
753 else
754
755 @W_HDW20=0'@W_HDW20 display 0
756
757 Endif
758 {{/code}}
759
760 **Input: **@W_HDW10="1a2 ", @W_HDW0="1a2 ",
761
762 **Result:** @W_HDW20=1
763
764 **Input: **@W_HDW10="ab2 ", @W_HDW0="12a ",
765
766 **Result: **@W_HDW20=0
767
768 == **Asc** ==
769
770 **Function**
771
772 val = Asc(A1)
773
774 **Description**
775
776 Return the first character of the string in ASCII value.
777
778 **Parameters**
779
780 * **A1:**character string, it can be an address (such as: @W_HDW000002)
781 * **val:**return value,ASCII value,it could be an address or variable.
782
783 **Example**
784
785 {{code language="lua"}}
786 @W_HDW10 = Asc("A") 'return the ASCII value of A to HDW10
787
788 @W_HDW11 = Asc("a")'return the ASCII value of a to HDW11
789
790 @W_HDW12 = Asc("Apple") 'return the first character A of string Apple to HDW12
791
792 @W_HDW13 = Asc("123") 'return the first character ASCII value 1 of string 123 to HDW13.
793 {{/code}}
794
795 **Result:**
796
797 * @W_HDW10 = 65
798 * @W_HDW11 = 97
799 * @W_HDW12 = 65
800 * @W_HDW13 = 49
801
802 == **AsFloating** ==
803
804 **Function**
805
806 val = AsFloating(A1)
807
808 **Description**
809
810 Convert parameter A1 to a float.
811
812 **Parameters**
813
814 * A1: integer variable.
815 * **val: **return float value, can be a variable or address.
816
817 **Example**
818
819 {{code language="lua"}}
820 Dim a as integer 'define a integer variable {a}.
821
822 a = @W_HDW10 'assign @W_HDW10 to a
823
824 b = AsFloating(a) 'convert integer a to float then assign to b.
825
826 b = b/1.2 'add as following sentence when need to view the return value:
827
828 Float 2D("@W_HDW11",b) 'float variable b written into HDW11.
829 {{/code}}
830
831 **Input: **@W_HDW10=24,
832
833 **Result: **@W_HDW11=20.00(set two decimals)
834
835 == **ASin** ==
836
837 **Function**
838
839 val = ASin(A1)
840
841 **Description**
842
843 Calculate the arcsine value of A1.
844
845 **Parameters**
846
847 * **A1: **Float can be an address or variable.
848 * **Val: **Return float value, can be an address or variable.
849
850 **Example**
851
852 {{code language="lua"}}
853 Dim a, b as floating'define two float variable a,b
854
855 a = 0.5'assign the designated value to a
856
857 b=ASin(a) 'calculate the arcsine value of a ,assign the radian to b.
858
859 'Add the following command if need to view the return value:
860
861 float2d ("@W_HDW200", b) 'float variable b written into HDW200
862 {{/code}}
863
864 **Result: **@W_HDW200=0.524
865
866 (% class="box infomessage" %)
867 (((
868 **✎Note:** Pleasecall **RadToDeg** function to convert radian into angle.
869 )))
870
871 == **AsInteger** ==
872
873 **Function**
874
875 val = AsInteger(A1)
876
877 **Description**
878
879 Convert parameter A1 to integer value.
880
881 **Parameters**
882
883 * **A1: **floating need to be a variable.
884 * **Val: **the value returned could can be a variable or address.
885
886 **Example**
887
888 {{code language="lua"}}
889 Dim a as floating 'define floating variable a
890
891 a = D2Float("@W_HDW0",a) 'use D2Float function to save the float date of HDW0 in a
892
893 b= AsInteger(a) 'convert the float a into integer, the return value assigned to b
894
895 @W_HDW10=b 'save b to HDW10
896 {{/code}}
897
898 **Input:** @W_HDW0=20.12,
899
900 **Result:** @W_HDW10=20
901
902 == **AsString** ==
903
904 **Function**
905
906 val = AsString(A1)
907
908 **Description**
909
910 Convert parameter A1 to a character string.
911
912 **Parameters**
913
914 * A1: not string parameter, it can be a variable.
915 * Val: return string value, variable or address.
916
917 **Example**
918
919 Script 1:
920
921 {{code}}
922 a=123 'assign a value to a
923
924 b=234 'assign a value to b
925
926 c=AsString(a)+AsString(b) 'convert a and b to string then add up the two strings ,assign the result to c.
927
928 @W_HDW0=c 'assign c to HDW0
929
930 d=a+b 'plus a with b
931
932 @W_HDW100=d 'assign d to (HDW100)
933 {{/code}}
934
935 **Result: **
936
937 * @W_HDW0=123234
938 * @W_HDW100=357
939
940 Script 2:
941
942 {{code language="lua"}}
943 W2S("@W_HDW200","@W_HDW300","02d")
944
945 W2S("@W_HDW210","@W_HDW400","02d")
946
947 W2S("@W_HDW220","@W_HDW500","02d")
948
949 @W_HDW0=AsString(@W_HDW300)+AsString(@W_HDW400)+AsString(@W_HDW500)
950 {{/code}}
951
952 **Input: **@W_HDW200=12,@W_HDW210=34,@W_HDW220=56
953
954 **Result :**@W_HDW300=12,@W_HDW400=34,@W_HDW500=56,@W_HDW0=123456
955
956 (% class="box infomessage" %)
957 (((
958 **✎Note:** Ensure the data always is two words; otherwise occur error. reference the other chapter of W2S function
959 )))
960
961 == **ATan** ==
962
963 **Function**
964
965 var = ATan(A1)
966
967 **Description**
968
969 Return an arctangent value,the radian ranges -pi/2 to pi/2.
970
971 **Parameters**
972
973 * **A1: **Can be float, address or variable.
974 * **Val: **radian of return value.
975
976 **Example**
977
978 //{{code language="lua"}}@W_HDW20= Atan (@W_HDW10)'save the arctangent value of (HDW10) to (HDW20){{/code}}//
979
980 **Input: **@W_HDW10=1.000,@W_HDW20=0.785
981
982 (% class="box infomessage" %)
983 (((
984 **✎Note:** Please call RadToDeg function convert radian to angle.
985 )))
986
987 == **ATan2** ==
988
989 **Function**
990
991 val = ATan2(A1,A2)
992
993 **Description**
994
995 Return the arctangent value of A1/A2,radian range
996
997 **Parameters**
998
999 * **A1, A2:** Address or variable.
1000 * **Val: **returned value is a radian, range -pi to pi.
1001 * **Notice: **ATan2 use sign of two parameters to define the quadrant of return value.
1002
1003 **Example**
1004
1005 //{{code language="lua"}}@W_HDW20= ATan2 (@W_HDW10,@W_HDW12)'save the arctangent value of (HDW10/HDW12) to (HDW20).{{/code}}//
1006
1007 **Input:**@W_HDW10=1.0,@W_HDW12=1.0,
1008
1009 **Result: **@W_HDW20=0.785
1010
1011 (% class="box infomessage" %)
1012 (((
1013 **✎Note:** Please call **RadToDeg** function convert radian to angle.
1014 )))
1015
1016 == **B2W** ==
1017
1018 **Function**
1019
1020 B2W(A1, A2, length)
1021
1022 **Description**
1023
1024 Convert an array (begins with A2, unit: byte, to another array (begins with A1, unit: word).
1025
1026 **Parameters**
1027
1028 * **A1: **Saving address after converting
1029 * **A2: **Address of the value be converted 
1030 * **Length:** The length of conversion
1031
1032 **Return value: **None
1033
1034 **Example**
1035
1036 //{{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}}//
1037
1038 **Input: **@W_HDW10=1A2B
1039
1040 **Result: **
1041
1042 * @W_HDW100=2B
1043 * @W_HDW101=1A
1044
1045 (% class="box infomessage" %)
1046 (((
1047 **✎Note:**
1048
1049 * A1 and A2 need to be address(e.g.: @W_HDW000002);
1050 * Length could be address or variable;
1051 * This is a subprogram; it has no returned value.
1052 )))
1053
1054 == **BCD** ==
1055
1056 **Function**
1057
1058 val = BCD(A1)
1059
1060 **Description**
1061
1062 Convert A1(binary) to BCD, save the result as return value.
1063
1064 **Parameters**
1065
1066 * **A1: **The binary be converted; it can be an address or variable.
1067 * **Val: **Return value, BCD code; it can be an address or variable.
1068
1069 **Example**
1070
1071 //{{code language="lua"}}@W_HDW20=BCD(@W_HDW10) 'convert HDW10 (binary) to BCD code, then save in (HDW20){{/code}}//
1072
1073 **Input:** @W_HDW10=11111111(binary)
1074
1075 **Result:** @W_HDW20=255
1076
1077 (% class="box infomessage" %)
1078 (((
1079 **✎Note:** Return value is a word; it hexadecimal corresponds to BCD code.
1080 )))
1081
1082 == **Beep** ==
1083
1084 **Function**
1085
1086 Beep()
1087
1088 **Description**
1089
1090 Enable buzzer
1091
1092 **Parameters**
1093
1094 None
1095
1096 **Example**
1097
1098 {{code language="lua"}}
1099 if @B_HDX100.0=1 then 'beep when the bit switch HDX100.0 set ON
1100
1101 beep()
1102
1103 endif
1104 {{/code}}
1105
1106 **Result: **HMI beep when bit switch HDX100.0 set ON.
1107
1108 == **BIN** ==
1109
1110 **Function**
1111
1112 Val = BIN(A1)
1113
1114 **Description**
1115
1116 Convert A1 (BCD) into binary, save the result in return value.
1117
1118 **Parameters**
1119
1120 * **A1:** The BCD code is converted; it can be address or variable.
1121 * **Val:** Return binary value,it can be address or variable.
1122
1123 **Example**
1124
1125 //{{code language="lua"}}@W_HDW20=BIN(@W_HDW10) 'convert HDW10(BCD) to binary, save the result in (HDW20){{/code}}//
1126
1127 **Input:** @W_HDW10=255
1128
1129 **Result:** @W_HDW20=11111111 (binary)
1130
1131 == **BMOV** ==
1132
1133 **Function**
1134
1135 BMOV(A1, A2,length)
1136
1137 **Description**
1138
1139 Copy data with a designated length from source address A2 to A1.
1140
1141 **Parameter**
1142
1143 * **A1:** saving address;
1144 * **A2:** source address;
1145
1146 **length:** operating length;
1147
1148 **Example**
1149
1150 {{code language="lua"}}
1151 @W_HDW20 = 20 'assign value to HDW20
1152
1153 @W_HDW21 = 21 'assign value to HDW21
1154
1155 @W_HDW22 = 22 'assign value to HDW22
1156
1157 BMOV(@W_HDW10,@W_HDW20,3) 'assign the word address of HDW20, HDW21, HDW22 to HDW10, HDW11, HDW12
1158 {{/code}}
1159
1160 **Result:**
1161
1162 * @W_HDW10 = 20
1163 * @W_HDW11 = 21
1164 * @W_HDW12 = 22
1165
1166 **✎Note:**
1167
1168 * A1 and A2 need to be address
1169 * 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.
1170 * When destAddr and srcAddr are HMI addresses, the length range is 1-4096, and This function is invalid when out of range.
1171
1172 == **Chr** ==
1173
1174 **Function**
1175
1176 val = Chr(A1, A2, ...)
1177
1178 **Description**
1179
1180 Convert integer parameter into correspond ASCII character, return the character string.
1181
1182 **Parameters**
1183
1184 * **A1, A2....:** converted integer; it can be an address or variable.
1185 * **Val: **returned value, can be an address or variable.
1186
1187 **Example**
1188
1189 {{code language="lua"}}
1190 @W_HDW100=Chr(@W_HDW20, @W_HDW21, @W_HDW22, @W_HDW23, @W_HDW24)
1191
1192 'convert the value of(HDW20, HDW21 ,HDW22, HDW23, HDW24) to ASCII character, assign the value to (HDW100)
1193 {{/code}}
1194
1195 **Input** 72,69,76,76,79 step by step according to HDW20, HDW21, HDW22, HDW23, HDW24,
1196
1197 **Result: **returns HELLO to (@W_HDW100).
1198
1199 == **Clrb** ==
1200
1201 **Function**
1202
1203 ClrB(A1)
1204
1205 **Description**
1206
1207 Set the bit of A1 as FALSE (0).
1208
1209 **Parameters**
1210
1211 **A1:** System address(bit)
1212
1213 **✎Note:** subprogram has no return value.
1214
1215 **Example**
1216
1217 //{{code language="lua"}}ClrB(@B_HDX100.0) 'assign 0 to (@B_HDX100.0){{/code}}//
1218
1219 == **Constant** ==
1220
1221 **Description**
1222
1223 Script supported constant, users can use on script:
1224
1225 pi = 3.14159265358979321
1226
1227 TRUE = 1
1228
1229 FALSE = 0
1230
1231 **Example**
1232
1233 {{code language="lua"}}
1234 Dim a as integer 'define integer a
1235
1236 a = RadToDeg(pi) 'convert radian pi to angle then assign to a,RadToDeg function is used to convert radian to angle.
1237
1238 @W_HDW11 = a 'assign a to (HDW11)
1239 {{/code}}
1240
1241 **Result: **@W_HDW11=180
1242
1243 == **CopyFile** ==
1244
1245 **Function**
1246
1247 A6=CopyFile(A1,A2,A3,A4,A5)
1248
1249 **Description**
1250
1251 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.
1252
1253 **Parameters**
1254
1255 * **A1: **the source path of the file to be copied.
1256 * **A2: **target path.
1257 * **A3:** the name of the file to be copied.
1258 * **A4: **copy type (0: copy file, 1: copy directory).
1259 * **A5: **Whether to overwrite the file with the same name when copying (0: Yes, 1: No).
1260 * **A6: **returned value.
1261 ** 0: copy failed
1262 ** 1: copy succeeded
1263 ** 2: Parameter error
1264 ** 3: U disk does not exist
1265 ** 4: SD card does not exist
1266 ** 5: Path error
1267
1268 **Example**
1269
1270 Copy a single file:
1271
1272 {{code language="lua"}}
1273 @W_HDW100 = " test.csv"
1274
1275 CopyFile("UDisk/Test","Flash/Test","test.csv",0,0) 'Copy the Test.csv file in the UDisk/Test directory to the Flash/Test directory.
1276
1277 Can also be written as CopyFile("UDisk/Test","Flash/Test",@W_HDW100,0,0)
1278
1279 (2) Copy the entire directory file:
1280
1281 CopyFile("UDisk/Test","Flash/Test","",1,0) ' Copy the files in the UDisk/Test
1282
1283 directory to the Flash/Test directory.
1284 {{/code}}
1285
1286 (% class="box infomessage" %)
1287 (((
1288 **✎Note:**
1289
1290 * Both source and destination paths need to begin with UDisk or Flash or SDCard;
1291 * A1 and A2 could be string (requires double quotes) or variable, maximum character length 127 allowed in path;
1292 * A3 could be a string, such as: [FileName] (requires double quotes); or address, such as: @W_HDW100 (no need to add double quotes);
1293 * A4 and A5 could be values, addressesor variable;
1294 * A6 could be address or variable.
1295 )))
1296
1297 == **Cos** ==
1298
1299 **Function**
1300
1301 Val = Cos(A1)
1302
1303 **Description**
1304
1305 Return a cosine value of an angle.
1306
1307 **Parameters**
1308
1309 * **A1: **a float radian of angle, it can be an address or variable.
1310 * **Val: **return float value, it can be an address or variable.
1311
1312 **Example**
1313
1314 {{code language="lua"}}
1315 Dim a, b as floating 'define float a, b
1316
1317 b = pi/3 'convert the value of HDW11 to float and assign to 'b'.
1318
1319 a=Cos(b) 'return the cosine value of'b' and assign the result to 'a'.
1320
1321 'to add the following sentence if need to view the return value:
1322
1323 Float2D("@W_HDW20",a) 'the float value of a written into HDW13.
1324 {{/code}}
1325
1326 **Result: **@W_HDW20=0.5
1327
1328 (% class="box infomessage" %)
1329 (((
1330 **✎Note:** Please call **RadToDeg** function convert radian to angle.
1331 )))
1332
1333 == **D2F** ==
1334
1335 **Function**
1336
1337 D2F (A1, A2) or A1= D2F (A1, A2)
1338
1339 **Description**
1340
1341 Convert the 32-bit integer format data to float then output the result.
1342
1343 **Parameters**
1344
1345 * **A1: **required data, begin with"@";
1346 * **A2: **source data, begin with"@";
1347
1348 **Example**
1349
1350 {{code language="lua"}}
1351 D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).
1352
1353 @W_HDW2=D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).
1354 {{/code}}
1355
1356 **Result: **HDW0=100, HDW2=100
1357
1358 == **D2Float** ==
1359
1360 **Function**
1361
1362 F= D2Float("A1",F)
1363
1364 **Description**
1365
1366 Convert the designated value to floating then assign to variable.
1367
1368 **Parameters**
1369
1370 * **A1:** Source data;
1371 * **F:** User-defined floating variable
1372
1373 **Example**
1374
1375 {{code language="lua"}}
1376 dim F as floating 'define F as floating
1377
1378 F=D2Float("@W_HDW10",F) 'assign the value of (HDW10) to F in floating
1379
1380 Float2D("@W_HDW12",F) 'copy the floating value of F to HDW12 register,use to display result.
1381 {{/code}}
1382
1383 **Result: **
1384
1385 * HDW10=200,
1386 * HDW12=200.
1387
1388 (% class="box infomessage" %)
1389 (((
1390 **✎Note:** A1 needs to be address;
1391 )))
1392
1393 == **D2Int** ==
1394
1395 **Function**
1396
1397 A2= D2Float("A1",A2)
1398
1399 **Description**
1400
1401 Output the 32-bit integer in the form of integer.
1402
1403 **Parameters**
1404
1405 * **A1:** Source data can only be the HMI internal or external register starting with "@".
1406 * **A2: **Target data can only use theinteger variable defined by script.
1407
1408 **Example**
1409
1410 {{code language="lua"}}
1411 dim  var1 as integer 'define var1 as integer
1412
1413 var1=D2Int("@W_HDW0",var1) 'Read out the 32-bit integer in HDW0 and save the result in var1.
1414
1415 HDW0=9999999,
1416 {{/code}}
1417
1418 **Result:** Var1=9999999
1419
1420 == **DbToCSVFile** ==
1421
1422 **Function**
1423
1424 A8=DbToCSVFile(A1,A2,A3,A4,A5,A6,A7)
1425
1426 **Description**
1427
1428 Convert db (database file) file to csv format and export it.
1429
1430 **Parameters**
1431
1432 * **A1: **db file save path (value is integer);
1433 ** =0: Alarm record file in HMI flash;
1434 ** =1: Alarm record file in UDisk (USB flash disk);
1435 ** =2: Alarm record file in SD card;
1436 ** =3: Data record file in HMI flash;
1437 ** =4: Data record file in UDisk (USB flash disk);
1438 ** =5: Data record file in SD card;
1439 * **A2: **group numer of db file (value is integer);
1440 ** Used during exporting data record file, the group number could be seen in the data record setting interface;
1441 * **A3:** csv file save path (value is integer);
1442 ** =0: Save in UDisk (USB flash disk);
1443 ** =1: Save in SD card;
1444 * **A4: **csv name;
1445 * **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);
1446 * **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);
1447 * **A7:** csv encoding format;
1448 ** =0 UTF8 format;
1449 ** =1 GBK format;
1450 ** **A8:** returned value;
1451 ** =0: Failed to export;
1452 ** =1: Exported;
1453 ** =2: db file path error;
1454 ** =3: U disk or SD card does not exist;
1455 ** =4: csv name error;
1456 ** =5: db file does not exist;
1457 ** =6: csv file already exists;
1458
1459 **Example**
1460
1461 * @W_HDW100 = 2018
1462 * @W_HDW101 = 12
1463 * @W_HDW102 = 25
1464 * @W_HDW103 = 19
1465 * @W_HDW104 = 10
1466 * @W_HDW105 = 30
1467 * @W_HDW200 = 2018
1468 * @W_HDW201 = 12
1469 * @W_HDW202 = 25
1470 * @W_HDW203 = 20
1471 * @W_HDW204 = 10
1472 * @W_HDW205 = 30
1473
1474 **Export data record file**
1475
1476 (% class="box" %)
1477 (((
1478 //DbToCsvFile(3,2,0,"123.csv","@W_HDW100","@W_HDW200",0)‘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 are exported to the 123.csv file in the Udisk in UTF8 format.//
1479 )))
1480
1481 **Export alarm record file**
1482
1483 (% class="box" %)
1484 (((
1485 //DbToCsvFile(0,0,0,"456.csv","@W_HDW100","@W_HDW200",1)‘The alarm records generated in HMI Flash at 2018.12.25 19:10:30-2018.12.25 20:10:30 are exported to the 456.csv file in the Udisk in GBK format.//
1486 )))
1487
1488 (% class="box infomessage" %)
1489 (((
1490 **✎Note:**
1491
1492 * A1 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;
1493 * A2 can be an address or a variable or a value;
1494 * A3 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;
1495 * 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;
1496 * A5 need to be an address;
1497 * A6 need to be an address;
1498 * A7 can be an address or a variable or a value;
1499 )))
1500
1501 == **DegToRad** ==
1502
1503 **Function**
1504
1505 A2 = DegToRad(A1)
1506
1507 **Description**
1508
1509 Convert the angle into correspond radian, and display.
1510
1511 **Parameters**
1512
1513 * **A1:** inputting angle supports address, other variable or floating.
1514 * **A2: **outputting radian supports address, other variable or floating.
1515
1516 **Example**
1517
1518 Script 1
1519
1520 //{{code language="lua"}}@W_HDW12=DegToRad(@W_HDW10) 'input angle on (HDW10),convert to correspond redian and copy to (HDW12){{/code}}//
1521
1522 **Result: **HDW10=180; HDW12=3.14159
1523
1524 Script 2
1525
1526 {{code language="lua"}}
1527 dim a as floating 'set variable
1528
1529 dim b as floating 'set variable
1530
1531 b=30 'input angle
1532
1533 a=DegToRad(b) 'convert the length of radian and copy to variable {a}
1534
1535 float2d("@W_HDW0", a) 'display the value of floating on(HDW0)
1536 {{/code}}
1537
1538 **Result:** HDW0=0.52360
1539
1540 == **DIM ... AS ...** ==
1541
1542 **Function**
1543
1544 Dim "variable" as "date type"
1545
1546 **Description**
1547
1548 Declare a variable, stable the type of data.
1549
1550 **Parameters**
1551
1552 * **Variable: **begin with letter, other character can be letter, numbers, underscores ('_'), need to begin with '@' if it is address;
1553 * **Data type: **string,floating,integer;
1554
1555 **Example**
1556
1557 {{code language="lua"}}
1558 dim a as integer 'define a as integer
1559
1560 dim @W_HDW0 as floating 'define @W_HDW0 as floating
1561
1562 dim hi as string 'define "hi" as string
1563 {{/code}}
1564
1565 **Result:**
1566
1567 a is integer
1568
1569 @W_HDW0 is floating
1570
1571 hi is string
1572
1573 (% class="box infomessage" %)
1574 (((
1575 **✎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.
1576 )))
1577
1578 == **DO ... LOOP** ==
1579
1580 **Function**
1581
1582 Do [While | Until condition]
1583
1584 [statements]
1585
1586 Loop
1587
1588 or
1589
1590 Do
1591
1592 [statements]
1593
1594 Loop [While | Until condition]
1595
1596 **Description**
1597
1598 Condition determent instruction.
1599
1600 * Do while.loop executes an instruction of block repeatedly when condition is true.
1601 * Do until.loop executes an instruction of block repeatedly until condition is false.
1602
1603 **Parameters**
1604
1605 **Condition: **determine condition; obtain the expression of True or False.
1606
1607 **Statements: **execute one or more instructions repeatedly when condition is True or until condition is True.
1608
1609 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.
1610
1611 **Example**
1612
1613 {{code language="lua"}}
1614 dim i as integer 'end DO loop when i=100
1615
1616 do while i<100
1617
1618 i=i+1
1619
1620 @W_HDW0=i
1621
1622 loop
1623 {{/code}}
1624
1625 **Result: **HDW0=100
1626
1627 == **End** ==
1628
1629 **Function**
1630
1631 Terminates the script immediately.
1632
1633 **Description**
1634
1635 End the execution of script.
1636
1637 **Parameters**
1638
1639 **Statement:** Judging condition, use with IF together. end script when meet condition.
1640
1641 **Example**
1642
1643 //{{code language="lua"}}If a = 10 Then End 'end script when a=10.{{/code}}//
1644
1645 **Result:** End the script program.
1646
1647 == **Exp** ==
1648
1649 **Function**
1650
1651 A1=Exp(A2)
1652
1653 **Description**
1654
1655 Returns the power value of e (natural logarithm), save the outputting result to A1, e=2.71828182846.
1656
1657 **Parameters**
1658
1659 * **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]](%%));
1660 * **A2: **Source data, natural exponential function, need to be integer or variable. Could not not begin with the address of "@"(e.g.@W_HDW10)
1661
1662 **Example**
1663
1664 {{code language="lua"}}
1665 dim a as integer'define a as integer
1666
1667 a = @W_HDW2 ' assign the value of (HDW2) to variable a
1668
1669 @W_HDW0= Exp(a)'exponential is the value of (HDW2),save result to(HDW0)
1670 {{/code}}
1671
1672 **Result:**
1673
1674 * HDW2=2,
1675 * HDW0=7.38905600
1676
1677 == **F2D** ==
1678
1679 **Function**
1680
1681 F2D (A1, A2)
1682
1683 **Description**
1684
1685 Convert a 32 bit floating to integer format, then output the result.
1686
1687 **Parameters**
1688
1689 * **A1: **Destination, the value can be an address(e.g.@W_HDW12).
1690 * **A2: **source date, it can be an address or other variable.
1691
1692 **Example**
1693
1694 //{{code language="lua"}}F2D(@W_HDW12,@W_HDW10) 'convert the floating of (HDW10) to integer, save in (HDW12).{{/code}}//
1695
1696 **Result:**
1697
1698 * HDW10=200,
1699 * HDW12=200
1700
1701 == **F2S** ==
1702
1703 **Function**
1704
1705 F2S (A1,A2,s1)
1706
1707 **Description**
1708
1709 Output a format of floating that in the type of string.
1710
1711 **Parameters**
1712
1713 * **A1:** Source address, used to store floating, the value is an address(e.g.@W_HDW200);
1714 * **A2:** Destination address, used to store string after converted, value is an address(e.g.@W_HDW100).
1715 * **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.
1716
1717 **Example**
1718
1719 //{{code language="lua"}}F2S("@W_HDW200", "@W_HDW100", "03.03f") '(HDW200) is floating input,(HDW100) is text output;{{/code}}//
1720
1721 **Result: **
1722
1723 * HDW200=1.22365,
1724 * HDW100=1.224
1725
1726 == **FileCmpDir** ==
1727
1728 **Function**
1729
1730 FileCmpDir(A1, A2, A3, A4, A5, A6, A7, A8, A9)
1731
1732 **Description**
1733
1734 The filename input and the filename in the folder whether is duplicate or not.
1735
1736 **Parameters**
1737
1738 A1: file path (value is integer);
1739
1740 In HMI:
1741
1742 * =0: Recipe folder in HMI flash;
1743 * =1: Custom folder in UDisk (USB flash disk);
1744 * =2: Custom folder in SD card.
1745 * =3: Custom folder in HMI flash;
1746
1747 In simulator:
1748
1749 * = 0: D:/Recipe/
1750 * = 1: C:/WECON/CustomFileDir/
1751 * = 2: C:/WECON/CustomFileDir/
1752 * = 3: C:/WECON/CustomFileDir/
1753
1754 **✎Note:**
1755
1756 A1 can be an address,variable or fixed value.
1757
1758 A2: file name (value is string);
1759
1760 The file name would be compared;
1761
1762 **✎Note: **
1763
1764 A2 can be an address, variable or string. The length of file name cannot exceed 32 characters.
1765
1766 A3: folder name (value is integer);
1767
1768 The folder name would be compared;
1769
1770 **✎Note: **
1771
1772 A3 can be an address, variable or string. The length of file name cannot exceed 32 characters.
1773
1774 A4:file name display address (value is a string);
1775
1776 Display the specified number of file names in the specified folder.
1777
1778 **✎Note:**
1779
1780 A4 Can only use address here. And the length of the file name cannot exceed 32 characters.
1781
1782 A5: Function type (value is an integer)
1783
1784 ~= 0: compare whether the file name in the folder and the file name input are duplicated or not.
1785
1786 ~= 1: return list of file names.
1787
1788 ~= 100: compare file names, without input suffix .csv
1789
1790 **✎Note: **
1791
1792 A5 can be an address, variable or value.
1793
1794 A6: Return value (value is an integer)
1795
1796 ~= 1: Successfully opened the folder.
1797
1798 ~= 2: Failed to open the folder.
1799
1800 ~= 3: The file has duplicate names
1801
1802 **✎Note:**
1803
1804 A6 must be an address.
1805
1806 A7: File number (value is an integer)
1807
1808 Display the number of files in the folder (up to 100)
1809
1810 **✎Note: **
1811
1812 A7 must be an address.
1813
1814 A8: File creation time (value is a string);
1815
1816 Display the time of file creation, time occupies 32 characters
1817
1818 A9: The maximum number of files to read (value is an integer)
1819
1820 Set the maximum number of files to read (up to 100 files)
1821
1822 **✎Note:** A9 can be an address, variable or value.
1823
1824 **Example**
1825
1826 Read the specified number of files in the folder.
1827
1828 (% class="box" %)
1829 (((
1830 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.
1831 )))
1832
1833 Compare filename input and the filename in the folder whether is duplicate or not.
1834
1835 (% class="box" %)
1836 (((
1837 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
1838 )))
1839
1840 Compare the csv file name in the folder and the csv file name input whether is duplicated or not.
1841
1842 (% class="box" %)
1843 (((
1844 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
1845 )))
1846
1847 == **FILL** ==
1848
1849 **Function**
1850
1851 FILL (A1, A2, A3)
1852
1853 **Description**
1854
1855 Write the same value to designated address constantly.
1856
1857 **Parameters**
1858
1859 **A1:** The beginning address, it can be an address (e.g.@ W_ HDW25);
1860
1861 **A2:** Source data, it needs to be written in continuous value, the value can be an address, variable or constant;
1862
1863 **A3:** The number of operation, writing address number, it can be an address, variable or constant;
1864
1865 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.
1866
1867 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.
1868
1869 **Example**
1870
1871 //FILL (@W_HDW25, 10, 3) 'At the beginning three address of @W_ HDW25 is 10.//
1872
1873 **Result: **At the beginning three address of @W_ HDW25 is 10, @W_ HDW25=10, @W_ HDW26=10, @W_ HDW27=10.
1874
1875 == **Float2D** ==
1876
1877 **Function**
1878
1879 Float2D (A1,A2);
1880
1881 **Description**
1882
1883 Copy floating value to the address.
1884
1885 **Parameters**
1886
1887 * **A1: **Goal address, the value need to be address (e.g.@W_HDW102);
1888 * **A2:** Source data, it can be floating;
1889
1890 **Example**
1891
1892 {{code language="lua"}}
1893 dim f as floating 'define f as floating
1894
1895 f=1.1 'assign a designated value to f
1896
1897 Float2D ("@W_HDW102",f) 'assign the value f to HDW102
1898 {{/code}}
1899
1900 **Result:** HDW102=1.1
1901
1902 == **For. to. step. next** ==
1903
1904 **Function**
1905
1906 For counter = start to end Step
1907
1908 [Statements]
1909
1910 Next
1911
1912 **Description**
1913
1914 Execute a command repeatedly for designated times.
1915
1916 **Parameters**
1917
1918 * **counter: **Work as a variable for loop counter;
1919 * **start: **The start value of counter, it could be any variable type or expression;
1920 * **end: **The end value of counter, it could be any variable type or expression;
1921 * **step: **Every loop, the changed value of counter is step value, step default if it is not designation. Step default as below:
1922 ** if start>end, step default is 1;
1923 ** if start< end. It could be any variable type or expression;
1924 * **statements: **Between For with Next, execute instruction set of designated times;
1925 ** 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.
1926
1927 **Example**
1928
1929 {{code language="lua"}}
1930 'Use HDX2.0 to trigger the loop
1931
1932 for i=100 to 0 step -5 ' set the start is 100,end is 0,subtract 5 every time, execute 20 times totally.
1933
1934 @W_HDW100=@W_HDW100+1 ' execute (HDW100+1) 21 times totally, the final result is 21.
1935
1936 Next
1937
1938 @B_HDX2.0=0
1939 {{/code}}
1940
1941 **Result: **HDW100=21
1942
1943 == **Function** ==
1944
1945 **Function**
1946
1947 * Function name (arglist)
1948 * statements
1949 * name = expression
1950 * statements
1951 * End Function
1952
1953 **Description**
1954
1955 Unlike internal function, it needs to declare the name, parameter, code of the function.
1956
1957 **Parameters**
1958
1959 * **Name: **function name.
1960 * **arglist: **stands for the variable list of parameter, this parameter will be entered during calling function. use comma to separate.
1961 * **statements: **a set of code in running function body.
1962
1963 **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.
1964
1965 **Example**
1966
1967 {{code language="lua"}}
1968 Function sincos (angle as floating)
1969
1970 sincos = sin(angle) + cos(angle)
1971
1972 End Function<
1973
1974 ........
1975
1976 @W_0002 = sincos(pi/2)
1977
1978 ........
1979 {{/code}}
1980
1981 == **GetServerDelayInfo** ==
1982
1983 **Function**
1984
1985 A3=GetSerVerDelayInfo(A1,A2)
1986
1987 **Description**
1988
1989 Convert string A1 to hexadecimal number.
1990
1991 **Parameters**
1992
1993 **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).
1994
1995 (% class="table-bordered" %)
1996 |=**Address**|=**Description**
1997 |A1|Delay data of the server configured in [Project Settings]
1998 |A1+1|Delay data of Server 1
1999 |A1+2|Delay data of Server 2
2000
2001 **A2: **Server test result address
2002
2003 (% class="table-bordered" %)
2004 |=(% style="width: 239px;" %)**Address**|=(% style="width: 1250px;" %)**Description**
2005 |(% style="width:239px" %)0 bit|(% style="width:1250px" %)Set ON, Server configured in [Project Settings] fails
2006 |(% style="width:239px" %)1^^st^^bit|(% style="width:1250px" %)Set ON, Server 1 fails
2007 |(% style="width:239px" %)2^^nd^^bit|(% style="width:1250px" %)Set ON, Server 2 fails
2008 |(% style="width:239px" %)3^^rd^^~~ 10^^th^^bits|(% style="width:1250px" %)Reserved
2009 |(% style="width:239px" %)11^^th^^bit|(% style="width:1250px" %)Set ON, network error, network port interface failure
2010
2011 **A3:**Returns the preferred server number or network status (automatically selects the server with the best connection network status).
2012
2013 * =0: Server configured in [Project Settings];
2014 * =1: Server 1;
2015 * =2: Server 2;
2016 * =3~~10: Reserved;
2017 * =100: Try again later (two test intervals need to wait 30 seconds);
2018 * =101: Failed to test Server;
2019
2020 **Example**
2021
2022 //{{code language="lua"}}@W_HDW200 = GetServerDelayInfo("@W_HDW100", "@W_HDW50"){{/code}}//
2023
2024 Result:
2025
2026 * HDW100: Delay data of the server configured in [Project Settings]
2027 * HDW101: Delay data of Server 1
2028 * HDW102: Delay data of Server 2
2029 * HDX50.0=1:Server configured in [Project Settings] fails
2030 * HDX50.1=1: Server 1 fails
2031 * HDX50.2=1:Server 2 fails;
2032 * HDX50.11= 1: network error, network port interface failure;
2033
2034 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.
2035
2036 (% class="box infomessage" %)
2037 (((
2038 **✎Note:** The time interval between executions of this function could not be less than 30 seconds, otherwise an error will occur.
2039 )))
2040
2041 == **Goto** ==
2042
2043 **Function**
2044
2045 Goto label
2046
2047 **Description**
2048
2049 Go to the designated row without any condition in a function body.
2050
2051 **Parameters**
2052
2053 * **Label:** target character, start with letter in row label, end with(:)of any string.row label has no sensitive to the format of letter.
2054
2055 **Example**
2056
2057 //Goto sd 'go to the row which start with "sd";//
2058
2059 **Result:** Go to sd row.
2060
2061 (% class="box infomessage" %)
2062 (((
2063 **✎Note:** Goto only can jump into the internal function that visible row.
2064 )))
2065
2066 == **H2A** ==
2067
2068 **Function**
2069
2070 A1 = H2A (A2)
2071
2072 **Description**
2073
2074 Convert a binary (16-bit) to hexadecimals (4-bit) of ASCII.
2075
2076 **Parameters**
2077
2078 * **A1: **Returned value, string, it could be an address or variable.
2079 * **A2: **Binary is needed to be converted, the value could be a address or variable.
2080
2081 **Example**
2082
2083 //{{code language="lua"}}@W_HDW100= H2A (@W_HDW0) ' convert the binary of (HDW0) to character and save in (HDW100).{{/code}}//
2084
2085 **Result:**
2086
2087 * HDW0=200,
2088 * HDW=100
2089
2090 == **HmiRegoperator** ==
2091
2092 **Function**
2093
2094 HmiRegoperator (A1,A2,A3,A4,A5,A6)
2095
2096 **Description**
2097
2098 Data of Upload/ Download address
2099
2100 **Parameters**
2101
2102 * **A1: **The start address of target
2103 * **A2: **Length, address length, unit: word, range: 1~~1000
2104 * **A3: s**torage
2105 ** A3=0, select USB flash disk as storage, and save files in Root directory;
2106 ** A3=1, select SD card as storage, and save files in Root directory;
2107 * **A4: **File name address, itneed to be address such as"@ W_HDW2"
2108 * **A5**: Upload / download data
2109 ** A5=0, save the data in the specified address as a file and store the file in the root directory;
2110 ** A5=1, Read data from file and it woule be written into specified address;
2111 * **A6:** State display, it needs to be address, such as "@ W_HDW2";
2112 ** A6=1, Normal
2113 ** A6=2, USB flash disk/ SD card does not exist
2114 ** A6=3, File doesn’t exist;
2115 ** A6=4, File name error;
2116 ** A6=5, Check error
2117 ** A6=6, Abnormal communication;
2118 ** A6=7, HUW register is not allowed;
2119 ** A6=8, Address length range error (address length range: 1-1000);
2120
2121 **Example**
2122
2123 Script 1
2124
2125 (% class="box" %)
2126 (((
2127 //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.//
2128 )))
2129
2130 Script 2
2131
2132 (% class="box" %)
2133 (((
2134 //HmiRegoperator("@W_HDW0",10,1,"@W_HDW2000",1,"@W_HDW3000")//
2135
2136 //Read the values from files which stored in the SD card (files named by the HDW2000), and write these values to the HDW0-HDW10.//
2137 )))
2138
2139 **✎Note:**
2140
2141 * 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).
2142 * The interval of download function operation should be 5s or more.
2143 * A1 need to be address such as “@W_HDW2”.
2144 * 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.
2145
2146 == **Hypot** ==
2147
2148 **Function**
2149
2150 Var = Hypot (expr1, expr2)
2151
2152 **Description**
2153
2154 Calculate the value of the hypotenuse of a right triangle.
2155
2156 **Parameters**
2157
2158 * **expr1, expr2: **Source data, the two sides of right triangle. it need to be address;
2159 * **Var:** Destination data,it need to be address;
2160
2161 **Example**
2162
2163 (% class="box" %)
2164 (((
2165 //@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).//
2166 )))
2167
2168 **Result: **
2169
2170 * HDW105=3,
2171 * HDW108=4,
2172 * HDW200=5
2173
2174 (% class="box infomessage" %)
2175 (((
2176 **✎Note:** hypot function could support integer and floating when the format of source data and target data are the same.
2177 )))
2178
2179 == **IF ... THEN ... ELSE ... END IF** ==
2180
2181 **Function**
2182
2183 If condition Then
2184
2185 Statements
2186
2187 [Else
2188
2189 else statements]
2190
2191 End If
2192
2193 **Description**
2194
2195 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.
2196
2197 **Parameters**
2198
2199 * **condition: **any expression, the value could be true or false.
2200 * **statement: **execute the instruction block when condition is true.
2201 * **else statement: **execute the instruction block when condition is false.
2202
2203 **Example**
2204
2205 {{code language="lua"}}
2206 if @W_HDW105=200 then ' judging condition: whether the value of (HDW105) is 200
2207
2208 @W_HDW108=1 'the value of (HDW108) is 1 if fulfil condition
2209
2210 else
2211
2212 @W_HDW200=1 ' the value of (HDW200) is 1 if not fulfil condition.
2213
2214 Endif
2215 {{/code}}
2216
2217 **Result:**
2218
2219 * HDW105=199;
2220 * HDW108=0;
2221 * HDW200=1
2222
2223 == **InStr** ==
2224
2225 **Function**
2226
2227 var = InStr ("str1", "str2")
2228
2229 **Description**
2230
2231 Returned the position of str1 in str2(start with 0), set -1 if no result.
2232
2233 **Parameters**
2234
2235 * **str1:** source string, it could only be string, not address;
2236 * **str2:** target string, it could only be string, not address;
2237 * **var:** Returned value, the format of data needs to be string;
2238
2239 **Example**
2240
2241 {{code language="lua"}}
2242 dim a as floating
2243
2244 a = InStr ("Hello", "o") ' calculate the position of"o"in"hello".
2245
2246 float2d ("@W_HDW0",a) ' Returned value is 4.(start with 0)
2247 {{/code}}
2248
2249 **Result:** HDW0=4
2250
2251 == **Int2D** ==
2252
2253 **Function**
2254
2255 Int2D("A1",A2)
2256
2257 **Description**
2258
2259 Write the 32-bit integer into the target address
2260
2261 **Parameters**
2262
2263 * **A1: **Source data could only be the HMI internal or external register starting with "@".
2264 * **A2:** Target data could only use the integer variable defined by script.
2265
2266 **Example**
2267
2268 {{code language="lua"}}
2269 dim var1 as integer 'define var1 as integer
2270
2271 Int2D("@W_HDW0", var1)    'Read out the 32-bit integer in var1 and save the result in HDW0 .
2272
2273  var1=9999999,
2274 {{/code}}
2275
2276 **Result:** HDW0=9999999.
2277
2278 == **InvB** ==
2279
2280 **Function**
2281
2282 InvB (A1)
2283
2284 **Description**
2285
2286 The state of inverse bit, it is a sub function, no returned value. Achieve the state of switching address constantly.
2287
2288 **Parameters**
2289
2290 * **A1:** it is an address.
2291
2292 **Example**
2293
2294 //{{code language="lua"}}InvB (@B_HDX0.1) 'switch the state if (HDX0.1).{{/code}}//
2295
2296 **Result: **Switch the state of (HDX0.1) constantly.
2297
2298 == **IsFloating** ==
2299
2300 **Function**
2301
2302 A2=IsFloating (A1)
2303
2304 **Description**
2305
2306 Decide whether a parameter is floating, return true if it is floating, otherwise return FALSE.
2307
2308 **Parameter**
2309
2310 * **A1:** source data, variable;
2311 * **A2:** target data, variable;
2312
2313 **Example**
2314
2315 {{code language="lua"}}
2316 dim a as integer
2317
2318 dim b as floating
2319
2320 b= D2float ("@W_HDW200",b) 'assign the value of (HDW200) to b
2321
2322 a = IsFloating (b) 'judge whether b is floating or not
2323
2324 @W_HDW300=a 'save the result to (HDW300)
2325 {{/code}}
2326
2327 **Result: **HDW300=1
2328
2329 == **IsInteger** ==
2330
2331 **Function**
2332
2333 A2= IsInteger (A1)
2334
2335 **Description**
2336
2337 Determine whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE.
2338
2339 **Parameter**
2340
2341 * **A1:** Source date, it is variable or number;
2342 * **A2:** Target date, need to be variable, it could not be system address ;
2343
2344 **Example**
2345
2346 {{code language="lua"}}
2347 dim a as integer
2348
2349 a = IsInteger (20) 'determine whether 20 is integer
2350
2351 @W_HDW300=a ' display the result on (HDW300)
2352 {{/code}}
2353
2354 **Result:** HDW300=1
2355
2356 == **IsString** ==
2357
2358 **Function**
2359
2360 val = IsString(expr)
2361
2362 **Description**
2363
2364 Determine whether a parameter is string, return TRUE if it is string, otherwise return FALSE.
2365
2366 **Parameters**
2367
2368 * **Expr:** source string, it could be a variable or string, not address;
2369 * **Val:** target date, the result need to be variable, could not be address;
2370
2371 **Example**
2372
2373 {{code language="lua"}}
2374 dim a as integer 'define variable, display the result;
2375
2376 a= isstring ("hello") 'determine whether"hello"is string;
2377
2378 @W_HDW0=a 'assign the result to (HDW0)
2379 {{/code}}
2380
2381 **Result: **HDW=1
2382
2383 == **Lcase** ==
2384
2385 **Function**
2386
2387 A2 = LCase(A1)
2388
2389 **Description**
2390
2391 Convert all parameters to lowercase strings.
2392
2393 **Parameters**
2394
2395 * **A1: **source string, it could be an address or variable;
2396 * **A2: **outputting string, it could be an address or variable;
2397
2398 **Example**
2399
2400 (% class="box" %)
2401 (((
2402 //@W_HDW33 = LCase (@W_HDW25) 'input source sting on (HDW25), convert it to destination string and display the result on (HDW33);//
2403 )))
2404
2405 **Result:** HDW25=HELLO
2406
2407 HDW33=hello
2408
2409 == **Left** ==
2410
2411 **Function**
2412
2413 Val =Left (String, Length)
2414
2415 **Description**
2416
2417 Return a string of the specified length from the left side of parameter.
2418
2419 **Parameters**
2420
2421 * **String:** source string; it could be an address or string.
2422 * **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.
2423 * **Val: **destination string, outputting string, it could be an address or variable.
2424
2425 **Example**
2426
2427 (% class="box" %)
2428 (((
2429 //@W_HDW30=Left (@W_HDW36, @W_HDW40) '(HDW36) used to input source string,(HDW30) used to display the string result;//
2430 )))
2431
2432 Result:
2433
2434 * HDW36=hello,
2435 * HDW40=2,
2436 * HDW30=he
2437
2438 == **Len** ==
2439
2440 **Function**
2441
2442 Length=Len(String)
2443
2444 **Description**
2445
2446 Return the string length.
2447
2448 **Parameters**
2449
2450 * **String:** source string, it could be a address or string;
2451 * **Length:** target data, return value, it could be a address, variable, integer or floating;
2452
2453 **Example**
2454
2455 //{{code language="lua"}}@W_HDW30=Len (@W_HDW36) 'count the character number of (HDW36), save the result to (HDW30);{{/code}}//
2456
2457 **Result:**
2458
2459 * HDW36=hello
2460 * HDW30=5
2461
2462 == **Log** ==
2463
2464 **Function**
2465
2466 a= Logn (x)=Log(x)/Log(n)
2467
2468 **Description**
2469
2470 Log function:return the natural logarithm of the value.
2471
2472 **Parameters**
2473
2474 * **a: **source date,it could be a variable, but it could not be address;
2475 * **x, n:** source date, it could be a variable, but it could not be address;
2476
2477 **Example**
2478
2479 {{code language="lua"}}
2480 Dim a as integer 'define a as integer;
2481
2482 Dim b as integer 'define b as integer;
2483
2484 Dim c as integer 'define c as integer;
2485
2486 b=@W_HDW10 'assigns a value to b
2487
2488 c=@W_HDW20 'assigns a value to c
2489
2490 a=Log (b)/Log(c) 'calculate logarithm
2491
2492 @W_HDW0
2493
2494 =a 'assign the result to (HDW0)
2495 {{/code}}
2496
2497 **Result:**
2498
2499 * HDW10=27,
2500 * HDW20=3,
2501 * HDW0=3
2502
2503 == **Log10** ==
2504
2505 **Function**
2506
2507 a=Log10(x)= Log(x) / Log(10)
2508
2509 **Description**
2510
2511 Log function: return the natural logarithm.
2512
2513 **Parameters**
2514
2515 * **A:** target data, result could be variable, could not be address;
2516 * **x:** source data, it could be variable that needs to be the multiples of 10, can’t be address
2517
2518 **Example**
2519
2520 {{code language="lua"}}
2521 dim a as integer 'define a as integer
2522
2523 dim b as integer 'define b as integer
2524
2525 b=@W_HDW10 'assign a value to b
2526
2527 a= Log (b)/Log(10) 'result
2528
2529 @W_HDW0=a 'assign the result to (HDW0)
2530 {{/code}}
2531
2532 **Result: **
2533
2534 * HDW10=100,
2535 * HDW0=2
2536
2537 == **LTrim** ==
2538
2539 **Function**
2540
2541 val=LTrim("string")
2542
2543 **Description**
2544
2545 Remove the left empty part of the string and return.
2546
2547 **Parameters**
2548
2549 * **Val:** Destination string, it could be either a variable or address;
2550 * **string:** Source string, it could be either a variable or address;
2551
2552 **Example**
2553
2554 {{code language="lua"}}
2555 dim a as string
2556
2557 a=Ltrim("hello")
2558
2559 @W_HDW103=a
2560 {{/code}}
2561
2562 **Result:** HDW103=hello
2563
2564 == **MAX** ==
2565
2566 **Function**
2567
2568 A1=MAX(A2,A3)
2569
2570 **Description**
2571
2572 Compare the value of A2 and A3, assign the greater value to A1.
2573
2574 **Parameters**
2575
2576 * **A1:** Return value (used to store the greater value between A2 with A3).
2577 * **A2:** The first comparison value.
2578 * **A3:** The second comparison value.
2579
2580 (% class="box infomessage" %)
2581 (((
2582 **✎Note:** A1,A2,A3 should be only used in unsigned integer or unsigned address.
2583 )))
2584
2585 **Example**
2586
2587 {{code language="lua"}}
2588 DIM A1 as integer
2589
2590 @W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.
2591
2592 @W_HDW107=5 'assign the value to (?@W_HDW107),unsigned decimal word.
2593
2594 A1 = Max(@W_HDW106,@W_HDW107)
2595
2596 @W_HDW105 = A1
2597 {{/code}}
2598
2599 **Result: **@W_HDW105 = 10
2600
2601 == **Mid** ==
2602
2603 **Function**
2604
2605 A1=mid(A2, start, length)
2606
2607 **Description**
2608
2609 Returns a string contain a specified characters length from a string.
2610
2611 **Parameters**
2612
2613 * **A1:** string contains the selected characters, it needs to be a string
2614 * **A2:** string to be selected, it needs to be a variable or address
2615 * **Start:** the start position of string, it needs to be a variable or address, it means that count begin with 0.
2616 * **Length:** the designated length of string, maximum character length 127 allowed
2617
2618 **Example**
2619
2620 {{code language="lua"}}
2621 DIM A1 as string
2622
2623 A1 = Mid("hellokitty",1,2) 'select the string of in "
2624
2625 @W_HDW106=A1
2626 {{/code}}
2627
2628 **Result: **@W_HDW106 'display "el" on text input and output window
2629
2630 == **MIN** ==
2631
2632 **Function**
2633
2634 A1=MIN(A2,A3)
2635
2636 **Description**
2637
2638 Compare the value of A2 and A3, assign the smaller value to A1.
2639
2640 **Parameters**
2641
2642 * **A1: **Return value (used to store the snaker value between A2 with A3).
2643 * **A2: **The first comparison value.
2644 * **A3: **The second comparison value.
2645
2646 **Example**
2647
2648 {{code language="lua"}}
2649 DIM A1 as integer
2650
2651 @W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.
2652
2653 @W_HDW107=5 'assign the value to (@W_HDW107), unsigned decimal word.
2654
2655 A1 = Min(@W_HDW106,@W_HDW107)
2656
2657 @W_HDW105 = A1
2658 {{/code}}
2659
2660 **Result:** @W_HDW105 = 5
2661
2662 **✎Note:** A1, A2,A3 only used in unsigned integer or unsigned address.
2663
2664 == **MSeconds** ==
2665
2666 **Function**
2667
2668 A1=MSeconds( )
2669
2670 **Description**
2671
2672 A1 is used to display the current milliseconds of system.
2673
2674 **Parameters**
2675
2676 * **A1: **used to store the current milliseconds of system.
2677
2678 **Example**
2679
2680 {{code language="lua"}}
2681 DIM A1 as integer
2682
2683 @W_HDW0= 10 'assign a value to (@W_HDW0), unsigned decimal word
2684
2685 A1=MSeconds() 'return the current milliseconds of system to A1
2686
2687 @W_HDW0=A1
2688
2689 @W_HDW1=A1>>16 'display milliseconds on screen, (HDW0) is an 32-bit unsigned decimal integer address
2690 {{/code}}
2691
2692 **Result:** @W_HDW0 will generate the time value of changing milliseconds unit.
2693
2694 (% class="box infomessage" %)
2695 (((
2696 **✎Note:**
2697
2698 * A1 is 32-bit unsigned integer variable or unsigned integer address;
2699 * 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);
2700 )))
2701
2702 == **MyDeleteFile** ==
2703
2704 **Function**
2705
2706 MyDeleteFile (A1,A2,A3,A4,A5)
2707
2708 **Description**
2709
2710 Delete the specified file
2711
2712 **Parameters**
2713
2714 A1: File location (value is an integer);
2715
2716 In HMI:
2717
2718 * =0: Recipe folder in HMI flash;
2719 * =1: Custom folder in UDisk (USB flash disk);
2720 * = 2: Custom folder in SD card.
2721 * =3: Custom folder in HMI flash;
2722
2723 In simulator:
2724
2725 * = 0: D:/Recipe/
2726 * = 1: C:/WECON/CustomFileDir/
2727 * = 2: C:/WECON/CustomFileDir/
2728 * = 3: C:/WECON/CustomFileDir/
2729
2730 **✎Note:**
2731
2732 A1 can be an address, variable or value.
2733
2734 A2: filename (value is string);
2735
2736 Input the name of the file want to delete.
2737
2738 **✎Note: **
2739
2740 A2 can be an address , variable or a character string, and the length of the file name cannot exceed 32 characters.
2741
2742 A3: folder name (value is integer);
2743
2744 Input the folder where the file want to delete.
2745
2746 **✎Note: **
2747
2748 A3 can be an address , variable or a character string, and the length of the folder name cannot exceed 32 characters.
2749
2750 A4: Delete function type (value is integer)
2751
2752 * = 0: Delete the specified file.
2753 * = 1: Delete all files.
2754
2755 **✎Note: **
2756
2757 A4 can be an address , variable or value.
2758
2759 A5: Return value (value is an integer)
2760
2761 * = 0: parameter error
2762 * = 1: Delete successfully
2763 * = 2: Delete failed
2764 * = 3: Failed to open file
2765
2766 **✎Note:** A5 must be an address.
2767
2768 **Example**
2769
2770 (% class="box" %)
2771 (((
2772 MyDeleteFile(@W_HDW1254,@W_HDW4200,@W_HDW4300,@W_HDW1250,"@W_HDW1252")
2773
2774 ‘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.
2775 )))
2776
2777 == **NewNoAddr** ==
2778
2779 **Function**
2780
2781 A1= NewNoAddr (A2, length)
2782
2783 **Description**
2784
2785 At the basic of source address A2, offset designated length, obtain a new address A1.
2786
2787 **Parameters**
2788
2789 * **A1: **address after offsetting, it must be String type variable.
2790 * **A2:** source address, it must be an address(e.g.:"@W_HDW2")
2791 * **Length: **offset length, it must be a constant or an integer variable.
2792
2793 **Example**
2794
2795 {{code language="lua"}}
2796 DIM A1 as string
2797
2798 A1=NewNoAddr("@W_HDW0",50) '(HDW0) offsets 50 words address (16 bit), and save the result to A1
2799
2800 @W_HDW1=A1 '(HDW50) save in A1
2801 {{/code}}
2802
2803 **Result: **(@W_HDW1) character input/display will show @W_HDW50
2804
2805 == **NewStatAddr** ==
2806
2807 **Function**
2808
2809 A1= NewStatAddr (A2, length)
2810
2811 **Description**
2812
2813 At the basic of source address A2, offset the designated length, to obtain a new station A1.
2814
2815 **Parameters**
2816
2817 * **A1: **The address after offsetting, it needs to be variable.
2818 * **A2:** Source station address, it needs to be address (e.g.:"@W_1:10").
2819 * **Length: **offset length
2820
2821 **Example**
2822
2823 {{code language="lua"}}
2824 DIM A1 as string
2825
2826 A1=NewStatAddr("@W_1:10",2) 'address 10 of station address 1 that offset 2 station addresses, then save the result to A1
2827
2828 @W_HDW1=A1 'address 3:10 is saved in A1
2829 {{/code}}
2830
2831 **Result: **@W_HDW1 character input/display will show @W_3:10
2832
2833 == **NStringCompare** ==
2834
2835 **Function**
2836
2837 A1= NStringCompare (A2, A3, length)
2838
2839 **Description**
2840
2841 Compare whether the designated length of two strings is the same, return 1 to A1 if yes, otherwise return 0.
2842
2843 **Parameters**
2844
2845 * **A1: **Returned value (compare the designated length of two strings, display 1 when equal, else 0). It could be an address or variable.
2846 * **A2: **the address of string to be compared, it needs to be address.
2847 * **A3: **source string, it needs to be variable or constant string.
2848 * **Length: **string length to be compared
2849
2850 **Example**
2851
2852 {{code language="lua"}}
2853 @W_HDW1= NStringCompare("@W_HDW0","87654",5)
2854
2855 if @W_HDW1=1 then
2856
2857 @B_HDX10.0=1 'result: HDX10.0 set ON 'when the two strings are the same.
2858
2859 endif
2860
2861 if @W_HDW1=0 then
2862
2863 @B_HDX10.0=0 'result:HDX10.0 set OFF 'when not equal.
2864
2865 Endif
2866 {{/code}}
2867
2868 == **Operator** ==
2869
2870 (% class="table-bordered" %)
2871 |=(% scope="row" %)**Operation**|=**Symbol**|=**Example**|=**Return type**
2872 |=Addition|+|A1=A2+A3|Return type depending on the type of variable or address of the addition
2873 |=Subtraction|-|A1=A2-A3|Return type depending on the type of variable or address of the subtraction
2874 |=Multiplication|*|A1=A2*A3|Return type depending on the type of variable or address of the multiplication
2875 |=Division|/|A1=A2/A3|Return type depending on the type of variable or address of the division
2876 |=Remainder|Mod ~(%)|(((
2877 A1=A2 mod A3
2878
2879 A1=A2%A3
2880 )))|Returns the remainder of the division of two numbers. The type of the return value is an integer
2881 |=Logical OR|Or(~|)|(((
2882 A1=A2 or A3
2883
2884 A1=A2|A3
2885 )))|Returns the result of a logical OR. The type of the return value is an integer.
2886 |=Logic AND|And (&)|(((
2887 A1=A2 and A3
2888
2889 A1=A2&A3
2890 )))|Returns the result of a logical AND. The type of the return value is an integer.
2891 |=Logical XOR|Xor (^)|(((
2892 A1=A2 xor A3
2893
2894 A1=A2^A3
2895 )))|Returns the result of a logical XOR. The type of the return value is an integer.
2896 |=Logical reversal|Not (!)|(((
2897 A1=not A1
2898
2899 A1=A2!A3
2900 )))|Returns the result of a logical reversal. The type of the return value is an integer.
2901 |=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.
2902 |=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.
2903 |=Bit reversal|~~|A1=~~A1|Perform a bit reversal on a value. The type of the return value is an integer.
2904
2905 == **PI_GetTickCount** ==
2906
2907 **Function**
2908
2909 PI_GetTickCount (A1, A2)
2910
2911 **Description**
2912
2913 Writethe startingtime tothe set address asa 32-bit integer.
2914
2915 **Parameters**
2916
2917 * **A1: **Source data could only be the HMI internal or external register starting with "@".
2918 * **A2: **=0: Unit of time for returning 0ms;(the value will become 0 after 49.7 days and so on)
2919 ** =1: Unit of time for returning 10 ms;(the value will become 0 after 497 days and so on)
2920 ** =2: Unit of time for returning 100 ms;(the value will become 0 after 4970 days and so on)
2921 ** =3: Unit of time for returning 1000ms;(the value will become 0 after 49700 days and so on)
2922
2923 (% class="box infomessage" %)
2924 (((
2925 **✎Note: **If user restarts the hmi,all value will be 0.
2926 )))
2927
2928 **Example**
2929
2930 (% class="box" %)
2931 (((
2932 //PI_GetTickCount("@W_HDW100",0)'save the starting time in HDW100 address as a 32-bit integer.//
2933 )))
2934
2935 **Result: **HDW100=123456(different returned data for each moment)
2936
2937 == **Power** ==
2938
2939 **Function**
2940
2941 var = power (expr1, expr2)
2942
2943 **Description**
2944
2945 The value of [expr2] to the power of [expr1] will be assigned to Var.
2946
2947 **Parameters**
2948
2949 * **var:** returned value.
2950 * **expr 1:** base number.
2951 * **expr 2:** power number.
2952
2953 **Example**
2954
2955 {{code language="lua"}}
2956 Dim a as floating
2957
2958 a=power (2, 3) 'the value of 3 to the power of 2 is assigned to a.
2959
2960 Float2D("@W_HDW10",a) 'assign the float value of a to @W_HDW10
2961 {{/code}}
2962
2963 **Result: **@W_HDW10=8
2964
2965 == **PrintText** ==
2966
2967 **Function**
2968
2969 PrintText(A)
2970
2971 **Description**
2972
2973 Print the content of A or locates in A.
2974
2975 **Parameters**
2976
2977 **A:** source data. A could be a variable or a string ( text information),not a register address.
2978
2979 **Example**
2980
2981 A is text information
2982
2983 //PrintText("HMI 8070”)//
2984
2985 **Result: **Printer will print out “HMI 8070”
2986
2987 * A is variable
2988
2989 //Dim a as string//
2990
2991 //a= “HMI 8070”//
2992
2993 //PrintText(a)//
2994
2995 **Result:** Printer will print out “HMI 8070”
2996
2997 **✎Note:**
2998
2999 source data length range:1-128 characters.
3000
3001 == **RadToDeg** ==
3002
3003 **Function**
3004
3005 Var= RadToDeg(expr)
3006
3007 **Description**
3008
3009 Convert radiant value to degree, then assigned to Var.
3010
3011 **Parameters**
3012
3013 * **Var:** return degree value.
3014 * **expr:** input radiant value.
3015
3016 **Example**
3017
3018 {{code language="lua"}}
3019 Dim a as floating
3020
3021 a = RadToDeg(pi)           'assignt the degree value of ? to a.
3022
3023 Float2D("@W_HDW4",a) 'assign the degree value to address "@W_HDW4".
3024 {{/code}}
3025
3026 **Result:** @W_HDW4=180
3027
3028 == **RAND** ==
3029
3030 **Function**
3031
3032 Var = rand(expr1)
3033
3034 **Description**
3035
3036 Generate a random number.
3037
3038 **Parameter**
3039
3040 * **Var:** generated random number.
3041 * **Expr1:** the base number.
3042
3043 **Example**
3044
3045 (% class="box" %)
3046 (((
3047 //@W_HDW0=rand(@W_HDW0) 'Set the value of address@W_HDW0 as the base number to generate random number.//
3048 )))
3049
3050 **Result:** @W_HDW0 random number.
3051
3052 == **ReadAddr** ==
3053
3054 **Function**
3055
3056 Word = ReadAddr(A1)
3057
3058 **Description**
3059
3060 Assigned the red value from A1 to word.
3061
3062 **Parameter**
3063
3064 * **Word: **return value
3065
3066 **Example**
3067
3068 {{code language="lua"}}
3069 Dim word as integer
3070
3071 @W_HDW100=10
3072
3073 word = ReadAddr("@W_HDW100") 'Read the value of address @W_HDW100 and assign to word.
3074
3075 @W_HDW200=word
3076 {{/code}}
3077
3078 **Result:** @W_HDW200=10
3079
3080 == **ReadWordFormFile** ==
3081
3082 **Function**
3083
3084 ReadWordFormFile (A1, A2, A3, A4, A5, A6)
3085
3086 **Description**
3087
3088 Read data of specified length from specified file
3089
3090 **Parameters**
3091
3092 A1: File location (value is an integer);
3093
3094 In HMI:
3095
3096 * =0: Recipe folder in HMI flash;
3097 * =1: Custom folder in UDisk (USB flash disk);
3098 * = 2: Custom folder in SD card.
3099 * =3: Custom folder in HMI flash;
3100
3101 In simulator:
3102
3103 * = 0: D:/Recipe/
3104 * = 1: C:/WECON/CustomFileDir/
3105 * = 2: C:/WECON/CustomFileDir/
3106 * = 3: C:/WECON/CustomFileDir/
3107
3108 **✎Note:** A1 can be an address, variable or value.
3109
3110 A2: File name (value is a string);
3111
3112 Input the file name want to write.
3113
3114 **✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.
3115
3116 A3: Data start address (value is a string);
3117
3118 Input the data want to write
3119
3120 **✎Note: **A3 must be the address.
3121
3122 A4: Data length (value is an integer)
3123
3124 Set the length of the data to be written (unit:word)
3125
3126 **✎Note: **A4 can be an address , variable or value.
3127
3128 A5: Return value (value is an integer)
3129
3130 ~= 1: Successfully read
3131
3132 ~= 2: Failed to open the folder
3133
3134 ~= 3: Read address error
3135
3136 ~= 4: File reading error
3137
3138 **✎Note: **A5 must be an address.
3139
3140 A6: Folder name (value is a string);
3141
3142 Input the folder where to be written the file.
3143
3144 **✎Note:** A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters
3145
3146 **Example**
3147
3148 (% class="box" %)
3149 (((
3150 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
3151 )))
3152
3153 == **Right** ==
3154
3155 **Function**
3156
3157 val = Right (string, length)
3158
3159 **Description**
3160
3161 Return a string of the specified length from the right side of parameter.
3162
3163 **Parameter**
3164
3165 * **string: **the operated string.
3166 * **length:** the designated number of byte required to return, count from the right side.
3167
3168 **Example**
3169
3170 //@W_HDW103= Right("Hello", 3) 'return "llo"//
3171
3172 **Result: **@W_HDW103="llo"
3173
3174 == **RTrim** ==
3175
3176 **Function**
3177
3178 val = RTrim(str)
3179
3180 **Description**
3181
3182 Clear the empty part on the right side of string [str], then assign the empty part to val
3183
3184 **Parameter**
3185
3186 * **val: **returned value.
3187 * **str:** the string needs to be operated.
3188
3189 **Example**
3190
3191 (% class="box" %)
3192 (((
3193 //@W_HDW0 = RTrim("   -Hell  o-  ") 'retrun"   -Hell  o-"//
3194 )))
3195
3196 **Result:** @W_HDW0display "   -Hell  o-"
3197
3198 == **S2F** ==
3199
3200 **Function**
3201
3202 S2F (A1,A2,s1)
3203
3204 **Description**
3205
3206 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.
3207
3208 **Parameters**
3209
3210 * **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
3211 * **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
3212 * **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)
3213
3214 **Return value:** none
3215
3216 **Example**
3217
3218 (% class="box" %)
3219 (((
3220 The lengTh of string is 8
3221
3222 //@W_HDW0="12345.67"//'Assign the string “12345.67" to HDW1
3223
3224 //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//
3225 )))
3226
3227 **Result: **@W_HDW100 address displays “12345.67”.
3228
3229 (% class="box" %)
3230 (((
3231 The length of string is less than 8
3232
3233 //@W_HDW0="1234.5 67"‘assign the string“1234.567”to HDW1//
3234
3235 //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 .//
3236 )))
3237
3238 **Result: **the floating value of @W_HDW100 is 1234.50
3239
3240 (% class="box" %)
3241 (((
3242 The length of string is more than 8
3243
3244 //@W_HDW0="12345.6789"’assign the string “12345.6789” to HDW1//
3245
3246 //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 .//
3247 )))
3248
3249 **Result: **the floating value of @W_HDW100 is 12345.67
3250
3251 == **SetB** ==
3252
3253 **Function**
3254
3255 SetB(A1)
3256
3257 **Description**
3258
3259 Set the bit A1 ON.
3260
3261 **Parameters**
3262
3263 * **A1:**Bit address
3264
3265 **Example**
3266
3267 (% class="box" %)
3268 (((
3269 //SetB(@B_HDX100.0) 'Set the address {@B_HDX100.0} ON//
3270 )))
3271
3272 **Result: **@B_HDX100.0=1
3273
3274 == **SetKeyMap** ==
3275
3276 **Function**
3277
3278 SetKeyMap(A1,A2,A3)
3279
3280 **Description**
3281
3282 The key values of the keyboard are mapped so that multiple keyboard buttons perform the same function.
3283
3284 **Parameters**
3285
3286 * **A1:** The starting address of the source key;It needs to be an address format;
3287 * **A2: **The starting address of the mapped value; It needs to be an address format;
3288 * **A3: **Mapping length (continuous length of mapped address); It needs to be a value, the maximum mapping range: 108 key values;
3289
3290 **Example**
3291
3292 (% class="box" %)
3293 (((
3294 //@W_HDW3000 = 3 ' The starting address of the source key//
3295
3296 //@W_HDW3001 = 5//
3297
3298 //@W_HDW3002 = 7//
3299
3300 //@W_HDW3003 = 9//
3301
3302 //@W_HDW3004 = 61//
3303
3304 //@W_HDW4100 = 103 'The starting address of the mapped value//
3305
3306 //@W_HDW4101 = 105//
3307
3308 //@W_HDW4102 = 106//
3309
3310 //@W_HDW4103 = 108//
3311
3312 //@W_HDW4104 = 28//
3313
3314 //SetKeyMap("@W_HDW3000","@W_HDW4100",5) ' Map the values of the HDW4000~~HDW4004 addresses to the HDW3000~~HDW3004 addresses.//
3315 )))
3316
3317 **Result**
3318
3319 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)
3320
3321 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.
3322
3323 == **SignedInt16** ==
3324
3325 **Function**
3326
3327 val = SignedInt16(A1)
3328
3329 **Description**
3330
3331 Assign the value to {val} from address A1 which is signed integer.
3332
3333 **Parameters**
3334
3335 * **A1: **contain signed integer as "@W_HDW000002"
3336 * **Val: **returned value
3337
3338 **Example**
3339
3340 {{code language="lua"}}
3341 Dim a as integer 'Integer variable a
3342
3343 a = SignedInt16("@W_HDW0") 'read signed integer from HDW0 addresses and assign the value to a
3344
3345 @W_HDW2=a'assign the value a to HDW2
3346 {{/code}}
3347
3348 **Input: **@W_HDW0=-2:
3349
3350 **Result:** @W_HDW2=-2.
3351
3352 == **SignedInt32** ==
3353
3354 **Function**
3355
3356 val = SignedInt32 (A1)
3357
3358 **Description**
3359
3360 Assign the value to {val} from address A1 which is signed even integer.
3361
3362 **Parameters**
3363
3364 * **A1: **the address contains signed even integer
3365 * **Val:** Returned value
3366
3367 **Example**
3368
3369 {{code language="lua"}}
3370 Dim a as integer 'define {a} as a integer
3371
3372 a = SignedInt32("@W_HDW0") 'read signed even integer from HDW0, then assign this value to a.
3373
3374 @W_HDW2=a 'assign the value of a to HDW2
3375
3376 @W_HDW3=a>>16
3377 {{/code}}
3378
3379 **Input: **@W_HDW0=-2
3380
3381 **Result:**
3382
3383 * @W_HDW2=-2
3384 * @W_HDW13=-1
3385
3386 == **Sin** ==
3387
3388 **Function**
3389
3390 val = Sin(A1)
3391
3392 **Description**
3393
3394 Get the sine value of A1, and copy result to val.
3395
3396 **Parameters**
3397
3398 * **A1: **A1 needs to be an angle.
3399 * **Val: **Returned value.
3400
3401 **Example**
3402
3403 {{code language="lua"}}
3404 Dim a as floating 'floating variable a,b
3405
3406 a=sin(pi/6) 'return sinb to a
3407
3408 Float2D("@W_HDW13",a) 'assign the value of the floating variable a to address HDW13.
3409 {{/code}}
3410
3411 **Result:** @W_HDW13=0.5
3412
3413 == **SleepA** ==
3414
3415 **Function**
3416
3417 SleepA(T)
3418
3419 **Description**
3420
3421 Wait time T(ms).
3422
3423 **Parameters**
3424
3425 * **T:** wait time, the unit is [ms]
3426
3427 **Returned value:** none.
3428
3429 **Example**
3430
3431 (% class="box" %)
3432 (((
3433 //SleepA(10) 'wait 10ms//
3434 )))
3435
3436 **Result:** When the script runs to SleepA(10), it means the scripts would go running after waiting 10ms
3437
3438 == **Sqr** ==
3439
3440 **Function**
3441
3442 val = Sqr(A1)
3443
3444 **Description**
3445
3446 Assign a square root value of A1 to val.
3447
3448 **Parameters**
3449
3450 * **A1: **the data need to be operated
3451 * **Val: **Returned value
3452
3453 **Example**
3454
3455 (% class="box" %)
3456 (((
3457 //@W_HDW0 = Sqr(4) 'calculate the square root of HDW0//
3458 )))
3459
3460 **Result:** @W_HDW0=2
3461
3462 == **StAndFtChange** ==
3463
3464 **Function**
3465
3466 StAndFtChange(A1,A2,A3)
3467
3468 **Description**
3469
3470 Calculate the number of seconds from January 1, 1970 to the current time, and also be invertible.
3471
3472 **Parameters**
3473
3474 * **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;
3475 * **A2: **The number of seconds; It needs to begin with address “@", data format 32-bit unsigned.
3476 * **A3: **conversion method;
3477 ** A3=0, convert time to seconds;
3478 ** A3=1, convert seconds to time;
3479
3480 **Returned value: **none;
3481
3482 **Example**
3483
3484 Script 1
3485
3486 (% class="box" %)
3487 (((
3488 //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//
3489 )))
3490
3491 **Input: **HDW10 = 2017,HDW11 = 12, HDW12 = 9 , HDW13 = 15, HDW14 = 15, HDW15 = 0
3492
3493 **Output:** 1512832500
3494
3495 Script 2
3496
3497 (% class="box" %)
3498 (((
3499 //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//
3500 )))
3501
3502 **Input:** 1512833760
3503
3504 **Output:** HDW30 = 2017, HDW31 = 12, HDW32 = 9, HDW33 = 15, HDW34 = 36, HDW35 = 0
3505
3506 == **Sub** ==
3507
3508 **Function**
3509
3510 Sub name (arglist)
3511
3512 statements
3513
3514 End Sub
3515
3516 **Description**
3517
3518 Declare the name, parameters and codes of the Sub (sub function)
3519
3520 **Parameters**
3521
3522 * **Name: **naming rules refer to variable.
3523 * **Arglist: **variable list.
3524 * **Statements:** the code set of the sub function.
3525
3526 **Example**
3527
3528 {{code language="lua"}}
3529 sub samesub(a,b as integer) ' samesub and integer variable a,b
3530
3531 c=a+b
3532
3533 @W_HDW0=c
3534
3535 endsub
3536
3537 samesub(1,12) 'call function samesub
3538 {{/code}}
3539
3540 **Result:** @W_HDW0=13
3541
3542 == **SWAP** ==
3543
3544 **Function**
3545
3546 SWAP(A1,length)
3547
3548 **Description**
3549
3550 Swap the big-endian with the little-endian from address A1, swap length is adjustable.
3551
3552 **Parameters**
3553
3554 * **A1: **the swapped high endian, need to be an address as HDW_000002.
3555 * **Length: **swap length.
3556
3557 **Returned value:** None.
3558
3559 **Example**
3560
3561 {{code language="lua"}}
3562 @W_HDW103=0x1234 'assign value to HDW103
3563
3564 @W_HDW104=0x2345 'assign value to HDW104
3565
3566 @W_HDW105=0x2565 'assign value to HDW105
3567
3568 @W_HDW106=0x2675 'assign value to HDW106
3569
3570 SWAP(@W_HDW103,4) 'swap the high and low endian for the 4 adjacent addresses start with HDW103.
3571 {{/code}}
3572
3573 **Result:**
3574
3575 * @W_HDW103=0x3412
3576 * @W_HDW104=0x4523
3577 * @W_HDW105=0x6525
3578 * @W_HDW106=0x7526
3579
3580 == **Tan** ==
3581
3582 **Function**
3583
3584 val = Tan(A1)
3585
3586 **Description**
3587
3588 Get the returned tagent value of A1, and then assign to val.
3589
3590 **Parameters**
3591
3592 * **A1: **A1 needs to be an angle.
3593 * **Val: **Returned value.
3594
3595 **Example**
3596
3597 {{code language="lua"}}
3598 Dim a as floating 'define a floating variable a
3599
3600 a=TAN(pi/3) 'calculate the tangent value of pi/3 and assign to a
3601
3602 Float2D("@W_HDW16",a) 'assign the value of a to HDW16
3603 {{/code}}
3604
3605 **Result:** @W_HDW13=1.732
3606
3607 == **Trim** ==
3608
3609 **Function**
3610
3611 val = Trim(A1)
3612
3613 **Description**
3614
3615 Return A string in A1 without empty string next to it.
3616
3617 **Parameters**
3618
3619 * **A1: **The operated string
3620 * **val: **Returned value
3621
3622 **Example**
3623
3624 //{{code language="lua"}}@W_HDW1=Trim(" ab "){{/code}}//
3625
3626 **Result: **@W_HDW1="ab"
3627
3628 == **UCase** ==
3629
3630 **Function**
3631
3632 val = UCase(A1)
3633
3634 **Description**
3635
3636 Capitalize the string data, and then assign the value to val.
3637
3638 **Parameters**
3639
3640 * **A1: **Operated string, address or variable.
3641 * **Val: **Returned value
3642
3643 **Example**
3644
3645 //{{code language="lua"}}@W_HDW1=ucase("abcd") 'Capitalize abcd then assign the value to HDW1{{/code}}//
3646
3647 **Result: **@W_HDW1="ABCD"
3648
3649 == **Variable** ==
3650
3651 **Description**
3652
3653 A variable is any factor, trait, or condition that could exist in differing amounts or types.
3654
3655 **Define variable**
3656
3657 Use Dim to define variable in script. The variable could be string, floating, integer.
3658
3659 **Example:**
3660
3661 {{code language="lua"}}
3662 Dim a as floating ‘define variable {a} as a floating.
3663
3664 Dim b,c,d as integer‘define variable {b,c,d} as integer
3665 {{/code}}
3666
3667 **Naming rules**
3668
3669 The first letter needs to be English letter.
3670
3671 No symbols.
3672
3673 Maximum character length 15 allowed.
3674
3675 == **W2B** ==
3676
3677 **Function**
3678
3679 W2B(A1, A2, A3)
3680
3681 **Description**
3682
3683 Replace the high endian of [A2]+1 with the high endian of A2.
3684
3685 **Parameters**
3686
3687 * **A1:** operated address.
3688 * **A2:** source address.
3689 * **A3: **the conversion length.
3690
3691 **Returned value:** none.
3692
3693 **Example**
3694
3695 {{code language="lua"}}
3696 @W_HDW0 = 4660 'assign 16bit value 1234 to HDW0.
3697
3698 @W_HDW1=0x5678 'assign 16bit value 5678 to HDW1.
3699
3700 @W_HDW2 = 0x2425 'assign 16bit value 2425 to HDW1.
3701
3702 @W_HDW3 = 0x3536 'assign 16bit value 3536 to HDW0.
3703
3704 @W_HDW4 = 0x1415 'assign 16bit value 1415 to HDW0.
3705
3706 W2B(@W_HDW20,@W_HDW0, @W_HDW10)
3707
3708 @W_HDW10=1 ‘save the high endian {34} of HDW0 to HDW20.
3709 {{/code}}
3710
3711 **Result:** @W_HDW20=0x34, @W_HDW21=0, @W_HDW22=0
3712
3713 == **W2D** ==
3714
3715 **Function**
3716
3717 W2D(A1, A2)
3718
3719 **Description**
3720
3721 Convert the unsigned Word to unsigned Dword and save the result in A1.
3722
3723 **Parameters**
3724
3725 * **A1: **operated address .
3726 * **A2:** source address.
3727
3728 Returned value.
3729
3730 **Example**
3731
3732 Unsigned decimal word
3733
3734 (% class="box" %)
3735 (((
3736 //@W_HDW0 = 1234 'assign 1234 to HDW0.//
3737
3738 //W2D(@W_HDW2, @W_HDW0) 'convert unsigned word {1234} from HDW0 to Dword and save in HDW2//
3739 )))
3740
3741 **Result:** @W_HDW0=12345, @W_HDW2=12345, @W_HDW3=0
3742
3743 Signed decimal word
3744
3745 (% class="box" %)
3746 (((
3747 //@W_HDW0 = -12345 'assign value to HDW0: convert {-12344} to unsigned decimal word is {53191}.//
3748
3749 //W2D(@W_HDW2, @W_HDW0) 'save unsigned Dword to HDW0//
3750 )))
3751
3752 **Result: **@W_HDW0=-12345,@W_HDW2=53191,@W_HDW3=0
3753
3754 == **W2F** ==
3755
3756 **Function**
3757
3758 A1 = W2F (A2)
3759
3760 **Description**
3761
3762 Convert a 16bit integer to a 32bit floating, and then save to the next word of A1.
3763
3764 Parameters
3765
3766 * **A1:** operated address.
3767 * **A2:** source address.
3768
3769 **Returned value:** none.
3770
3771 **Example**
3772
3773 A1, A2 are addresses
3774
3775 (% class="box" %)
3776 (((
3777 //@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.//
3778 )))
3779
3780 **Result: **@W_HDW1=1234'32bit floating
3781
3782 {{code language="lua"}}
3783 A1 is an address,A2 is variable
3784
3785 dim a as integer
3786
3787 a=134 'define a integer 134 to a,
3788
3789 @W_HDW2=W2F (a) 'convert to 32bit floating save to HDW1, HDW2.
3790 {{/code}}
3791
3792 **Result: **@W_HDW1=134' 32bit floating
3793
3794 == **W2S** ==
3795
3796 **Function**
3797
3798 W2S(A1,A2,S1)
3799
3800 **Description**
3801
3802 Convert integer word in address A1 text as S1 format, and then save to A2.
3803
3804 **Parameters**
3805
3806 * **A1:** operated address.
3807 * **A2:** source address.
3808 * **S1:** saving format.
3809 ** 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.
3810 ** format: Unsigned octal format. Mo and 0mo is also applied.
3811 ** x format: unsigned Hex integer format ?Mx and 0mx is also applied.
3812 ** c format: ASCII format.
3813
3814 **Example**
3815
3816 Decimal format
3817
3818 {{code language="lua"}}
3819 @W_HDW1=1456'assign value {1456} to HDW1.
3820
3821 W2S("@W_HDW1", "@W_HDW10", "6d") ' convert{1456} to decimal text and save to HDW10.
3822 {{/code}}
3823
3824 **Result: **@W_HDW10 shown "1456"
3825
3826 0md
3827
3828 {{code language="lua"}}
3829 @W_HDW1=1456 ' assign value {1456} to HDW1
3830
3831 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.
3832 {{/code}}
3833
3834 **Result:** @W_HDW10 show text "001456"
3835
3836 == **WaitEthernetStart** ==
3837
3838 **Function**
3839
3840 WaitEthernetStart (A1)
3841
3842 **Description**
3843
3844 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)
3845
3846 **Parameters**
3847
3848 * **A1: **Waiting timeout (1~~20s)
3849 ** If A1=0, the wait timeout is 10s;
3850 ** If A1>20, the wait timeout is 20s;
3851
3852 **Returned value:** None
3853
3854 **Example**
3855
3856 //WaitEthernetStart (15)//
3857
3858 ‘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.
3859
3860 == **WHILE ... WEND** ==
3861
3862 **Function**
3863
3864 While condition
3865
3866 [statements]
3867
3868 Wend
3869
3870 **Description**
3871
3872 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.
3873
3874 **Parameters**
3875
3876 * **Condition: **Number or string, the result represents as True or False.
3877
3878 **Returned value:** None.
3879
3880 **Example**
3881
3882 {{code language="lua"}}
3883 while @W_HDW1>50 'the condition is the value of HDW1 bigger than 50.
3884
3885 @W_HDW1=@W_HDW1-1 'when the condition is true, execute subtract 1 from 1HDW.
3886
3887 wend
3888
3889 @W_HDW2=@W_HDW2+1 ' when the condition is false, execute add 1 from 1HDW.
3890 {{/code}}
3891
3892 **Result:** If HDW1=60, after executed; HDW1=50, if the condition is true.
3893
3894 == **WriteAddr** ==
3895
3896 **Function**
3897
3898 WriteAddr(A1,A2)
3899
3900 **Description**
3901
3902 Assign the value from A2 to address A1.
3903
3904 **Parameters**
3905
3906 * **A1:** operated address
3907 * **A2:** source address
3908
3909 **Returned value:** None.
3910
3911 **Example**
3912
3913 {{code language="lua"}}
3914 dim f as integer ' integer f
3915
3916 f=13 ' assign the value 13 to f
3917
3918 WriteAddr("@W_HDW1",f) ' write the value to HDW1.
3919
3920 WriteAddr("@W_HDW10",@W_HDW2) ' write the value from HDW2 to HDW10.
3921 {{/code}}
3922
3923 **Result:**
3924
3925 * HDW1=13
3926 * HDW10= HDW2'IF HDW2=1456,Then HDW10=1456;IF HDW2=-123,Then HDW10=-123
3927
3928 == **WriteWordToFile** ==
3929
3930 **Function**
3931
3932 WriteWordToFile (A1,A2,A3,A4,A5,A6)
3933
3934 **Description**
3935
3936 Write data of designated length to specified file
3937
3938 **Parameters**
3939
3940 A1: File location (value is an integer);
3941
3942 In HMI:
3943
3944 * =0: Recipe folder in HMI flash;
3945 * =1: Custom folder in UDisk (USB flash disk);
3946 * = 2: Custom folder in SD card.
3947 * =3: Custom folder in HMI flash;
3948
3949 In simulator:
3950
3951 * = 0: D:/Recipe/
3952 * = 1: C:/WECON/CustomFileDir/
3953 * = 2: C:/WECON/CustomFileDir/
3954 * = 3: C:/WECON/CustomFileDir/
3955
3956 **✎Note: **A1 can be an address, variable or value.
3957
3958 A2: File name (value is a string);
3959
3960 Input the file name want to write.
3961
3962 **✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.
3963
3964 A3: Data start address (value is a string);
3965
3966 Input the data want to write
3967
3968 **✎Note: **A3 must be the address.
3969
3970 A4: Data length (value is an integer)
3971
3972 Set the length of the data to be written (unit:word)
3973
3974 **✎Note: **A4 can be an address , variable or value.
3975
3976 A5: Return value (value is an integer)
3977
3978 * = 1: Successfully written
3979 * = 2: Failed to open the folder
3980 * = 3: Read address error
3981 * = 4: File writing error
3982 * = 5: The file already exists
3983
3984 **✎Note: **A5 must be an address.
3985
3986 A6: Folder name (value is a string);
3987
3988 Input the folder where to be written the file.
3989
3990 (% class="box infomessage" %)
3991 (((
3992 **✎Note: **A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters
3993 )))
3994
3995 **Example**
3996
3997 (% class="box" %)
3998 (((
3999 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
4000 )))