Foreword - Wecon

1

Lua script is only supported on HMI+, i series, ie series, ig series or models whose upgrade OS version to HMI V2.0 and above;

2

3

(% style="text-align:center" %)

4

[[image:HMI Lua Editor user manual_html_90c08e4cdcf4210c.png||height="484" width="500" class="img-thumbnail"]]

5

6

7

(% style="text-align:center" %)

8

[[image:HMI Lua Editor user manual_html_674bb6778b0f003.png||height="487" width="500" class="img-thumbnail"]]

= **Lua Editor** =

The editor is divided into two areas, one is the script file area, and the other is the script editing area.

13

14

(% style="text-align:center" %)

15

[[image:HMI Lua Editor user manual_html_34da990820a7a4e5.png||height="208" width="400" class="img-thumbnail"]]

16

17

== **Script File Area** ==

18

19

The script file area is located on the left side, named after the Lua, It will be referred to as the Lua node hereinafter.

**Lua Node**

~1. Create new file: right-click the Lua node to select new file, and enter a name in pop-up window, (the name starts with an underscore or letter);

24

25

2.Refresh list: the file edited (new/deleted/renamed) by the user externally, the configuration is not refreshed. In this case this function needs to be used to synchronize changes;

26

27

**✎Note: **There is no script file for the newly created project. Following two new files will automatically generate.

28

29

Script_BG.lua: is the global background script file, which includes initialization and timing functions

30

31

Script_Screen.lua: is a screen script file, and each screen can have initialization, timing, and close functions

32

33

At any time, as long as there is a new operation, the software will judge whether the above two files exist, and which one is missing will be automatically filled.

**Lua Child Node**

After creating a new file, expand the Lua node to display several script files. The following is referred to as child nodes.

38

39

(% style="text-align:center" %)

40

[[image:HMI Lua Editor user manual_html_fc10128583a230da.png||height="143" width="200" class="img-thumbnail"]]

41

42

Child node color description:

Red: encrypted file

Yellow: read-only file

47

48

Green: existed file or refresh the list to turn white to green

49

50

White: The newly created file, and the project will turn green after refreshing, protecting or reopening the project

51

52

**(1) Delete:** right-click the child node to delete. The deleted node will be placed in the recycle bin.

53

54

**(2)** **Rename: **right-click child node to rename.

55

56

**(3) Encryption:** right-click the child node, select encryption. Each file can be set with an independent password(length 1-6, only uppercase/lowercase letters and numbers are accepted).

57

58

Encryption mode: When this mode is turned on, you need to verify the password to view and edit.

59

60

Read-only mode: This mode is opened without verifying the password, if you want to edit, you must first release the protection

61

62

**(4) Unprotect:** Right-click on the child node, select Unprotect, enter the password to release.

63

64

**✎Note: **If user forgets the password, the script file can never be recovered, the software will not storage any passwords, developers need to keep the password by themselves carefully.

65

66

== **Script Editor** ==

67

68

The script editor is divided into three blocks: the upper part is the toolbar, the middle part is the editing area, and the lower part is the output area.

**Tool Bar**

Open any script file, the toolbar is as follows:

73

74

(% style="text-align:center" %)

75

[[image:HMI Lua Editor user manual_html_59f8bacea4239441.png||height="29" width="279" class="img-thumbnail"]]

76

77

Save, cut, copy, paste, word address, bit address, zoom in, zoom out, display spaces and tabs, grammar check.

78

79

Find and replace, undo and redo and more functions see shortcut keys manual.

**Editor Area**

**(1) Highlight color:** Lua's built-in keywords has a different color with the Lua interface functions. The functions written by users will not be highlighted

84

85

**(2)** **Auto-complete:** Lua function auto-complete prompts, Lua chunk auto-complete (such as if xx then end), also supports the completion of all the words in this script file. Use the Enter key to select candidates words, use the Tab key to turn off automatic completion.

86

87

**(3) Automatic indentation: **The tab key can add 4 spaces

88

89

**(4) Calling prompt:** only available for Lua interface functions

90

91

**(5) Hovering hint:** for example the mouse stays near the o letter position of demo() , it will display the prototype of the function

92

93

**(6)** **Shortcut keys:** In order to facilitate users, various shortcut keys have been added. Detailed description: Configure Lua shortcut keys.doc

94

95

**(7)** **Interface document: **The scripts listed in the interface document will be distinguished by the highlighted color in the editing area. You can check whether the interface is called incorrectly by judging the color change. Detailed description: Lua interface manual.

