08 Macro Script

This chapter provides information about scripts in PIStudio.

= **Script type** =

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.

== Initialize ==

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;

== Close ==

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;

== Timing ==

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.

)))

== Trigger bit ==

**Introduction**

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"]]

Set parameters;

(% 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;

)))

= Script usage =

Script can make project more convenient and flexible. Script is useful in realizing complex HMI function. If the script is used improperly, it may affect the efficiency of entire project. So pay attention to the follow issues:

208

209

* Do not use too much script loops, if the script loops that execute too many times; it might influence the efficiency of HMI.

210

* In the cycle scripts, avoid using external register, due to the relatively slow serial communication, frequent access to external registers may cause the execution of scripts severely reduced, even influence the screen respond efficiently. There is fine to use internal register.

211

* The maximum script length is 512 rows.

212

213

This section describes how to edit scripts and use some of the accompanying tools and features of the script editor.

214

215

== **Script access to d evice** ==

216

217

Software script supports an efficiency way to access the device address by using symbol @.

218

219

(% class="table-bordered" %)

220

|=**Writing**|=**Meaning**|=**Examples**

221

|@B_;@b_;|Access designated bit address|(((

222

@B_I0.0:access bit address I0.0

223

224

@b_HDX0.0:access bit address HDX0.0

225

)))

226

|@W_;@w_;|(% rowspan="2" %)(((

227

Access designated word address

228

229

HMI connect more than automatic control devices, "#"stands for choosing number before the symbol,":"stands for accessing the station number before symbol.

230

231

Access the first protocol without "#",access default station number1 without":".

232

)))|(((

233

@W_IW0:access word address IW0

234

235

@b_HDW0:access word address HDW0

236

)))

237

|@B_(the number of protocol connection)#(station number):address|(((

238

@B_2#2:I0.0:access the bit address I0.0, with the connection number 2 and station number 2;

239

240

@B_I0.0:access to bit address I0.0;

241

)))

242

243

The script can access with the device though: write and read.

**For example**

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

Else

@B_HDX0.0 = 1 'write 1 to address HDX0.0

Endif

@W_QW0 = @W_QW0 + 1 'read data from address QW0, add 1 to this value then write to address QW0

259

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'

55. 'to' expected

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'

63. 'then' expected

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

70. ',' expected

71. Missing ')'

72. Unexpected end of line in expression

414

415

73. Unexpected end of file in expression

416

417

= **Script function list** =

== Mathematical ==

