09 Lua Editor

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

* 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

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

25

26

(% class="box infomessage" %)

(((

**✎Note: **

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

31

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

32

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

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.

39

40

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

41

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

42

43

* Child node color description:

44

* Red: encrypted file

45

* Yellow: read-only file

46

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

47

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

48

49

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

50

51

**Rename: **right-click child node to rename.

52

53

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

54

55

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

56

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

57

58

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

59

60

(% class="box infomessage" %)

61

(((

62

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

)))

== Script editor ==

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:

72

73

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

74

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

75

76

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

77

78

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

**Editor Area**

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

83

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

84

* **Automatic indentation: **The tab key can add 4 spaces

85

* **Calling prompt:** only available for Lua interface functions

86

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

87

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

88

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

97

98

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

99

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

100

101

== How to use Lua button ==

102

103

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.

104

105

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

106

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

107

108

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

109

110

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

111

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

112

* **Timing script**: periodically execute the code.

113

114

(% class="box infomessage" %)

(((

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

119

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

125

126

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

127

128

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

129

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

130

131

The format of this variable: file name_limits = number

132

133

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

134

135

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

136

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

137

138

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

139

* **Description**：

140

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

141

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

142

143

(% class="box infomessage" %)

144

(((

145

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

146

)))

147

148

== Built-In script file ==

149

150

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.

151

152

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

153

154

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

155

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

156

157

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

158

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

159

160

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

161

162

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

163

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

164

165

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

166

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

167

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

168

169

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

170

171

(% class="box infomessage" %)

172

(((

173

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

174

)))

175

176

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

177

178

== Script type (operating mechanism) ==

179

180

There are two types of scripts:

181

182

* Active: script automatically executed by HMI

183

* Passive: Script executed only after user trigger

184