Skip to Content

Changes for page 09 Lua Editor

Last modified by Nhu Nguyen on 2025/03/09 17:22
From version 2.1
edited by Joey
on 2022/06/16 15:07
Change comment: There is no comment for this version
To version 3.1
edited by Hunter
on 2022/07/09 09:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Joey
1 +XWiki.Hunter
Content
... ... @@ -1,35 +1,5 @@
1 -**[[1 Lua Editor>>path:#_Toc42782932]]**
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 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 wikiinternallink" %)__**1.2.1 Tool bar**__ 5>>path:#_Toc42782938]]
12 -
13 -[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**1.2.2 Editor area**__ 5>>path:#_Toc42782939]]
14 -
15 -[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**1.2.3 Output area**__ 5>>path:#_Toc42782940]]
16 -
17 -[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**2 Lua object**__ 6>>path:#_Toc42782941]]
18 -
19 -[[(% class="wikiinternallink 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 wikiinternallink" %)__**3 Platform**__ 7>>path:#_Toc42782943]]
22 -
23 -[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3.1 File header identification**__ 7>>path:#_Toc42782944]]
24 -
25 -[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__**3.2 Special script file**__ 8>>path:#_Toc42782945]]
26 -
27 -[[(% class="wikiinternallink 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 33  (% style="text-align:center" %)
34 34  [[image:HMI Lua Editor user manual_html_90c08e4cdcf4210c.png||height="484" width="500" class="img-thumbnail"]]
35 35  
... ... @@ -37,20 +37,18 @@
37 37  (% style="text-align:center" %)
38 38  [[image:HMI Lua Editor user manual_html_674bb6778b0f003.png||height="487" width="500" class="img-thumbnail"]]
39 39  
40 -{{id name="_Toc42782932"/}}
10 += **Lua Editor** =
41 41  
42 -{{id name="_Toc6870"/}}{{id name="_Toc27091"/}}**1 Lua editor**
43 -
44 44  The editor is divided into two areas, one is the script file area, and the other is the script editing area.
45 45  
46 46  (% style="text-align:center" %)
47 47  [[image:HMI Lua Editor user manual_html_34da990820a7a4e5.png||height="208" width="400" class="img-thumbnail"]]
48 48  
49 -{{id name="_Toc42782933"/}}{{id name="_Toc14144"/}}{{id name="_Toc22413"/}}**1.1 Script file area**
17 +== **Script File Area** ==
50 50  
51 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 52  
53 -**1.1.1 {{id name="_Toc42782934"/}}{{id name="_Toc2961"/}}Lua node**
21 +**Lua Node**
54 54  
55 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 56  
... ... @@ -62,9 +62,9 @@
62 62  
63 63  Script_Screen.lua: is a screen script file, and each screen can have initialization, timing, and close functions
64 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.
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.
66 66  
67 -**{{id name="_Toc42782936"/}}1.1.2 Lua child node**
35 +**Lua Child Node**
68 68  
69 69  After creating a new file, expand the Lua node to display several script files. The following is referred to as child nodes.
70 70  
... ... @@ -95,11 +95,11 @@
95 95  
96 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 97  
98 -{{id name="_Toc42782937"/}}{{id name="_Toc5485"/}}{{id name="_Toc31584"/}}**1.2 Script editor**
66 +== **Script Editor** ==
99 99  
100 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 101  
102 -{{id name="_Toc42782938"/}}{{id name="_Toc24279"/}}**1.2.1 Tool bar**
70 +**Tool Bar**
103 103  
104 104  Open any script file, the toolbar is as follows:
105 105  
... ... @@ -110,7 +110,7 @@
110 110  
111 111  Find and replace, undo and redo and more functions see shortcut keys manual.
112 112  
113 -{{id name="_Toc42782939"/}}{{id name="_Toc32765"/}}**1.2.2 Editor area**
81 +**Editor Area**
114 114  
115 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 116  
... ... @@ -126,11 +126,11 @@
126 126  
127 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 128  
129 -{{id name="_Toc42782940"/}}{{id name="_Toc25425"/}}**1.2.3 Output area**
97 +**Output Area**
130 130  
131 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 132  
133 -{{id name="_Toc42782941"/}}{{id name="_Toc27350"/}}{{id name="_Toc26670"/}}**2 Lua object**
101 += **Lua Object** =
134 134  
135 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 136  
... ... @@ -137,7 +137,7 @@
137 137  (% style="text-align:center" %)
138 138  [[image:HMI Lua Editor user manual_html_a9a41fb25f413fec.png||height="317" width="150" class="img-thumbnail"]]
139 139  
140 -{{id name="_Toc42782942"/}}{{id name="_Toc888"/}}{{id name="_Toc26065"/}}**2.1 How to use LuaScrip object**
108 +== **How to Use Lua Button** ==
141 141  
142 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 143  
... ... @@ -156,9 +156,9 @@
156 156  
157 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 158  
159 -{{id name="_Toc42782943"/}}{{id name="_Toc16937"/}}{{id name="_Toc18999"/}}**3 Platform**
127 += **Platform** =
160 160  
161 -{{id name="_Toc17954"/}}{{id name="_Toc18609"/}}{{id name="_Toc42782944"/}}**3.1 File header identification**
129 +== **File Header Identification** ==
162 162  
163 163  Any new file will automatically generate a line of code, as shown below:
164 164  
... ... @@ -182,11 +182,11 @@
182 182  
183 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 184  
185 -**{{id name="_Toc42782945"/}}3.2 Special script file**
153 +== **Built-In Script File** ==
186 186  
187 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 188  
189 -~1. Script_BG.lua is a global background script file, which includes initialization and polling functions
157 +~1. **Script_BG.lua** is a global background script file, which includes initialization and polling functions
190 190  
191 191  (% style="text-align:center" %)
192 192  [[image:HMI Lua Editor user manual_html_5eb1ad5776f18955.png||height="148" width="200" class="img-thumbnail"]]
... ... @@ -195,7 +195,7 @@
195 195  
196 196  we_bg_poll()：Global polling, that is, the cycle is repeated after power on.
197 197  
198 -1. Script_Screen.lua is a screen script file, and each screen has an initialization, polling, and closing functions
166 +Script_Screen.lua is a screen script file, and each screen has an initialization, polling, and closing functions
199 199  
200 200  (% style="text-align:center" %)
201 201  [[image:HMI Lua Editor user manual_html_e6807eb0da0eedd4.png||height="231" width="300" class="img-thumbnail"]]
... ... @@ -212,7 +212,7 @@
212 212  
213 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 214  
215 -{{id name="_Toc42782946"/}}{{id name="_Toc21777"/}}{{id name="_Toc1844"/}}**3.2** **Script type (operating mechanism)**
183 +== **Script Type (Operating Mechanism)** ==
216 216  
217 217  There are two types of scripts:
218 218