(% 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

== Data migration ==

(% 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

== Fixed constant ==

(% 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

== File operation ==

(% class="table-bordered" %)

523

|(% style="width:177px" %)**Function**|(% style="width:1312px" %)**Introduction**

524

|[[HmiRegoperator>>||anchor="HHmiRegoperator"]]|Data of Upload/ Download address

525

|[[CopyFile>>||anchor="HCopyFile"]]|Copy the A3 file from the A1 directory to the A2 directory according to the format of A4 and A5

526

|[[DbToCSVFile>>||anchor="HDbToCSVFile"]]| file to csv format and export it

527

|[[FileCmpDir>>||anchor="HFileCmpDir"]]|The filename input and the filename in the folder whether is duplicate or not

528

|[[MyDeleteFile>>||anchor="HMyDeleteFile"]]|Delete the designated file

529

|[[WriteWordToFile>>||anchor="HWriteWordToFile"]]|Write data with designated length to designated file

530

|[[ReadWordFormFile>>||anchor="HReadWordFormFile"]]|Read data with designated length from designated file

== Comparison ==

(% class="table-bordered" %)

535

|=(% colspan="2" style="width: 389.5px;" %)Function|=Introduction

536

|(% rowspan="8" %)IF... THEN GOTO...|(% style="width:148.719px" %)IF=|(% rowspan="18" style="width:691.5px" %)Execute correspond instruction when fulfill condition. Condition will be tested during executing if. it will execute the next instruction block of then, if condition is true. Otherwise, execute the later of else. Complete the two instructions, next execute the later of End if.

537

|(% style="width:148.719px" %)IF<>

538

|(% style="width:148.719px" %)IF>

539

|(% style="width:148.719px" %)IF>=

540

|(% style="width:148.719px" %)IF<

541

|(% style="width:148.719px" %)IF<=

542

|(% style="width:148.719px" %)IF AND=0

543

|(% style="width:148.719px" %)IF AND<>0

544

|(% rowspan="8" style="width:255.281px" %)IF|(% style="width:148.719px" %)IF=

545

|(% style="width:148.719px" %)IF<>

546

|(% style="width:148.719px" %)IF>

547

|(% style="width:148.719px" %)IF>=

548

|(% style="width:148.719px" %)IF<

549

|(% style="width:148.719px" %)IF<=

550

|(% style="width:148.719px" %)IF AND=0

551

|(% style="width:148.719px" %)IF AND<>0

552

|(% colspan="2" style="width:389.5px" %)ELSE

553

|(% colspan="2" style="width:389.5px" %)ENDIF

554

555

== **Applicatio**n** type** ==

556

557

(% class="table-bordered" %)

558

|=(% style="width: 181px;" %)**Function**|=(% style="width: 1308px;" %)**Introduction**

559

|[[AddrStringCompare>>||anchor="HAddrStringCompare"]]|Compare the designated length of two character strings

560

|[[Beep>>||anchor="HBeep"]]|Enable buzzer

561

|[[IsFloating>>||anchor="HIsFloating"]]|whether a parameter is floating, return TRUE if it is floating, otherwise return FALSE

562

|[[IsInteger>>||anchor="HIsInteger"]]|whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE

563

|[[Log>>||anchor="HLog"]]|Log function: return the natural logarithm of the value

564

|[[Log10>>||anchor="HLog10"]]|Log function: return the natural logarithm of the value

565

|[[MSeconds>>||anchor="HMSeconds"]]|Display the current microseconds of system

566

|[[NewNoAddr>>||anchor="HNewNoAddr"]]|At the basic of source address A2,offset designated length,obtain a new address A1

567

|[[NewStatAddr>>||anchor="HNewStatAddr"]]|At the basic of source address A2,offset the designated length,to obtain a new station A1.

568

|[[NStringCompare>>||anchor="HNStringCompare"]]|Compare whether the designated length of two strings is the same,return 1 to A1 if yes,otherwise return 0

569

|[[Power>>||anchor="HPower"]]|The value of [expr2] to the power of [expr1] will be assigned to Var

570

|[[RAND>>||anchor="HRAND"]]|Generate a random number

571

|[[ReadAddr>>||anchor="HReadAddr"]]|Assign the value in the specified address to [word]

572

|[[SleepA>>||anchor="HSleepA"]]|Wait time T(ms)

573

|[[WriteAddr>>||anchor="HWriteAddr"]]|Assign the value from A2 to address A1

== Others ==

(% class="table-bordered" %)

578

|=(% style="width: 182px;" %)**Function**|=(% style="width: 1307px;" %)**Introduction**

579

|[[DIM...AS...>>||anchor="HDIM...AS..."]]|Declare a variable

580

|do|Condition determent instruction

581

|[[Function>>||anchor="HFunction"]]|Differ from internal function, need to declare the name, parameter, code of the function

582

|[[Sub>>||anchor="HSub"]]|Declare the name, parameters and codes of the Sub (sub function)

583

|[[PrintText>>||anchor="HPrintText"]]|Output the contents to the printer for printing

584

|[[PI_GetTickCount>>||anchor="HPI_GetTickCount"]]|Write the starting time in the set address as a 32-bit integer

585

|[[StAndFtChange>>||anchor="HStAndFtChange"]]|Calculate the number of seconds from January 1, 1970 to the current time

586

|[[GetServerDelayInfo>>||anchor="HGetServerDelayInfo"]]|Convert string to hexadecimal number

587

588

= **Function description** =

== A2H ==

**Function**

Val = A2H(A1)

**Description**

Convert string in the specified address to a hexadecimal number;

**Parameters**

* **A1:** Source data, only convert the first four digits of string

603

* **Val:** The value is hexadecimal number.

**Example**

@W_HDW20=A2H(@W_HDW10) ' convert the string of HDW10 to hex then save in HDW20.

609

610

611

**Input:** @W_HDW10=255

612

613

**Result:** @W_HDW20=255

614

615

(% class="box infomessage" %)

(((

**✎Note:**

* A1 needs to be address (such as:@W_HDW000002).

620

* Only [0~~1], [a~~f] can be converted, others will be converted to 0

)))

== A2I ==

**Function**

A2I (A1, A2, length, S)

**Description**

Intercept a string of the specified length from A1,convert it to a single/double word integer and assign this integer to A2.

**Parameters**

* **A1:** String to be intercepted

636

* **A2:** The final integer value

637

* **Length:** intercepts the length of the string

638

* **S:** Control single or double words.

639

** S=0, indicating an integer single word; S=1, indicating an integer double word.

640

641

**Return value:** none

**Example**

A2I("@W_HDW200","@W_HDW100",4,0) 'converts a string into a 16-bit (single word) decimal integer

647

648

A2I("@W_HDW600","@W_HDW500",4,1)' converts a string to a 32-bit (double word) decimal integer

649

650

651

**Input: **@W_HDW200="12345", **Result:** @W_HDW100=1234

652

653

**Input: **@W_HDW600="12345", **Result:** @W_HDW500=1234

654

655

(% class="box infomessage" %)

656

(((

657

**✎Note:** A1 and A2 need to be address (such as:@W_HDW000002).

)))

== **Abs** ==

**Function**

val = Abs(A1)

**Description**

The absolute value of A1.

**Parameters**

* **A1: **the data of absolute value, need to be variable.

673

* **Val: **it is absolute value that is address or variable.

**Example**

Dim a as integer 'a is defined as integer

679

680

a = SignedInt16("@W_HDW0")'convert the data of @W_HDW0 into signed data.

681

682

@W_HDW1 = Abs(a) 'assign the returned absolute value to @W_HDW1

683

684

685

**Input: **@W_HDW0=-6

686

687

**Result: **@W_HDW1=6

688

689

(% class="box infomessage" %)

690

(((

691

**✎Note: SignedInt16** function is designed to convert unsigned to signed.

)))

== **ACos** ==

**Function**

val = ACos(A1)

**Description**

To compute the inverse cosine value of A1.

**Parameters**

* **A1: **floating value, can be an address or variable.

707

* **Val: **return value is floating, can be an address or variable.

**Example**

Dim a ,b as floating'define two float variable a,b

713

714

a = 0.5 'assign the designated value to a

715

716

b = ACos(a) 'the inverse cosine value of "a" is a radian which assign to variable b.

717

718

'to add the following sentence if needed to view the return value:

719

720

float2d("@W_HDW200", b)'float b written into HDW200.

721

722

723

**Result:** @W_HDW200=1.047

724

725

(% class="box infomessage" %)

726

(((

727

**✎Note:** Please call **RadToDeg** function to convert radian into angle.

728

)))

729

730

== **AddrStringCompare** ==

**Function**

val = AddrStringCompare(A1, A2, length)

**Description**

It is designed to compare the designated length of two character strings. The string value is 1 when the two strings are the same.

**Parameters**

* **A1, A2: **character string, need to be an address (such as:"@W_HDW000002")

743

* **Length: **The length of character string.

744

* **Val: **Return value, 0 or 1.

**Example**

if AddrStringCompare("@W_HDW10","@W_HDW0",2)=1 then

750

751

'compare the character string of HDW10 and @W_HDW0 whether value are 1.

752

753

@W_HDW20=1 '@W_HDW20 display 1

else

@W_HDW20=0'@W_HDW20 display 0

Endif

**Input: **@W_HDW10="1a2 ", @W_HDW0="1a2 ",

763

764

**Result:** @W_HDW20=1

765

766

**Input: **@W_HDW10="ab2 ", @W_HDW0="12a ",

767

768

**Result: **@W_HDW20=0

== **Asc** ==

**Function**

val = Asc(A1)

**Description**

Return the first character of the string in ASCII value.

**Parameters**

* **A1:**character string, it can be an address (such as: @W_HDW000002)

783

* **val:**return value,ASCII value,it could be an address or variable.

**Example**

@W_HDW10 = Asc("A") 'return the ASCII value of A to HDW10

789

790

@W_HDW11 = Asc("a")'return the ASCII value of a to HDW11

791

792

@W_HDW12 = Asc("Apple") 'return the first character A of string Apple to HDW12

793

794

@W_HDW13 = Asc("123") 'return the first character ASCII value 1 of string 123 to HDW13.

**Result:**

* @W_HDW10 = 65

* @W_HDW11 = 97

* @W_HDW12 = 65

* @W_HDW13 = 49

== **AsFloating** ==

**Function**

val = AsFloating(A1)

**Description**

Convert parameter A1 to a float.

**Parameters**

* A1: integer variable.

817

* **val: **return float value, can be a variable or address.

**Example**

Dim a as integer 'define a integer variable {a}.

823

824

a = @W_HDW10 'assign @W_HDW10 to a

825

826

b = AsFloating(a) 'convert integer a to float then assign to b.

827

828

b = b/1.2 'add as following sentence when need to view the return value:

829

830

Float 2D("@W_HDW11",b) 'float variable b written into HDW11.

831

832

833

**Input: **@W_HDW10=24,

834

835

**Result: **@W_HDW11=20.00(set two decimals)

== **ASin** ==

**Function**

val = ASin(A1)

**Description**

Calculate the arcsine value of A1.

**Parameters**

* **A1: **Float can be an address or variable.

850

* **Val: **Return float value, can be an address or variable.

**Example**

Dim a, b as floating'define two float variable a,b

856

857

a = 0.5'assign the designated value to a

858

859

b=ASin(a) 'calculate the arcsine value of a ,assign the radian to b.

860

861

'Add the following command if need to view the return value:

862

863

float2d ("@W_HDW200", b) 'float variable b written into HDW200

864

865

866

**Result: **@W_HDW200=0.524

867

868

(% class="box infomessage" %)

869

(((

870

**✎Note:** Pleasecall **RadToDeg** function to convert radian into angle.

)))

== **AsInteger** ==

**Function**

val = AsInteger(A1)

**Description**

Convert parameter A1 to integer value.

**Parameters**

* **A1: **floating need to be a variable.

886

* **Val: **the value returned could can be a variable or address.

**Example**

Dim a as floating 'define floating variable a

892

893

a = D2Float("@W_HDW0",a) 'use D2Float function to save the float date of HDW0 in a

894

895

b= AsInteger(a) 'convert the float a into integer, the return value assigned to b

896

897

@W_HDW10=b 'save b to HDW10

898

899

900

**Input:** @W_HDW0=20.12,

901

902

**Result:** @W_HDW10=20

== **AsString** ==

**Function**

val = AsString(A1)

**Description**

Convert parameter A1 to a character string.

**Parameters**

* A1: not string parameter, it can be a variable.

917

* Val: return string value, variable or address.

**Example**

Script 1:

a=123 'assign a value to a

925

926

b=234 'assign a value to b

927

928

c=AsString(a)+AsString(b) 'convert a and b to string then add up the two strings ,assign the result to c.

929

930

@W_HDW0=c 'assign c to HDW0

d=a+b 'plus a with b

@W_HDW100=d 'assign d to (HDW100)

**Result: **

* @W_HDW0=123234

* @W_HDW100=357

Script 2:

W2S("@W_HDW200","@W_HDW300","02d")

946

947

W2S("@W_HDW210","@W_HDW400","02d")

948

949

W2S("@W_HDW220","@W_HDW500","02d")

950

951

@W_HDW0=AsString(@W_HDW300)+AsString(@W_HDW400)+AsString(@W_HDW500)

952

953

954

**Input: **@W_HDW200=12,@W_HDW210=34,@W_HDW220=56

955

956

**Result :**@W_HDW300=12,@W_HDW400=34,@W_HDW500=56,@W_HDW0=123456

957

958

(% class="box infomessage" %)

959

(((

960

**✎Note:** Ensure the data always is two words; otherwise occur error. reference the other chapter of W2S function

)))

== **ATan** ==

**Function**

var = ATan(A1)

**Description**

Return an arctangent value,the radian ranges -pi/2 to pi/2.

**Parameters**

* **A1: **Can be float, address or variable.

976

* **Val: **radian of return value.

**Example**

@W_HDW20= Atan(@W_HDW10)'save the arctangent value of (HDW10) to (HDW20)

982

983

984

**Input: **@W_HDW10=1.000,@W_HDW20=0.785

985

986

(% class="box infomessage" %)

987

(((

988

**✎Note:** Please call RadToDeg function convert radian to angle.

)))

== **ATan2** ==

**Function**

val = ATan2(A1,A2)

**Description**

Return the arctangent value of A1/A2,radian range

**Parameters**

* **A1, A2:** Address or variable.

1004

* **Val: **returned value is a radian, range -pi to pi.

1005

* **Notice: **ATan2 use sign of two parameters to define the quadrant of return value.

**Example**

//{{code language="lua"}}@W_HDW20= ATan2 (@W_HDW10,@W_HDW12)'save the arctangent value of (HDW10/HDW12) to (HDW20).{{/code}}//

1010

1011

**Input:**@W_HDW10=1.0,@W_HDW12=1.0,

1012

1013

**Result: **@W_HDW20=0.785

1014

1015

(% class="box infomessage" %)

1016

(((

1017

**✎Note:** Please call **RadToDeg** function convert radian to angle.

)))

== **B2W** ==

**Function**

B2W(A1, A2, length)

**Description**

Convert an array (begins with A2, unit: byte, to another array (begins with A1, unit: word).

**Parameters**

* **A1: **Saving address after converting

1033

* **A2: **Address of the value be converted

1034

* **Length:** The length of conversion

1035

1036

**Return value: **None

**Example**

//{{code language="lua"}}B2W(@W_HDW100,@W_HDW10,2) 'convert (@W_HDW10) to the length of 2,save as the result that begins with @W_HDW100.{{/code}}//

1041

1042

**Input: **@W_HDW10=1A2B

**Result: **

* @W_HDW100=2B

* @W_HDW101=1A

(% class="box infomessage" %)

(((

**✎Note:**

* A1 and A2 need to be address(e.g.: @W_HDW000002);

1054

* Length could be address or variable;

1055

* This is a subprogram; it has no returned value.

)))

== **BCD** ==

**Function**

val = BCD(A1)

**Description**

Convert A1(binary) to BCD, save the result as return value.

**Parameters**

* **A1: **The binary be converted; it can be an address or variable.

1071

* **Val: **Return value, BCD code; it can be an address or variable.

**Example**

//{{code language="lua"}}@W_HDW20=BCD(@W_HDW10) 'convert HDW10 (binary) to BCD code, then save in (HDW20){{/code}}//

1076

1077

**Input:** @W_HDW10=11111111(binary)

1078

1079

**Result:** @W_HDW20=255

1080

1081

(% class="box infomessage" %)

1082

(((

1083

**✎Note:** Return value is a word; it hexadecimal corresponds to BCD code.

)))

== **Beep** ==

**Function**

Beep()

**Description**

Enable buzzer

**Parameters**

None

**Example**

if @B_HDX100.0=1 then 'beep when the bit switch HDX100.0 set ON

beep()

endif

**Result: **HMI beep when bit switch HDX100.0 set ON.

== **BIN** ==

**Function**

Val = BIN(A1)

**Description**

Convert A1 (BCD) into binary, save the result in return value.

**Parameters**

* **A1:** The BCD code is converted; it can be address or variable.

1125

* **Val:** Return binary value,it can be address or variable.

**Example**

//{{code language="lua"}}@W_HDW20=BIN(@W_HDW10) 'convert HDW10(BCD) to binary, save the result in (HDW20){{/code}}//

1130

1131

**Input:** @W_HDW10=255

1132

1133

**Result:** @W_HDW20=11111111 (binary)

== **BMOV** ==

**Function**

BMOV(A1, A2,length)

**Description**

Copy data with a designated length from source address A2 to A1.

**Parameter**

* **A1:** saving address;

1148

* **A2:** source address;

1149

1150

**length:** operating length;

**Example**

@W_HDW20 = 20 'assign value to HDW20

1156

1157

@W_HDW21 = 21 'assign value to HDW21

1158

1159

@W_HDW22 = 22 'assign value to HDW22

1160

1161

BMOV(@W_HDW10,@W_HDW20,3) 'assign the word address of HDW20, HDW21, HDW22 to HDW10, HDW11, HDW12

**Result:**

* @W_HDW10 = 20

* @W_HDW11 = 21

* @W_HDW12 = 22

**✎Note:**

* A1 and A2 need to be address

1173

* Length can be an integer variable or an address. When destAddr and srcAddr are PLC (external device) addresses, the length range is 1-2048, and the 2049th address would not be operated when the range is exceeded.

1174

* When destAddr and srcAddr are HMI addresses, the length range is 1-4096, and This function is invalid when out of range.

== **Chr** ==

**Function**

val = Chr(A1, A2, ...)

**Description**

Convert integer parameter into correspond ASCII character, return the character string.

**Parameters**

* **A1, A2....:** converted integer; it can be an address or variable.

1189

* **Val: **returned value, can be an address or variable.

**Example**

@W_HDW100=Chr(@W_HDW20, @W_HDW21, @W_HDW22, @W_HDW23, @W_HDW24)

1195

1196

'convert the value of(HDW20, HDW21 ,HDW22, HDW23, HDW24) to ASCII character, assign the value to (HDW100)

1197

1198

1199

**Input** 72,69,76,76,79 step by step according to HDW20, HDW21, HDW22, HDW23, HDW24,

1200

1201

**Result: **returns HELLO to (@W_HDW100).

== **Clrb** ==

**Function**

ClrB(A1)

**Description**

Set the bit of A1 as FALSE (0).

**Parameters**

**A1:** System address(bit)

1216

1217

**✎Note:** subprogram has no return value.

**Example**

//{{code language="lua"}}ClrB(@B_HDX100.0) 'assign 0 to (@B_HDX100.0){{/code}}//

== **Constant** ==

**Description**

Script supported constant, users can use on script:

1228

1229

pi = 3.14159265358979321

TRUE = 1

FALSE = 0

**Example**

Dim a as integer 'define integer a

1239

1240

a = RadToDeg(pi) 'convert radian pi to angle then assign to a,RadToDeg function is used to convert radian to angle.

1241

1242

@W_HDW11 = a 'assign a to (HDW11)

1243

1244

1245

**Result: **@W_HDW11=180

== **CopyFile** ==

**Function**

A6=CopyFile(A1,A2,A3,A4,A5)

**Description**

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.

**Parameters**

* **A1: **the source path of the file to be copied.

1260

* **A2: **target path.

1261

* **A3:** the name of the file to be copied.

1262

* **A4: **copy type (0: copy file, 1: copy directory).

1263

* **A5: **Whether to overwrite the file with the same name when copying (0: Yes, 1: No).

1264

* **A6: **returned value.

1265

** 0: copy failed

1266

** 1: copy succeeded

1267

** 2: Parameter error

1268

** 3: U disk does not exist

1269

** 4: SD card does not exist

** 5: Path error

**Example**

Copy a single file:

@W_HDW100 = " test.csv"

1278

1279

CopyFile("UDisk/Test","Flash/Test","test.csv",0,0) 'Copy the Test.csv file in the UDisk/Test directory to the Flash/Test directory.

1280

1281

Can also be written as CopyFile("UDisk/Test","Flash/Test",@W_HDW100,0,0)

1282

1283

(2) Copy the entire directory file:

1284

1285

CopyFile("UDisk/Test","Flash/Test","",1,0) ' Copy the files in the UDisk/Test

1286

1287

directory to the Flash/Test directory.

1288

1289

1290

(% class="box infomessage" %)

(((

**✎Note:**

* Both source and destination paths need to begin with UDisk or Flash or SDCard;

1295

* A1 and A2 could be string (requires double quotes) or variable, maximum character length 127 allowed in path;

1296

* A3 could be a string, such as: [FileName] (requires double quotes); or address, such as: @W_HDW100 (no need to add double quotes);

1297

* A4 and A5 could be values, addressesor variable;

1298

* A6 could be address or variable.

)))

== **Cos** ==

**Function**

Val = Cos(A1)

**Description**

Return a cosine value of an angle.

**Parameters**

* **A1: **a float radian of angle, it can be an address or variable.

1314

* **Val: **return float value, it can be an address or variable.

**Example**

Dim a, b as floating 'define float a, b

1320

1321

b = pi/3 'convert the value of HDW11 to float and assign to 'b'.

1322

1323

a=Cos(b) 'return the cosine value of'b' and assign the result to 'a'.

1324

1325

'to add the following sentence if need to view the return value:

1326

1327

Float2D("@W_HDW20",a) 'the float value of a written into HDW13.

1328

1329

1330

**Result: **@W_HDW20=0.5

1331

1332

(% class="box infomessage" %)

1333

(((

1334

**✎Note:** Please call **RadToDeg** function convert radian to angle.

)))

== **D2F** ==

**Function**

D2F (A1, A2) or A1= D2F (A1, A2)

**Description**

Convert the 32-bit integer format data to float then output the result.

**Parameters**

* **A1: **required data, begin with"@";

1350

* **A2: **source data, begin with"@";

**Example**

D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).

1356

1357

@W_HDW2=D2F(@W_HDW2,@W_HDW0) 'convert the double word (HDW0) to float, save the result to (HDW2).

1358

1359

1360

**Result: **HDW0=100, HDW2=100

== **D2Float** ==

**Function**

F= D2Float("A1",F)

**Description**

Convert the designated value to floating then assign to variable.

**Parameters**

* **A1:** Source data;

1375

* **F:** User-defined floating variable

**Example**

dim F as floating 'define F as floating

1381

1382

F=D2Float("@W_HDW10",F) 'assign the value of (HDW10) to F in floating

1383

1384

Float2D("@W_HDW12",F) 'copy the floating value of F to HDW12 register,use to display result.

**Result: **

* HDW10=200,

* HDW12=200.

(% class="box infomessage" %)

1393

(((

1394

**✎Note:** A1 needs to be address;

)))

== **D2Int** ==

**Function**

A2= D2Float("A1",A2)

**Description**

Output the 32-bit integer in the form of integer.

**Parameters**

* **A1:** Source data can only be the HMI internal or external register starting with "@".

1410

* **A2: **Target data can only use theinteger variable defined by script.

**Example**

dim var1 as integer 'define var1 as integer

1416

1417

var1=D2Int("@W_HDW0",var1) 'Read out the 32-bit integer in HDW0 and save the result in var1.

HDW0=9999999

**Result:** Var1=9999999

1423

1424

== **DataLogToUorSD** ==

**Function**

DataLogToUorSD (A1, A2, A3, A4, A5, A6, A7, A8)

**Description**

Exported Data record (database file) as db or csv format file, and register HSW1853 can change the exported file type．

1433

1434

(HSW1853 = 0: exported as db format, filename format: Start time-end time-group name.db)

1435

1436

(HSW1853 = 1: exported as csv format, filename format: Start time-end time-group name.csv)

**Parameters**

* A1: Data record group name address (string, must be address). For example: " @W_HDW30 "

1441

* A2: Start time address (string, must be address). For example: " @W_HDW40 "

1442

* A3: End time address (string, must be address). For example: " @W_HDW50 "

1443

* A4: db file save location (integer value)

1444

** = 1: Saved on SD card

1445

** = 2: Save in USB flash drive

1446

* 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:

1447

** = 1: Script executed successfully

1448

** = 100: U disk or SD card unplugged

1449

** = 101: U disk or SD card does not exist

1450

** = 102: Script executed failed

1451

** = 201: db export failed

1452

** = 203: Script is being executed (previous executed script doesn't exit)

1453

* A6: Script running mode (integer value)

1454

** = 1: Wait for script execution before exit

1455

** = 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)

1456

* 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.

1457

* A8: Reserved address (string, must be address). For example:" @W_HDW80 ". This address is temporarily useless but needs to be set.

**Example**

@W_HDW30 = "Record test" 'Data record group name

@W_HDW40 = 2021

@W_HDW41 = 04

@W_HDW42 = 30

@W_HDW43 = 09

@W_HDW44 = 0

@W_HDW45 = 0

'Start time 2021-04-30 09:00:00

@W_HDW50 = 2021

@W_HDW51 = 04

@W_HDW52 = 30

@W_HDW53 = 20

@W_HDW54 = 0

@W_HDW55 = 0

'End time 2021-04-30 20:00:00

1477

@W_HDW70 = "Log" 'Directory name

1478

1479

DataLogToUorSD ("@ W_HDW30", "@ W_HDW40", "@ W_HDW50", 2, "@ W_HDW60", 1, "@ W_HDW70", "@ W_HDW80")

1480

1481

'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).

1482

1483

1484

== **DbToCSVFile** ==

**Function**

A8=DbToCSVFile(A1,A2,A3,A4,A5,A6,A7)

**Description**

Convert db (database file) file to csv format and export it.

**Parameters**

* **A1: **db file save path (value is integer);

1497

** =0: Alarm record file in HMI flash;

1498

** =1: Alarm record file in UDisk (USB flash disk);

1499

** =2: Alarm record file in SD card;

1500

** =3: Data record file in HMI flash;

1501

** =4: Data record file in UDisk (USB flash disk);

1502

** =5: Data record file in SD card;

1503

* **A2: **group numer of db file (value is integer);

1504

** Used during exporting data record file, the group number could be seen in the data record setting interface;

1505

* **A3:** csv file save path (value is integer);

1506

** =0: Save in UDisk (USB flash disk);

1507

** =1: Save in SD card;

1508

* **A4: **csv name;

1509

* **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);

1510

* **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);

1511

* **A7:** csv encoding format;

1512

** =0 UTF8 format;

1513

** =1 GBK format;

1514

* **A8:** returned value;

1515

** =0: Failed to export;

1516

** =1: Exported;

1517

** =2: db file path error;

1518

** =3: U disk or SD card does not exist;

1519

** =4: csv name error;

1520

** =5: db file does not exist;

1521

** =6: csv file already exists;

**Example**

* @W_HDW100 = 2018

* @W_HDW101 = 12

* @W_HDW102 = 25

* @W_HDW103 = 19

* @W_HDW104 = 10

* @W_HDW105 = 30

* @W_HDW200 = 2018

* @W_HDW201 = 12

* @W_HDW202 = 25

* @W_HDW203 = 20

* @W_HDW204 = 10

* @W_HDW205 = 30

**Export data record file**

1539

1540

1541

DbToCsvFile(3,2,0,"123.csv","@W_HDW100","@W_HDW200",0)

1542

'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

1543

'are exported to the 123.csv file in the Udisk in UTF8 format.

1544

1545

1546

**Export alarm record file**

1547

1548

1549

DbToCsvFile(0,0,0,"456.csv","@W_HDW100","@W_HDW200",1)

1550

'The alarm records generated in HMI Flash at 2018.12.25 19:10:30-2018.12.25 20:10:30

1551

'are exported to the 456.csv file in the Udisk in GBK format

1552

1553

1554

(% class="box infomessage" %)

(((

**✎Note:**

* A1 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;

1559

* A2 can be an address or a variable or a value;

1560

* A3 can be an address or a variable or a value, and the path need to start with UDisk or Flash or SDCard;

1561

* 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;

1562

* A5 need to be an address;

1563

* A6 need to be an address;

1564

* A7 can be an address or a variable or a value;

)))

== **DegToRad** ==

**Function**

A2 = DegToRad(A1)

**Description**

Convert the angle into correspond radian, and display.

**Parameters**

* **A1:** inputting angle supports address, other variable or floating.

1580

* **A2: **outputting radian supports address, other variable or floating.

**Example**

Script 1

//{{code language="lua"}}@W_HDW12=DegToRad(@W_HDW10) 'input angle on (HDW10),convert to correspond redian and copy to (HDW12){{/code}}//

1587

1588

**Result: **HDW10=180; HDW12=3.14159

Script 2

dim a as floating 'set variable

1594

1595

dim b as floating 'set variable

b=30 'input angle

a=DegToRad(b) 'convert the length of radian and copy to variable {a}

1600

1601

float2d("@W_HDW0", a) 'display the value of floating on(HDW0)

1602

1603

1604

**Result:** HDW0=0.52360

1605

1606

== **DIM ... AS ...** ==

**Function**

Dim "variable" as "date type"

**Description**

Declare a variable, stable the type of data.

**Parameters**

* **Variable: **begin with letter, other character can be letter, numbers, underscores ('_'), need to begin with '@' if it is address;

1619

* **Data type: **string,floating,integer;

**Example**

dim a as integer 'define a as integer

1625

1626

dim @W_HDW0 as floating 'define @W_HDW0 as floating

1627

1628

dim hi as string 'define "hi" as string

**Result:**

a is integer

@W_HDW0 is floating

hi is string

(% class="box infomessage" %)

1640

(((

1641

**✎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.

1642

)))

1643

1644

== **DO ... LOOP** ==

**Function**

Do [While | Until condition]

[statements]

Loop

or

Do

[statements]

Loop [While | Until condition]

**Description**

Condition determent instruction.

1665

1666

* Do while.loop executes an instruction of block repeatedly when condition is true.

1667

* Do until.loop executes an instruction of block repeatedly until condition is false.

**Parameters**

**Condition: **determine condition; obtain the expression of True or False.

1672

1673

**Statements: **execute one or more instructions repeatedly when condition is True or until condition is True.

1674

1675

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.

**Example**

dim i as integer 'end DO loop when i=100

do while i<100

i=i+1

@W_HDW0=i

loop

**Result: **HDW0=100

== **End** ==

**Function**

Terminates the script immediately.

**Description**

End the execution of script.

**Parameters**

**Statement:** Judging condition, use with IF together. end script when meet condition.

**Example**

//{{code language="lua"}}If a = 10 Then End 'end script when a=10.{{/code}}//

1710

1711

**Result:** End the script program.

== **Exp** ==

**Function**

A1=Exp(A2)

**Description**

Returns the power value of e (natural logarithm), save the outputting result to A1, e=2.71828182846.

**Parameters**

* **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]](%%));

