Foreword - Wecon

1

**[[1 Lua Editor>>path:#_Toc42782932]]**

2

3

**[[1.1 Script File Area>>path:#_Toc42782933]]**

4

5

**[[1.1.1 Lua Node>>path:#_Toc42782934]]**

6

7

**[[1.1.2 Lua Child Node>>path:#_Toc42782936]]**

8

9

**[[1.2 Script Editor>>path:#_Toc42782937]]**

10

11

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**1.2.1 Tool bar**__ 5>>path:#_Toc42782938]]

12

13

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**1.2.2 Editor area**__ 5>>path:#_Toc42782939]]

14

15

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**1.2.3 Output area**__ 5>>path:#_Toc42782940]]

16

17

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**2 Lua object**__ 6>>path:#_Toc42782941]]

18

19

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**2.1 How to use LuaScrip object**__ 6>>path:#_Toc42782942]]

20

21

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3 Platform**__ 7>>path:#_Toc42782943]]

22

23

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3.1 File header identification**__ 7>>path:#_Toc42782944]]

24

25

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3.2 Special script file**__ 8>>path:#_Toc42782945]]

26

27

[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3.3** **Script type (operating mechanism)**__ 9>>path:#_Toc42782946]]

28

29

Lua script is currently only available in PI+ or models ending with i(like PI3070i). Only these two types of HMI can use the Lua editor and object to develop lua scripts. The following operations are based on PI3070i project.

30

31

This article only introduces the use of lua object in PIStudio.

32

33

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

34

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

35

36

37

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

38

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

{{id name="_Toc6870"/}}{{id name="_Toc27091"/}}**1 Lua editor**

43

44

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

45

46

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

47

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

48

49

{{id name="_Toc42782933"/}}{{id name="_Toc14144"/}}{{id name="_Toc22413"/}}**1.1 Script file area**

50

51

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

52

53

**1.1.1 {{id name="_Toc42782934"/}}{{id name="_Toc2961"/}}Lua node**

54

55

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

56

57

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;

58

59

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

60

61

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

62

63

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

64

65

{{id name="_Toc5597"/}}{{id name="_Toc42782551"/}}{{id name="_Toc42782582"/}}{{id name="_Toc42782935"/}}{{id name="_GoBack"/}}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.

66

67

**{{id name="_Toc42782936"/}}1.1.2 Lua child node**

68

69

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

70

71

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

72

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

73

74

Child node color description:

Red: encrypted file

Yellow: read-only file

79

80

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

81

82

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

83

84

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

85

86

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

87

88

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

89

90

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

91

92

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

93

94

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

95

96

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

97

98

{{id name="_Toc42782937"/}}{{id name="_Toc5485"/}}{{id name="_Toc31584"/}}**1.2 Script editor**

99

100

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.

101

102

{{id name="_Toc42782938"/}}{{id name="_Toc24279"/}}**1.2.1 Tool bar**

103

104

Open any script file, the toolbar is as follows:

105

106

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

107

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

108

109

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

110

111

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

112

113

{{id name="_Toc42782939"/}}{{id name="_Toc32765"/}}**1.2.2 Editor area**

114

115

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

116

117

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

118

119

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

120

121

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

122

123

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

124

125

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

126

127

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

128

129

{{id name="_Toc42782940"/}}{{id name="_Toc25425"/}}**1.2.3 Output area**

130

131

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.

132

133

{{id name="_Toc42782941"/}}{{id name="_Toc27350"/}}{{id name="_Toc26670"/}}**2 Lua object**

134

135

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.

136

137

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

138

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

139

140

{{id name="_Toc42782942"/}}{{id name="_Toc888"/}}{{id name="_Toc26065"/}}**2.1 How to use LuaScrip object**

141

142

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.

143

144

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

145

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

146

147

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

148

149

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

150

151

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

152

153

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

154

155

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

156

157

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

158

159

{{id name="_Toc42782943"/}}{{id name="_Toc16937"/}}{{id name="_Toc18999"/}}**3 Platform**

160

161

{{id name="_Toc17954"/}}{{id name="_Toc18609"/}}{{id name="_Toc42782944"/}}**3.1 File header identification**

162

163

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

164

165

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

166

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

167

168

The format of this variable: file name_limits = number

169

170

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

171

172

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

173

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

174

175

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

180

181

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

182

183

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

184

185

**{{id name="_Toc42782945"/}}3.2 Special script file**

186

187

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.

188

189

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

190

191

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

192

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

193

194

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

195

196

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

197

198

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

199

200

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

201

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

202

203

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

204

205

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

206

207

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

208

209

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

210

211

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

212

213

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.

214

215

{{id name="_Toc42782946"/}}{{id name="_Toc21777"/}}{{id name="_Toc1844"/}}**3.2** **Script type (operating mechanism)**

216

217

There are two types of scripts:

218

219

Active: script automatically executed by HMI

220

221

Passive: Script executed only after user trigger