**Output Area**

Click the syntax button in the toolbar to perform a grammar check. If the script is written incorrectly, it will be displayed in the window. Double-click the prompt to locate the "near" line of the error.

= **Lua Object** =

Lua objects are mainly used to call functions and complete user interface interactions. Normally, functions should not be written in objects. Next, we will explain how to use the objects.

104

105

(% style="text-align:center" %)

106

[[image:HMI Lua Editor user manual_html_a9a41fb25f413fec.png||height="317" width="150" class="img-thumbnail"]]

107

108

== **How to Use Lua Button** ==

109

110

Find the custom part->LuaScript on the right side, drag and draw to generate a part. Double-click the part to pop up a dialog box.

111

112

(% style="text-align:center" %)

113

[[image:HMI Lua Editor user manual_html_14bab1899c9ccc62.png||height="267" width="400" class="img-thumbnail"]]

114

115

Click Lua object will trigger two actions, that is, rising and falling scripts;

116

117

**(1)** **Falling script**: after the button is pressed, the code chunk of the area is executed;

118

119

**(2) Rising script**: after the button is raised, the code chunk in the area is executed;

120

121

**(3)** **Timing script**: periodically execute the code.

122

123

**✎Note: **The timing script is not commonly used because it is similar to the screen background script function. It is not recommended to write and call function here. It should be written in Script_Screen.lua, which is convenient for editing, searching, and replacing operations.

124

125

**Warning:** It is not allowed to write endless loops or call functions that will loop enlessly in the widget. Once used, the entire screen will be stuck, and any buttons will no longer be used. We have to restart the screen to restore.

= **Platform** =

== **File Header Identification** ==

130

131

Any new file will automatically generate a line of code, as shown below:

132

133

(% style="text-align:center" %)

134

[[image:HMI Lua Editor user manual_html_40558d3555455933.png||height="116" width="270" class="img-thumbnail"]]

135

136

The format of this variable: file name_limits = number

137

138

The file name comes from the newly created file name (without suffix):

139

140

(% style="text-align:center" %)

141

[[image:HMI Lua Editor user manual_html_52fb935bcc76d7ad.png||height="113" width="203" class="img-thumbnail"]]

142

143

**_limits**：Fixed format, cannot be modified

**Description**：

**Tens digit=1**：indicates that the function or global variable defined in this file can be used in the background code file (Script_BG.lua). If it is 0, it is not available.

148

149

**Ones digit=1**：indicates that the functions or global variables defined in this file can be used in the screen code file (Script_Screen.lua) or LuaScript components. If it is 0, it is not available.

150

151

**✎Note: **If you rename the file manually, you must modify the limits in the file accordingly, otherwise the script file will not take effect.

152

153

== **Built-In Script File** ==

154

155

As mentioned above, the first new build will automatically generate two script files. These two files cannot be deleted and renamed, which will be explained in detail here.

156

157

~1. **Script_BG.lua** is a global background script file, which includes initialization and polling functions

158

159

(% style="text-align:center" %)

160

[[image:HMI Lua Editor user manual_html_5eb1ad5776f18955.png||height="148" width="200" class="img-thumbnail"]]

161

162

we_bg_init(): global initialization, that is, execute once when power on.

163

164

we_bg_poll()：Global polling, that is, the cycle is repeated after power on.

165

166

Script_Screen.lua is a screen script file, and each screen has an initialization, polling, and closing functions

167

168

(% style="text-align:center" %)

169

[[image:HMI Lua Editor user manual_html_e6807eb0da0eedd4.png||height="231" width="300" class="img-thumbnail"]]

170

171

we_scr_init_0(): execute this function when screen 0 is initialized

172

173

we_scr_poll_0(): when in picture 0, the function is executed repeatedly

174

175

we_scr_close_0(): execute this function when screen 0 is closed

176

177

The above is the initialization function of screen 0. For screen 100, you can replace 0 with 100. You can add your own function: function we_scr_init_100() end

178

179

**✎Note: **The above function has a fixed name. If it is modified, it will not cause crash, but the function can be found.

180

181

Example: After the screen 0 initialization function is changed to we_scR_init_0(), the script will not be executed when screen 0 is initialized, and then no script will be executed, and nothing will be done because the "we_scr_init_0" function cannot be found.

182

183

== **Script Type (Operating Mechanism)** ==

184

185

There are two types of scripts:

186

187

Active: script automatically executed by HMI

188

189

Passive: Script executed only after user trigger