1726

* **A2: **Source data, natural exponential function, need to be integer or variable. Could not not begin with the address of "@"(e.g.@W_HDW10)

**Example**

dim a as integer'define a as integer

1732

1733

a = @W_HDW2 ' assign the value of (HDW2) to variable a

1734

1735

@W_HDW0= Exp(a)'exponential is the value of (HDW2),save result to(HDW0)

**Result:**

* HDW2=2,

* HDW0=7.38905600

== **F2D** ==

**Function**

F2D (A1, A2)

**Description**

Convert a 32 bit floating to integer format, then output the result.

**Parameters**

* **A1: **Destination, the value can be an address(e.g.@W_HDW12).

1756

* **A2: **source date, it can be an address or other variable.

**Example**

//{{code language="lua"}}F2D(@W_HDW12,@W_HDW10) 'convert the floating of (HDW10) to integer, save in (HDW12).{{/code}}//

**Result:**

* HDW10=200,

* HDW12=200

== **F2S** ==

**Function**

F2S (A1,A2,s1)

**Description**

Output a format of floating that in the type of string.

**Parameters**

* **A1:** Source address, used to store floating, the value is an address(e.g.@W_HDW200);

1780

* **A2:** Destination address, used to store string after converted, value is an address(e.g.@W_HDW100).

