Skip to Content

Wiki source code of 08 Macro Script

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