1781

* **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.

**Example**

//{{code language="lua"}}F2S("@W_HDW200", "@W_HDW100", "03.03f") '(HDW200) is floating input,(HDW100) is text output;{{/code}}//

**Result: **

* HDW200=1.22365,

* HDW100=1.224

== **FileCmpDir** ==

**Function**

FileCmpDir(A1, A2, A3, A4, A5, A6, A7, A8, A9)

**Description**

The filename input and the filename in the folder whether is duplicate or not.

**Parameters**

A1: file path (value is integer);

In HMI:

* =0: Recipe folder in HMI flash;

1809

* =1: Custom folder in UDisk (USB flash disk);

1810

* =2: Custom folder in SD card.

1811

* =3: Custom folder in HMI flash;

In simulator:

* = 0: D:/Recipe/

* = 1: C:/WECON/CustomFileDir/

1817

* = 2: C:/WECON/CustomFileDir/

1818

* = 3: C:/WECON/CustomFileDir/

**✎Note:**

A1 can be an address,variable or fixed value.

1823

1824

A2: file name (value is string);

1825

1826

The file name would be compared;

**✎Note: **

A2 can be an address, variable or string. The length of file name cannot exceed 32 characters.

1831

1832

A3: folder name (value is integer);

1833

1834

The folder name would be compared;

**✎Note: **

A3 can be an address, variable or string. The length of file name cannot exceed 32 characters.

1839

1840

A4:file name display address (value is a string);

1841

1842

Display the specified number of file names in the specified folder.

**✎Note:**

A4 Can only use address here. And the length of the file name cannot exceed 32 characters.

1847

1848

A5: Function type (value is an integer)

1849

1850

~= 0: compare whether the file name in the folder and the file name input are duplicated or not.

1851

1852

~= 1: return list of file names.

1853

1854

~= 100: compare file names, without input suffix .csv

**✎Note: **

A5 can be an address, variable or value.

1859

1860

A6: Return value (value is an integer)

1861

1862

~= 1: Successfully opened the folder.

1863

1864

~= 2: Failed to open the folder.

1865

1866

~= 3: The file has duplicate names

**✎Note:**

A6 must be an address.

1871

1872

A7: File number (value is an integer)

1873

1874

Display the number of files in the folder (up to 100)

**✎Note: **

A7 must be an address.

1879

1880

A8: File creation time (value is a string);

1881

1882

Display the time of file creation, time occupies 32 characters

1883

1884

A9: The maximum number of files to read (value is an integer)

1885

1886

Set the maximum number of files to read (up to 100 files)

1887

1888

**✎Note:** A9 can be an address, variable or value.

**Example**

Read the specified number of files in the folder.

(% class="box" %)

(((

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.

1897

)))

1898

1899

Compare filename input and the filename in the folder whether is duplicate or not.

(% class="box" %)

(((

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

1904

)))

1905

1906

Compare the csv file name in the folder and the csv file name input whether is duplicated or not.

(% class="box" %)

(((

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

)))

== **FILL** ==

**Function**

FILL (A1, A2, A3)

**Description**

Write the same value to designated address constantly.

**Parameters**

**A1:** The beginning address, it can be an address (e.g.@ W_ HDW25);

1926

1927

**A2:** Source data, it needs to be written in continuous value, the value can be an address, variable or constant;

1928

1929

**A3:** The number of operation, writing address number, it can be an address, variable or constant;

1930

1931

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.

1932

1933

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.

**Example**

//FILL (@W_HDW25, 10, 3) 'At the beginning three address of @W_ HDW25 is 10.//

1938

1939

**Result: **At the beginning three address of @W_ HDW25 is 10, @W_ HDW25=10, @W_ HDW26=10, @W_ HDW27=10.

== **Float2D** ==

**Function**

Float2D (A1,A2);

**Description**

Copy floating value to the address.

**Parameters**

* **A1: **Goal address, the value need to be address (e.g.@W_HDW102);

1954

* **A2:** Source data, it can be floating;

**Example**

dim f as floating 'define f as floating

1960

1961

f=1.1 'assign a designated value to f

1962

1963

Float2D ("@W_HDW102",f) 'assign the value f to HDW102

1964

1965

1966

**Result:** HDW102=1.1

1967

1968

== **For. to. step. next** ==

**Function**

For counter = start to end Step

[Statements]

**Description**

Execute a command repeatedly for designated times.

**Parameters**

* **counter: **Work as a variable for loop counter;

1985

* **start: **The start value of counter, it could be any variable type or expression;

1986

* **end: **The end value of counter, it could be any variable type or expression;

1987

* **step: **Every loop, the changed value of counter is step value, step default if it is not designation. Step default as below:

1988

** if start>end, step default is 1;

1989

** if start< end. It could be any variable type or expression;

1990

* **statements: **Between For with Next, execute instruction set of designated times;

1991

** 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.

**Example**

'Use HDX2.0 to trigger the loop

1997

1998

for i=100 to 0 step -5 ' set the start is 100,end is 0,subtract 5 every time, execute 20 times totally.

1999

2000

@W_HDW100=@W_HDW100+1 ' execute (HDW100+1) 21 times totally, the final result is 21.

@B_HDX2.0=0

**Result: **HDW100=21

== **Function** ==

**Function**

* Function name (arglist)

* statements

* name = expression

* statements

* End Function

**Description**

Unlike internal function, it needs to declare the name, parameter, code of the function.

**Parameters**

* **Name: **function name.

2026

* **arglist: **stands for the variable list of parameter, this parameter will be entered during calling function. use comma to separate.

2027

* **statements: **a set of code in running function body.

2028

2029

**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.

**Example**

Function sincos (angle as floating)

2035

2036

sincos = sin(angle) + cos(angle)

End Function<

........

@W_0002 = sincos(pi/2)

........

== **GetServerDelayInfo** ==

**Function**

A3=GetSerVerDelayInfo(A1,A2)

**Description**

Convert string A1 to hexadecimal number.

**Parameters**

**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).

2060

2061

(% class="table-bordered" %)

2062

|=**Address**|=**Description**

2063

|A1|Delay data of the server configured in [Project Settings]

2064

|A1+1|Delay data of Server 1

2065

|A1+2|Delay data of Server 2

2066

2067

**A2: **Server test result address

2068

2069

(% class="table-bordered" %)

2070

|=(% style="width: 239px;" %)**Address**|=(% style="width: 1250px;" %)**Description**

2071

|(% style="width:239px" %)0 bit|(% style="width:1250px" %)Set ON, Server configured in [Project Settings] fails

2072

|(% style="width:239px" %)1^^st^^bit|(% style="width:1250px" %)Set ON, Server 1 fails

2073

|(% style="width:239px" %)2^^nd^^bit|(% style="width:1250px" %)Set ON, Server 2 fails

2074

|(% style="width:239px" %)3^^rd^^~~ 10^^th^^bits|(% style="width:1250px" %)Reserved

2075

|(% style="width:239px" %)11^^th^^bit|(% style="width:1250px" %)Set ON, network error, network port interface failure

2076

2077

**A3:**Returns the preferred server number or network status (automatically selects the server with the best connection network status).

2078

2079

* =0: Server configured in [Project Settings];

* =1: Server 1;

* =2: Server 2;

* =3~~10: Reserved;

* =100: Try again later (two test intervals need to wait 30 seconds);

2084

* =101: Failed to test Server;

**Example**

//{{code language="lua"}}@W_HDW200 = GetServerDelayInfo("@W_HDW100", "@W_HDW50"){{/code}}//

Result:

* HDW100: Delay data of the server configured in [Project Settings]

2093

* HDW101: Delay data of Server 1

2094

* HDW102: Delay data of Server 2

2095

* HDX50.0=1:Server configured in [Project Settings] fails

2096

* HDX50.1=1: Server 1 fails

2097

* HDX50.2=1:Server 2 fails;

2098

* HDX50.11= 1: network error, network port interface failure;

2099

2100

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.

2101

2102

(% class="box infomessage" %)

2103

(((

2104

**✎Note:** The time interval between executions of this function could not be less than 30 seconds, otherwise an error will occur.

)))

== **Goto** ==

**Function**

Goto label

**Description**

Go to the designated row without any condition in a function body.

**Parameters**

* **Label:** target character, start with letter in row label, end with(:)of any string.row label has no sensitive to the format of letter.

**Example**

//Goto sd 'go to the row which start with "sd";//

2124

2125

**Result:** Go to sd row.

2126

2127

(% class="box infomessage" %)

2128

(((

2129

**✎Note:** Goto only can jump into the internal function that visible row.

)))

== **H2A** ==

**Function**

A1 = H2A (A2)

**Description**

Convert a binary (16-bit) to hexadecimals (4-bit) of ASCII.

**Parameters**

* **A1: **Returned value, string, it could be an address or variable.

2145

* **A2: **Binary is needed to be converted, the value could be a address or variable.

**Example**

//{{code language="lua"}}@W_HDW100= H2A (@W_HDW0) ' convert the binary of (HDW0) to character and save in (HDW100).{{/code}}//

**Result:**

* HDW0=200,

* HDW=100

== **HmiRegoperator** ==

**Function**

HmiRegoperator (A1,A2,A3,A4,A5,A6)

**Description**

Data of Upload/ Download address

**Parameters**

* **A1: **The start address of target

2169

* **A2: **Length, address length, unit: word, range: 1~~1000

2170

* **A3: s**torage

2171

** A3=0, select USB flash disk as storage, and save files in Root directory;

2172

** A3=1, select SD card as storage, and save files in Root directory;

2173

* **A4: **File name address, itneed to be address such as"@ W_HDW2"

2174

* **A5**: Upload / download data

2175

** A5=0, save the data in the specified address as a file and store the file in the root directory;

2176

** A5=1, Read data from file and it woule be written into specified address;

2177

* **A6:** State display, it needs to be address, such as "@ W_HDW2";

2178

** A6=1, Normal

2179

** A6=2, USB flash disk/ SD card does not exist

2180

** A6=3, File doesn’t exist;

2181

** A6=4, File name error;

2182

** A6=5, Check error

2183

** A6=6, Abnormal communication;

2184

** A6=7, HUW register is not allowed;

2185

** A6=8, Address length range error (address length range: 1-1000);

**Example**

Script 1

(% class="box" %)

(((

//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.//

)))

Script 2

(% class="box" %)

(((

//HmiRegoperator("@W_HDW0",10,1,"@W_HDW2000",1,"@W_HDW3000")//

2201

2202

//Read the values from files which stored in the SD card (files named by the HDW2000), and write these values to the HDW0-HDW10.//

)))

**✎Note:**

* 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).

2208

* The interval of download function operation should be 5s or more.

2209

* A1 need to be address such as “@W_HDW2”.

2210

* 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.

== **Hypot** ==

**Function**

Var = Hypot (expr1, expr2)

**Description**

Calculate the value of the hypotenuse of a right triangle.

**Parameters**

* **expr1, expr2: **Source data, the two sides of right triangle. it need to be address;

2225

* **Var:** Destination data,it need to be address;

**Example**

(% class="box" %)

(((

//@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).//

)))

**Result: **

* HDW105=3,

* HDW108=4,

* HDW200=5

(% class="box infomessage" %)

2241

(((

2242

**✎Note:** hypot function could support integer and floating when the format of source data and target data are the same.

2243

)))

2244

2245

== **IF ... THEN ... ELSE ... END IF** ==

**Function**

If condition Then

Statements

[Else

else statements]

End If

**Description**

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.

**Parameters**

* **condition: **any expression, the value could be true or false.

2266

* **statement: **execute the instruction block when condition is true.

2267

* **else statement: **execute the instruction block when condition is false.

**Example**

if @W_HDW105=200 then ' judging condition: whether the value of (HDW105) is 200

2273

2274

@W_HDW108=1 'the value of (HDW108) is 1 if fulfil condition

else

@W_HDW200=1 ' the value of (HDW200) is 1 if not fulfil condition.

Endif

**Result:**

* HDW105=199;

* HDW108=0;

* HDW200=1

== **InStr** ==

**Function**

var = InStr ("str1", "str2")

**Description**

Returned the position of str1 in str2(start with 0), set -1 if no result.

**Parameters**

* **str1:** source string, it could only be string, not address;

2302

* **str2:** target string, it could only be string, not address;

2303

* **var:** Returned value, the format of data needs to be string;

**Example**

dim a as floating

a = InStr ("Hello", "o") ' calculate the position of"o"in"hello".

2311

2312

float2d ("@W_HDW0",a) ' Returned value is 4.(start with 0)

**Result:** HDW0=4

== **Int2D** ==

**Function**

Int2D("A1",A2)

**Description**

Write the 32-bit integer into the target address

**Parameters**

* **A1: **Source data could only be the HMI internal or external register starting with "@".

2330

* **A2:** Target data could only use the integer variable defined by script.

**Example**

dim var1 as integer 'define var1 as integer

2336

2337

Int2D("@W_HDW0", var1) 'Read out the 32-bit integer in var1 and save the result in HDW0 .

var1=9999999,

**Result:** HDW0=9999999.

== **InvB** ==

**Function**

InvB (A1)

**Description**

The state of inverse bit, it is a sub function, no returned value. Achieve the state of switching address constantly.

**Parameters**

* **A1:** it is an address.

**Example**

//{{code language="lua"}}InvB (@B_HDX0.1) 'switch the state if (HDX0.1).{{/code}}//

2361

2362

**Result: **Switch the state of (HDX0.1) constantly.

== **IsFloating** ==

**Function**

A2=IsFloating (A1)

**Description**

Decide whether a parameter is floating, return true if it is floating, otherwise return FALSE.

**Parameter**

* **A1:** source data, variable;

2377

* **A2:** target data, variable;

**Example**

dim a as integer

dim b as floating

b= D2float ("@W_HDW200",b) 'assign the value of (HDW200) to b

2387

2388

a = IsFloating (b) 'judge whether b is floating or not

2389

2390

@W_HDW300=a 'save the result to (HDW300)

**Result: **HDW300=1

== **IsInteger** ==

**Function**

A2= IsInteger (A1)

**Description**

Determine whether a parameter(A1) is integer, return TRUE if the parameter is integer, otherwise return FALSE.

**Parameter**

* **A1:** Source date, it is variable or number;

2408

* **A2:** Target date, need to be variable, it could not be system address ;

**Example**

dim a as integer

a = IsInteger (20) 'determine whether 20 is integer

2416

2417

@W_HDW300=a ' display the result on (HDW300)

**Result:** HDW300=1

== **IsString** ==

**Function**

val = IsString(expr)

**Description**

Determine whether a parameter is string, return TRUE if it is string, otherwise return FALSE.

**Parameters**

* **Expr:** source string, it could be a variable or string, not address;

2435

* **Val:** target date, the result need to be variable, could not be address;

**Example**

dim a as integer 'define variable, display the result;

2441

2442

a= isstring ("hello") 'determine whether"hello"is string;

2443

2444

@W_HDW0=a 'assign the result to (HDW0)

**Result: **HDW=1

== **Lcase** ==

**Function**

A2 = LCase(A1)

**Description**

Convert all parameters to lowercase strings.

**Parameters**

* **A1: **source string, it could be an address or variable;

2462

* **A2: **outputting string, it could be an address or variable;

**Example**

(% class="box" %)

(((

//@W_HDW33 = LCase (@W_HDW25) 'input source sting on (HDW25), convert it to destination string and display the result on (HDW33);//

2469

)))

2470

2471

**Result:** HDW25=HELLO

HDW33=hello

== **Left** ==

**Function**

Val =Left (String, Length)

**Description**

Return a string of the specified length from the left side of parameter.

**Parameters**

* **String:** source string; it could be an address or string.

2488

* **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.

2489

* **Val: **destination string, outputting string, it could be an address or variable.

**Example**

(% class="box" %)

(((

//@W_HDW30=Left (@W_HDW36, @W_HDW40) '(HDW36) used to input source string,(HDW30) used to display the string result;//

)))

Result:

* HDW36=hello,

* HDW40=2,

* HDW30=he

== **Len** ==

**Function**

Length=Len(String)

**Description**

Return the string length.

**Parameters**

* **String:** source string, it could be a address or string;

2517

* **Length:** target data, return value, it could be a address, variable, integer or floating;

**Example**

//{{code language="lua"}}@W_HDW30=Len (@W_HDW36) 'count the character number of (HDW36), save the result to (HDW30);{{/code}}//

**Result:**

* HDW36=hello

* HDW30=5

== **Log** ==

**Function**

a= Logn (x)=Log(x)/Log(n)

**Description**

Log function:return the natural logarithm of the value.

**Parameters**

* **a: **source date,it could be a variable, but it could not be address;

2541

* **x, n:** source date, it could be a variable, but it could not be address;

**Example**

Dim a as integer 'define a as integer;

2547

2548

Dim b as integer 'define b as integer;

2549

2550

Dim c as integer 'define c as integer;

2551

2552

b=@W_HDW10 'assigns a value to b

2553

2554

c=@W_HDW20 'assigns a value to c

2555

2556

a=Log (b)/Log(c) 'calculate logarithm

@W_HDW0

=a 'assign the result to (HDW0)

**Result:**

* HDW10=27,

* HDW20=3,

* HDW0=3

== **Log10** ==

**Function**

a=Log10(x)= Log(x) / Log(10)

**Description**

Log function: return the natural logarithm.

**Parameters**

* **A:** target data, result could be variable, could not be address;

2582

* **x:** source data, it could be variable that needs to be the multiples of 10, can’t be address

**Example**

dim a as integer 'define a as integer

2588

2589

dim b as integer 'define b as integer

2590

2591

b=@W_HDW10 'assign a value to b

2592

2593

a= Log (b)/Log(10) 'result

2594

2595

@W_HDW0=a 'assign the result to (HDW0)

**Result: **

* HDW10=100,

* HDW0=2

== **LTrim** ==

**Function**

val=LTrim("string")

**Description**

Remove the left empty part of the string and return.

**Parameters**

* **Val:** Destination string, it could be either a variable or address;

2616

* **string:** Source string, it could be either a variable or address;

**Example**

dim a as string

a=Ltrim("hello")

@W_HDW103=a

**Result:** HDW103=hello

== **MAX** ==

**Function**

A1=MAX(A2,A3)

**Description**

Compare the value of A2 and A3, assign the greater value to A1.

**Parameters**

* **A1:** Return value (used to store the greater value between A2 with A3).

2643

* **A2:** The first comparison value.

2644

* **A3:** The second comparison value.

2645

2646

(% class="box infomessage" %)

2647

(((

2648

**✎Note:** A1,A2,A3 should be only used in unsigned integer or unsigned address.

)))

**Example**

DIM A1 as integer

@W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.

2657

2658

@W_HDW107=5 'assign the value to (?@W_HDW107),unsigned decimal word.

2659

2660

A1 = Max(@W_HDW106,@W_HDW107)

@W_HDW105 = A1

**Result: **@W_HDW105 = 10

== **Mid** ==

**Function**

A1=mid(A2, start, length)

**Description**

Returns a string contain a specified characters length from a string.

**Parameters**

* **A1:** string contains the selected characters, it needs to be a string

2680

* **A2:** string to be selected, it needs to be a variable or address

2681

* **Start:** the start position of string, it needs to be a variable or address, it means that count begin with 0.

2682

* **Length:** the designated length of string, maximum character length 127 allowed

**Example**

DIM A1 as string

A1 = Mid("hellokitty",1,2) 'select the string of in "

@W_HDW106=A1

**Result: **@W_HDW106 'display "el" on text input and output window

== **MIN** ==

**Function**

A1=MIN(A2,A3)

**Description**

Compare the value of A2 and A3, assign the smaller value to A1.

**Parameters**

* **A1: **Return value (used to store the snaker value between A2 with A3).

2709

* **A2: **The first comparison value.

2710

* **A3: **The second comparison value.

**Example**

DIM A1 as integer

@W_HDW106=10 'assign the value to (@W_HDW106), unsigned decimal word.

2718

2719

@W_HDW107=5 'assign the value to (@W_HDW107), unsigned decimal word.

2720

2721

A1 = Min(@W_HDW106,@W_HDW107)

@W_HDW105 = A1

**Result:** @W_HDW105 = 5

2727

2728

**✎Note:** A1, A2,A3 only used in unsigned integer or unsigned address.

== **MSeconds** ==

**Function**

A1=MSeconds( )

**Description**

A1 is used to display the current milliseconds of system.

**Parameters**

* **A1: **used to store the current milliseconds of system.

**Example**

DIM A1 as integer

@W_HDW0= 10 'assign a value to (@W_HDW0), unsigned decimal word

2750

2751

A1=MSeconds() 'return the current milliseconds of system to A1

@W_HDW0=A1

@W_HDW1=A1>>16 'display milliseconds on screen, (HDW0) is an 32-bit unsigned decimal integer address

2756

2757

2758

**Result:** @W_HDW0 will generate the time value of changing milliseconds unit.

2759

2760

(% class="box infomessage" %)

(((

**✎Note:**

* A1 is 32-bit unsigned integer variable or unsigned integer address;

2765

* 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);

2766

)))

2767

2768

== **MyDeleteFile** ==

**Function**

MyDeleteFile (A1,A2,A3,A4,A5)

**Description**

Delete the specified file

**Parameters**

A1: File location (value is an integer);

In HMI:

* =0: Recipe folder in HMI flash;

2785

* =1: Custom folder in UDisk (USB flash disk);

2786

* = 2: Custom folder in SD card.

2787

* =3: Custom folder in HMI flash;

In simulator:

* = 0: D:/Recipe/

* = 1: C:/WECON/CustomFileDir/

2793

* = 2: C:/WECON/CustomFileDir/

2794

* = 3: C:/WECON/CustomFileDir/

**✎Note:**

A1 can be an address, variable or value.

2799

2800

A2: filename (value is string);

2801

2802

Input the name of the file want to delete.

**✎Note: **

A2 can be an address , variable or a character string, and the length of the file name cannot exceed 32 characters.

2807

2808

A3: folder name (value is integer);

2809

2810

Input the folder where the file want to delete.

**✎Note: **

A3 can be an address , variable or a character string, and the length of the folder name cannot exceed 32 characters.

2815

2816

A4: Delete function type (value is integer)

2817

2818

* = 0: Delete the specified file.

2819

* = 1: Delete all files.

**✎Note: **

A4 can be an address , variable or value.

2824

2825

A5: Return value (value is an integer)

2826

2827

* = 0: parameter error

2828

* = 1: Delete successfully

2829

* = 2: Delete failed

2830

* = 3: Failed to open file

2831

2832

**✎Note:** A5 must be an address.

**Example**

(% class="box" %)

(((

MyDeleteFile(@W_HDW1254,@W_HDW4200,@W_HDW4300,@W_HDW1250,"@W_HDW1252")

2839

2840

‘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.

)))

== **NewNoAddr** ==

**Function**

A1= NewNoAddr (A2, length)

**Description**

At the basic of source address A2, offset designated length, obtain a new address A1.

**Parameters**

* **A1: **address after offsetting, it must be String type variable.

2856

* **A2:** source address, it must be an address(e.g.:"@W_HDW2")

2857

* **Length: **offset length, it must be a constant or an integer variable.

**Example**

DIM A1 as string

A1=NewNoAddr("@W_HDW0",50) '(HDW0) offsets 50 words address (16 bit), and save the result to A1

2865

2866

@W_HDW1=A1 '(HDW50) save in A1

2867

2868

2869

**Result: **(@W_HDW1) character input/display will show @W_HDW50

2870

2871

== **NewStatAddr** ==

**Function**

A1= NewStatAddr (A2, length)

**Description**

At the basic of source address A2, offset the designated length, to obtain a new station A1.

**Parameters**

* **A1: **The address after offsetting, it needs to be variable.

2884

* **A2:** Source station address, it needs to be address (e.g.:"@W_1:10").

2885

* **Length: **offset length

**Example**

DIM A1 as string

A1=NewStatAddr("@W_1:10",2) 'address 10 of station address 1 that offset 2 station addresses, then save the result to A1

2893

2894

@W_HDW1=A1 'address 3:10 is saved in A1

2895

2896

2897

**Result: **@W_HDW1 character input/display will show @W_3:10

2898

2899

== **NStringCompare** ==

**Function**

A1= NStringCompare (A2, A3, length)

**Description**

Compare whether the designated length of two strings is the same, return 1 to A1 if yes, otherwise return 0.

**Parameters**

* **A1: **Returned value (compare the designated length of two strings, display 1 when equal, else 0). It could be an address or variable.

2912

* **A2: **the address of string to be compared, it needs to be address.

2913

* **A3: **source string, it needs to be variable or constant string.

2914

* **Length: **string length to be compared

**Example**

@W_HDW1= NStringCompare("@W_HDW0","87654",5)

if @W_HDW1=1 then

@B_HDX10.0=1 'result: HDX10.0 set ON 'when the two strings are the same.

endif

if @W_HDW1=0 then

@B_HDX10.0=0 'result:HDX10.0 set OFF 'when not equal.

Endif

== **Operator** ==

(% class="table-bordered" %)

2937

|=(% scope="row" %)**Operation**|=**Symbol**|=**Example**|=**Return type**

2938

|=Addition|+|A1=A2+A3|Return type depending on the type of variable or address of the addition

2939

|=Subtraction|-|A1=A2-A3|Return type depending on the type of variable or address of the subtraction

2940

|=Multiplication|*|A1=A2*A3|Return type depending on the type of variable or address of the multiplication

2941

|=Division|/|A1=A2/A3|Return type depending on the type of variable or address of the division

2942

|=Remainder|Mod ~(%)|(((

A1=A2 mod A3

A1=A2%A3

)))|Returns the remainder of the division of two numbers. The type of the return value is an integer

2947

|=Logical OR|Or(~|)|(((

A1=A2 or A3

A1=A2|A3

)))|Returns the result of a logical OR. The type of the return value is an integer.

2952

|=Logic AND|And (&)|(((

A1=A2 and A3

A1=A2&A3

)))|Returns the result of a logical AND. The type of the return value is an integer.

2957

|=Logical XOR|Xor (^)|(((

A1=A2 xor A3

A1=A2^A3

)))|Returns the result of a logical XOR. The type of the return value is an integer.

2962

|=Logical reversal|Not (!)|(((

A1=not A1

A1=A2!A3

)))|Returns the result of a logical reversal. The type of the return value is an integer.

2967

|=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.

2968

|=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.

2969

|=Bit reversal|~~|A1=~~A1|Perform a bit reversal on a value. The type of the return value is an integer.

2970

2971

== **PI_GetTickCount** ==

**Function**

PI_GetTickCount (A1, A2)

**Description**

Writethe startingtime tothe set address asa 32-bit integer.

**Parameters**

* **A1: **Source data could only be the HMI internal or external register starting with "@".

2984

* **A2: **=0: Unit of time for returning 0ms;(the value will become 0 after 49.7 days and so on)

2985

** =1: Unit of time for returning 10 ms;(the value will become 0 after 497 days and so on)

2986

** =2: Unit of time for returning 100 ms;(the value will become 0 after 4970 days and so on)

2987

** =3: Unit of time for returning 1000ms;(the value will become 0 after 49700 days and so on)

2988

2989

(% class="box infomessage" %)

2990

(((

2991

**✎Note: **If user restarts the hmi,all value will be 0.

)))

**Example**

(% class="box" %)

(((

//PI_GetTickCount("@W_HDW100",0)'save the starting time in HDW100 address as a 32-bit integer.//

2999

)))

3000

3001

**Result: **HDW100=123456(different returned data for each moment)

== **Power** ==

**Function**

var = power (expr1, expr2)

**Description**

The value of [expr2] to the power of [expr1] will be assigned to Var.

**Parameters**

* **var:** returned value.

3016

* **expr 1:** base number.

3017

* **expr 2:** power number.

**Example**

Dim a as floating

a=power (2, 3) 'the value of 3 to the power of 2 is assigned to a.

3025

3026

Float2D("@W_HDW10",a) 'assign the float value of a to @W_HDW10

3027

3028

3029

**Result: **@W_HDW10=8

== **PrintText** ==

**Function**

PrintText(A)

**Description**

Print the content of A or locates in A.

**Parameters**

**A:** source data. A could be a variable or a string ( text information),not a register address.

**Example**

A is text information

3048

3049

//PrintText("HMI 8070”)//

3050

3051

**Result: **Printer will print out “HMI 8070”

* A is variable

//Dim a as string//

//a= “HMI 8070”//

//PrintText(a)//

**Result:** Printer will print out “HMI 8070”

**✎Note:**

source data length range:1-128 characters.

== **RadToDeg** ==

**Function**

Var= RadToDeg(expr)

**Description**

Convert radiant value to degree, then assigned to Var.

**Parameters**

* **Var:** return degree value.

3080

* **expr:** input radiant value.

**Example**

Dim a as floating

a = RadToDeg(pi) 'assignt the degree value of ? to a.

3088

3089

Float2D("@W_HDW4",a) 'assign the degree value to address "@W_HDW4".

3090

3091

3092

**Result:** @W_HDW4=180

== **RAND** ==

**Function**

Var = rand(expr1)

**Description**

Generate a random number.

**Parameter**

* **Var:** generated random number.

3107

* **Expr1:** the base number.

**Example**

(% class="box" %)

(((

//@W_HDW0=rand(@W_HDW0) 'Set the value of address@W_HDW0 as the base number to generate random number.//

3114

)))

3115

3116

**Result:** @W_HDW0 random number.

== **ReadAddr** ==

**Function**

Word = ReadAddr(A1)

**Description**

Assigned the red value from A1 to word.

**Parameter**

* **Word: **return value

**Example**

Dim word as integer

@W_HDW100=10

word = ReadAddr("@W_HDW100") 'Read the value of address @W_HDW100 and assign to word.

@W_HDW200=word

**Result:** @W_HDW200=10

3145

3146

== **ReadWordFormFile** ==

**Function**

ReadWordFormFile (A1, A2, A3, A4, A5, A6)

**Description**

Read data of specified length from specified file

**Parameters**

A1: File location (value is an integer);

In HMI:

* =0: Recipe folder in HMI flash;

3163

* =1: Custom folder in UDisk (USB flash disk);

3164

* = 2: Custom folder in SD card.

3165

* =3: Custom folder in HMI flash;

In simulator:

* = 0: D:/Recipe/

* = 1: C:/WECON/CustomFileDir/

3171

* = 2: C:/WECON/CustomFileDir/

3172

* = 3: C:/WECON/CustomFileDir/

3173

3174

**✎Note:** A1 can be an address, variable or value.

3175

3176

A2: File name (value is a string);

3177

3178

Input the file name want to write.

3179

3180

**✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.

3181

3182

A3: Data start address (value is a string);

3183

3184

Input the data want to write

3185

3186

**✎Note: **A3 must be the address.

3187

3188

A4: Data length (value is an integer)

3189

3190

Set the length of the data to be written (unit:word)

3191

3192

**✎Note: **A4 can be an address , variable or value.

3193

3194

A5: Return value (value is an integer)

3195

3196

~= 1: Successfully read

3197

3198

~= 2: Failed to open the folder

3199

3200

~= 3: Read address error

3201

3202

~= 4: File reading error

3203

3204

**✎Note: **A5 must be an address.

3205

3206

A6: Folder name (value is a string);

3207

3208

Input the folder where to be written the file.

3209

3210

**✎Note:** A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters

**Example**

(% class="box" %)

(((

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

)))

== **Right** ==

**Function**

val = Right (string, length)

**Description**

Return a string of the specified length from the right side of parameter.

**Parameter**

* **string: **the operated string.

3232

* **length:** the designated number of byte required to return, count from the right side.

**Example**

//@W_HDW103= Right("Hello", 3) 'return "llo"//

3237

3238

**Result: **@W_HDW103="llo"

== **RTrim** ==

**Function**

val = RTrim(str)

**Description**

Clear the empty part on the right side of string [str], then assign the empty part to val

**Parameter**

* **val: **returned value.

3253

* **str:** the string needs to be operated.

**Example**

(% class="box" %)

(((

//@W_HDW0 = RTrim(" -Hell o- ") 'retrun" -Hell o-"//

3260

)))

3261

3262

**Result:** @W_HDW0display " -Hell o-"

== **S2F** ==

**Function**

S2F (A1,A2,s1)

**Description**

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.

**Parameters**

* **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

3277

* **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

3278

* **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)

3279

3280

**Return value:** none

**Example**

(% class="box" %)

(((

The lengTh of string is 8

3287

3288

//@W_HDW0="12345.67"//'Assign the string “12345.67" to HDW1

3289

3290

//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//

3291

)))

3292

3293

**Result: **@W_HDW100 address displays “12345.67”.

(% class="box" %)

(((

The length of string is less than 8

3298

3299

//@W_HDW0="1234.5 67"‘assign the string“1234.567”to HDW1//

3300

3301

//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 .//

3302

)))

3303

3304

**Result: **the floating value of @W_HDW100 is 1234.50

(% class="box" %)

(((

The length of string is more than 8

3309

3310

//@W_HDW0="12345.6789"’assign the string “12345.6789” to HDW1//

3311

3312

//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 .//

3313

)))

3314

3315

**Result: **the floating value of @W_HDW100 is 12345.67

== **SetB** ==

**Function**

SetB(A1)

**Description**

Set the bit A1 ON.

**Parameters**

* **A1:**Bit address

**Example**

(% class="box" %)

(((

//SetB(@B_HDX100.0) 'Set the address {@B_HDX100.0} ON//

3336

)))

3337

3338

**Result: **@B_HDX100.0=1

== **SetKeyMap** ==

**Function**

SetKeyMap(A1,A2,A3)

**Description**

The key values of the keyboard are mapped so that multiple keyboard buttons perform the same function.

**Parameters**

* **A1:** The starting address of the source key;It needs to be an address format;

3353

* **A2: **The starting address of the mapped value; It needs to be an address format;

3354

* **A3: **Mapping length (continuous length of mapped address); It needs to be a value, the maximum mapping range: 108 key values;

**Example**

(% class="box" %)

(((

//@W_HDW3000 = 3 ' The starting address of the source key//

//@W_HDW3001 = 5//

//@W_HDW3002 = 7//

//@W_HDW3003 = 9//

//@W_HDW3004 = 61//

//@W_HDW4100 = 103 'The starting address of the mapped value//

//@W_HDW4101 = 105//

//@W_HDW4102 = 106//

//@W_HDW4103 = 108//

//@W_HDW4104 = 28//

//SetKeyMap("@W_HDW3000","@W_HDW4100",5) ' Map the values of the HDW4000~~HDW4004 addresses to the HDW3000~~HDW3004 addresses.//

)))

**Result**

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)

3386

3387

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.

3388

3389

== **SignedInt16** ==

**Function**

val = SignedInt16(A1)

**Description**

Assign the value to {val} from address A1 which is signed integer.

**Parameters**

* **A1: **contain signed integer as "@W_HDW000002"

3402

* **Val: **returned value

**Example**

Dim a as integer 'Integer variable a

3408

3409

a = SignedInt16("@W_HDW0") 'read signed integer from HDW0 addresses and assign the value to a

3410

3411

@W_HDW2=a'assign the value a to HDW2

3412

3413

3414

**Input: **@W_HDW0=-2:

3415

3416

**Result:** @W_HDW2=-2.

3417

3418

== **SignedInt32** ==

**Function**

val = SignedInt32 (A1)

**Description**

Assign the value to {val} from address A1 which is signed even integer.

**Parameters**

* **A1: **the address contains signed even integer

3431

* **Val:** Returned value

**Example**

Dim a as integer 'define {a} as a integer

3437

3438

a = SignedInt32("@W_HDW0") 'read signed even integer from HDW0, then assign this value to a.

3439

3440

@W_HDW2=a 'assign the value of a to HDW2

@W_HDW3=a>>16

**Input: **@W_HDW0=-2

**Result:**

* @W_HDW2=-2

* @W_HDW13=-1

== **Sin** ==

**Function**

val = Sin(A1)

**Description**

Get the sine value of A1, and copy result to val.

**Parameters**

* **A1: **A1 needs to be an angle.

3465

* **Val: **Returned value.

**Example**

Dim a as floating 'floating variable a,b

3471

3472

a=sin(pi/6) 'return sinb to a

3473

3474

Float2D("@W_HDW13",a) 'assign the value of the floating variable a to address HDW13.

3475

3476

3477

**Result:** @W_HDW13=0.5

== **SleepA** ==

**Function**

SleepA(T)

**Description**

Wait time T(ms).

**Parameters**

* **T:** wait time, the unit is [ms]

3492

3493

**Returned value:** none.

**Example**

(% class="box" %)

(((

//SleepA(10) 'wait 10ms//

3500

)))

3501

3502

**Result:** When the script runs to SleepA(10), it means the scripts would go running after waiting 10ms

== **Sqr** ==

**Function**

val = Sqr(A1)

**Description**

Assign a square root value of A1 to val.

**Parameters**

* **A1: **the data need to be operated

3517

* **Val: **Returned value

**Example**

(% class="box" %)

(((

//@W_HDW0 = Sqr(4) 'calculate the square root of HDW0//

3524

)))

3525

3526

**Result:** @W_HDW0=2

3527

3528

== **StAndFtChange** ==

**Function**

StAndFtChange(A1,A2,A3)

**Description**

Calculate the number of seconds from January 1, 1970 to the current time, and also be invertible.

**Parameters**

* **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;

3541

* **A2: **The number of seconds; It needs to begin with address “@", data format 32-bit unsigned.

3542

* **A3: **conversion method;

3543

** A3=0, convert time to seconds;

3544

** A3=1, convert seconds to time;

3545

3546

**Returned value: **none;

**Example**

Script 1

(% class="box" %)

(((

//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//

3555

)))

3556

3557

**Input: **HDW10 = 2017,HDW11 = 12, HDW12 = 9 , HDW13 = 15, HDW14 = 15, HDW15 = 0

3558

3559

**Output:** 1512832500

Script 2

(% class="box" %)

(((

//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//

3566

)))

3567

3568

**Input:** 1512833760

3569

3570

**Output:** HDW30 = 2017, HDW31 = 12, HDW32 = 9, HDW33 = 15, HDW34 = 36, HDW35 = 0

== **Sub** ==

**Function**

Sub name (arglist)

statements

End Sub

**Description**

Declare the name, parameters and codes of the Sub (sub function)

**Parameters**

* **Name: **naming rules refer to variable.

3589

* **Arglist: **variable list.

3590

* **Statements:** the code set of the sub function.

**Example**

sub samesub(a,b as integer) ' samesub and integer variable a,b

c=a+b

@W_HDW0=c

endsub

samesub(1,12) 'call function samesub

3604

3605

3606

**Result:** @W_HDW0=13

== **SWAP** ==

**Function**

SWAP(A1,length)

**Description**

Swap the big-endian with the little-endian from address A1, swap length is adjustable.

**Parameters**

* **A1: **the swapped high endian, need to be an address as HDW_000002.

3621

* **Length: **swap length.

3622

3623

**Returned value:** None.

**Example**

@W_HDW103=0x1234 'assign value to HDW103

3629

3630

@W_HDW104=0x2345 'assign value to HDW104

3631

3632

@W_HDW105=0x2565 'assign value to HDW105

3633

3634

@W_HDW106=0x2675 'assign value to HDW106

3635

3636

SWAP(@W_HDW103,4) 'swap the high and low endian for the 4 adjacent addresses start with HDW103.

**Result:**

* @W_HDW103=0x3412

* @W_HDW104=0x4523

* @W_HDW105=0x6525

* @W_HDW106=0x7526

== **Tan** ==

**Function**

val = Tan(A1)

**Description**

Get the returned tagent value of A1, and then assign to val.

**Parameters**

* **A1: **A1 needs to be an angle.

3659

* **Val: **Returned value.

**Example**

Dim a as floating 'define a floating variable a

3665

3666

a=TAN(pi/3) 'calculate the tangent value of pi/3 and assign to a

3667

3668

Float2D("@W_HDW16",a) 'assign the value of a to HDW16

3669

3670

3671

**Result:** @W_HDW13=1.732

== **Trim** ==

**Function**

val = Trim(A1)

**Description**

Return A string in A1 without empty string next to it.

**Parameters**

* **A1: **The operated string

3686

* **val: **Returned value

**Example**

//{{code language="lua"}}@W_HDW1=Trim(" ab "){{/code}}//

3691

3692

**Result: **@W_HDW1="ab"

== **UCase** ==

**Function**

val = UCase(A1)

**Description**

Capitalize the string data, and then assign the value to val.

**Parameters**

* **A1: **Operated string, address or variable.

3707

* **Val: **Returned value

**Example**

//{{code language="lua"}}@W_HDW1=ucase("abcd") 'Capitalize abcd then assign the value to HDW1{{/code}}//

3712

3713

**Result: **@W_HDW1="ABCD"

== **Variable** ==

**Description**

A variable is any factor, trait, or condition that could exist in differing amounts or types.

**Define variable**

Use Dim to define variable in script. The variable could be string, floating, integer.

**Example:**

Dim a as floating ‘define variable {a} as a floating.

3729

3730

Dim b,c,d as integer‘define variable {b,c,d} as integer

**Naming rules**

The first letter needs to be English letter.

No symbols.

Maximum character length 15 allowed.

== **W2B** ==

**Function**

W2B(A1, A2, A3)

**Description**

Replace the high endian of [A2]+1 with the high endian of A2.

**Parameters**

* **A1:** operated address.

3754

* **A2:** source address.

3755

* **A3: **the conversion length.

3756

3757

**Returned value:** none.

**Example**

@W_HDW0 = 4660 'assign 16bit value 1234 to HDW0.

3763

3764

@W_HDW1=0x5678 'assign 16bit value 5678 to HDW1.

3765

3766

@W_HDW2 = 0x2425 'assign 16bit value 2425 to HDW1.

3767

3768

@W_HDW3 = 0x3536 'assign 16bit value 3536 to HDW0.

3769

3770

@W_HDW4 = 0x1415 'assign 16bit value 1415 to HDW0.

3771

3772

W2B(@W_HDW20,@W_HDW0, @W_HDW10)

3773

3774

@W_HDW10=1 ‘save the high endian {34} of HDW0 to HDW20.

3775

3776

3777

**Result:** @W_HDW20=0x34, @W_HDW21=0, @W_HDW22=0

== **W2D** ==

**Function**

W2D(A1, A2)

**Description**

Convert the unsigned Word to unsigned Dword and save the result in A1.

**Parameters**

* **A1: **operated address .

3792

* **A2:** source address.

Returned value.

**Example**

Unsigned decimal word

(% class="box" %)

(((

//@W_HDW0 = 1234 'assign 1234 to HDW0.//

3803

3804

//W2D(@W_HDW2, @W_HDW0) 'convert unsigned word {1234} from HDW0 to Dword and save in HDW2//

3805

)))

3806

3807

**Result:** @W_HDW0=12345, @W_HDW2=12345, @W_HDW3=0

Signed decimal word

(% class="box" %)

(((

//@W_HDW0 = -12345 'assign value to HDW0: convert {-12344} to unsigned decimal word is {53191}.//

3814

3815

//W2D(@W_HDW2, @W_HDW0) 'save unsigned Dword to HDW0//

3816

)))

3817

3818

**Result: **@W_HDW0=-12345,@W_HDW2=53191,@W_HDW3=0

== **W2F** ==

**Function**

A1 = W2F (A2)

**Description**

Convert a 16bit integer to a 32bit floating, and then save to the next word of A1.

Parameters

* **A1:** operated address.

3833

* **A2:** source address.

3834

3835

**Returned value:** none.

**Example**

A1, A2 are addresses

(% class="box" %)

(((

//@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.//

3844

)))

3845

3846

**Result: **@W_HDW1=1234'32bit floating

3847

3848

3849

A1 is an address,A2 is variable

dim a as integer

a=134 'define a integer 134 to a,

3854

3855

@W_HDW2=W2F (a) 'convert to 32bit floating save to HDW1, HDW2.

3856

3857

3858

**Result: **@W_HDW1=134' 32bit floating

== **W2S** ==

**Function**

W2S(A1,A2,S1)

**Description**

Convert integer word in address A1 text as S1 format, and then save to A2.

**Parameters**

* **A1:** operated address.

3873

* **A2:** source address.

3874

* **S1:** saving format.

3875

** 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.

3876

** format: Unsigned octal format. Mo and 0mo is also applied.

3877

** x format: unsigned Hex integer format ?Mx and 0mx is also applied.

3878

** c format: ASCII format.

**Example**

Decimal format

@W_HDW1=1456'assign value {1456} to HDW1.

3886

3887

W2S("@W_HDW1", "@W_HDW10", "6d") ' convert{1456} to decimal text and save to HDW10.

3888

3889

3890

**Result: **@W_HDW10 shown "1456"

0md

@W_HDW1=1456 ' assign value {1456} to HDW1

3896

3897

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.

3898

3899

3900

**Result:** @W_HDW10 show text "001456"

3901

3902

== **WaitEthernetStart** ==

**Function**

WaitEthernetStart (A1)

**Description**

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)

**Parameters**

* **A1: **Waiting timeout (1~~20s)

3915

** If A1=0, the wait timeout is 10s;

3916

** If A1>20, the wait timeout is 20s;

3917

3918

**Returned value:** None

**Example**

//WaitEthernetStart (15)//

3923

3924

‘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.

3925

3926

== **WHILE ... WEND** ==

**Function**

While condition

[statements]

Wend

**Description**

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.

**Parameters**

* **Condition: **Number or string, the result represents as True or False.

3943

3944

**Returned value:** None.

**Example**

while @W_HDW1>50 'the condition is the value of HDW1 bigger than 50.

3950

3951

@W_HDW1=@W_HDW1-1 'when the condition is true, execute subtract 1 from 1HDW.

wend

@W_HDW2=@W_HDW2+1 ' when the condition is false, execute add 1 from 1HDW.

3956

3957

3958

**Result:** If HDW1=60, after executed; HDW1=50, if the condition is true.

== **WriteAddr** ==

**Function**

WriteAddr(A1,A2)

**Description**

Assign the value from A2 to address A1.

**Parameters**

* **A1:** operated address

3973

* **A2:** source address

3974

3975

**Returned value:** None.

**Example**

dim f as integer ' integer f

3981

3982

f=13 ' assign the value 13 to f

3983

3984

WriteAddr("@W_HDW1",f) ' write the value to HDW1.

3985

3986

WriteAddr("@W_HDW10",@W_HDW2) ' write the value from HDW2 to HDW10.

**Result:**

* HDW1=13

* HDW10= HDW2'IF HDW2=1456,Then HDW10=1456;IF HDW2=-123,Then HDW10=-123

3993

3994

== **WriteWordToFile** ==

**Function**

WriteWordToFile (A1,A2,A3,A4,A5,A6)

**Description**

Write data of designated length to specified file

**Parameters**

A1: File location (value is an integer);

In HMI:

* =0: Recipe folder in HMI flash;

4011

* =1: Custom folder in UDisk (USB flash disk);

4012

* = 2: Custom folder in SD card.

4013

* =3: Custom folder in HMI flash;

In simulator:

* = 0: D:/Recipe/

* = 1: C:/WECON/CustomFileDir/

4019

* = 2: C:/WECON/CustomFileDir/

4020

* = 3: C:/WECON/CustomFileDir/

4021

4022

**✎Note: **A1 can be an address, variable or value.

4023

4024

A2: File name (value is a string);

4025

4026

Input the file name want to write.

4027

4028

**✎Note: **A2 must be an address, and the length of the file name cannot exceed 32 characters.

4029

4030

A3: Data start address (value is a string);

4031

4032

Input the data want to write

4033

4034

**✎Note: **A3 must be the address.

4035

4036

A4: Data length (value is an integer)

4037

4038

Set the length of the data to be written (unit:word)

4039

4040

**✎Note: **A4 can be an address , variable or value.

4041

4042

A5: Return value (value is an integer)

4043

4044

* = 1: Successfully written

4045

* = 2: Failed to open the folder

4046

* = 3: Read address error

4047

* = 4: File writing error

4048

* = 5: The file already exists

4049

4050

**✎Note: **A5 must be an address.

4051

4052

A6: Folder name (value is a string);

4053

4054

Input the folder where to be written the file.

4055

4056

(% class="box infomessage" %)

4057

(((

4058

**✎Note: **A6 can be an address or a variable or a character string, and the length of the folder name cannot exceed 32 characters

)))

**Example**

(% class="box" %)

(((

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

4066

)))

Wiki source code of 08 Macro Script

Navigation

Table of Contents