Wiki source code of 06 Data Tool

Version 6.1 by Joe on 2025/09/08 17:22

Show last authors
1 (% class="wikigeneratedid" %)
2 This chapter provides information about basic functions and configuration in PIStudio.
3
4 = **Alarm** =
5
6 == Bit alarm ==
7
8 Click "Project"→"Bit Alarm", it is displayed as the following figure.
9
10 (% style="text-align:center" %)
11 [[image:位报警 1.png||data-xwiki-image-style-alignment="center" class="img-thumbnail"]]
12
13 **Group No.: **Group number of Bit alarm. The name is unique and cannot be duplicated.
14
15 **Bit Address: **Bit address of alarm monitoring
16
17 * **Record bit alarm by default:**  Whether to record the alarm history data of bit alarm, if checked, it will be saved in the designated storage location.
18 * **Not save alarm OFF:** If checked, after the alarm is dismissed, the corresponding alarm records will be deleted from the log file.
19
20 **Upload to Cloud: **The data upload by "bit alarm" is stored in the Cloud and it is alarm data. (Only ig series and 8000/9000 series with -R after system upgrade are supported)
21
22 (% class="box infomessage" %)
23 (((
24 **✎Note:**
25
26 * After enable the Cloud and check the box of Upload to Cloud, the communication port settings of the address in the imported Bit Alarm record configuration must be the same as the communication port settings of the current project, otherwise it cannot be used normally.
27 * The number of Alarm records upload to Cloud shall not exceed the limit value, or the sum of the imported alarm records and the number of existing alarm records shall not exceed the limit value. the specific limitation as following table:
28
29 (% class="table-bordered" style="margin-left:auto; margin-right:auto; width:358px" %)
30 |=(% style="width: 79px;" %)Series|=(% style="width: 276px;" %)Number of Alarm upload to Cloud
31 |(% style="width:79px" %)8000-R|(% style="text-align:center; width:276px" %)200
32 |(% style="width:79px" %)9000-R|(% style="text-align:center; width:276px" %)200
33 |(% style="width:79px" %)3000ig|(% style="text-align:center; width:276px" %)20
34 |(% style="width:79px" %)8000ig|(% style="text-align:center; width:276px" %)200
35 |(% style="width:79px" %)MD|(% style="text-align:center; width:276px" %)20
36 )))
37
38 **Alarm Condition:** It sets alarm trigger condition, there are two types: alarm when ON and alarm when OFF.
39
40 **Alert: **It is used to mark whether the alarm has occurred. if an alarm occurs, the address of "control bit" will be written to 1. If "clear alert when alarm OFF" is checked, the address of "control bit" will be written to 0.
41
42 **Beep when alarm ON: **The beep works when the alarm is triggered. If "beep once" is checked, bit address alarm only beep once and stop.
43
44 **Content: **It is used for setting alarm content (command).
45
46 **Alarm Screen: **Pop-up alarm screen (it need to be sub-screen);
47
48 * **Position: **The location of the screen alarm display.
49 * **Pop-up Interval: **The time of reopen the alarm screen when alarm screen closed.
50 * **Pop-up once: **Pop up alarm screen once, and the screen would not pop up again
51 * **Close window when alarm off: **Automatically close the alarm screen when alarm off.
52
53 (% class="box infomessage" %)
54 (((
55 **✎Note:**
56
57 * If the "cloud" function is enabled and "upload to cloud" is checked, the communication port of the address in the configuration of the imported bit alarm record must be the same as that of the current project; otherwise, it cannot be used normally.
58 * The number of alarm configuration points reported to the cloud cannot exceed 20, or the sum of imported alarm records and the current alarm records cannot exceed 20. If it exceeds, please reconfigure.
59 )))
60
61 **Operating Procedures of Adding One Alarm**
62
63 * Click "Project"→"Bit Alarm" as below shows.
64
65 (% style="text-align:center" %)
66 [[image:8.Basic Function_html_5f8da20315334bac.png||data-xwiki-image-style-alignment="center" height="144" width="539" class="img-thumbnail"]]
67
68 * Click "Add" button to open "Bit Alarm" setting window.
69
70 (% style="text-align:center" %)
71 [[image:8.Basic Function_html_94a019683b506e15.png||data-xwiki-image-style-alignment="center" height="307" width="554" class="img-thumbnail"]]
72
73 * Set "Bit Address".
74 * Set "Alarm Condition".
75 * Set "Content".
76 * Other settings can be set according to the actual situation".
77 * Click "OK" button to complete settings.
78
79 == Word alarm ==
80
81 Word alarm is to monitor the word address of a device. If the data meets the set conditions, an alarm will be generated.
82
83 Click "Project"→"Word alarm", it is displayed as the following figure.
84
85 (% style="text-align:center" %)
86 [[image:字报警 1.png||class="img-thumbnail"]]
87
88 **Alarm Name:** You can set alarm name for it. Alarm Name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), (' ') and other non-English characters.
89
90 **Alarm Address: **It is used for setting word address for word alarm, such as HDW0.
91
92 **Data Format: **16-bit unsigned decimal, 16-bit signed decimal, 16-bit BCD, 32-bit unsigned decimal, 32-bit signed decimal, 32-bit BCD, 32-bit float.
93
94 **Group No.: **Group number of word alarm. The name is unique and cannot be duplicated.
95
96 **Upload to Cloud: **The data upload by "word alarm" is stored in the Cloud and it is alarm data. (Only ig series and 8000/9000 series with -R after system upgrade are supported)
97
98 (% class="box infomessage" %)
99 (((
100 **✎Note:**
101
102 * If the "cloud" function is enabled and "upload to cloud" is checked, the communication port of the address in the configuration of the imported word alarm record must be the same as that of the current project; otherwise, it cannot be used normally.
103 * The number of alarm configuration points reported to the cloud cannot exceed 20, or the sum of imported alarm records and the current alarm records cannot exceed 20. If it exceeds, please reconfigure.
104
105 (% style="margin-left:auto; margin-right:auto; width:358px" %)
106 |=(% style="width: 79px;" %)Series|=(% style="width: 276px;" %)Number of Alarm upload to Cloud
107 |(% style="width:79px" %)8000-R|(% style="text-align:center; width:276px" %)200
108 |(% style="width:79px" %)9000-R|(% style="text-align:center; width:276px" %)200
109 |(% style="width:79px" %)3000ig|(% style="text-align:center; width:276px" %)20
110 |(% style="width:79px" %)8000ig|(% style="text-align:center; width:276px" %)200
111 |(% style="width:79px" %)MD|(% style="text-align:center; width:276px" %)20
112 )))
113
114 **Record alarm:**  Whether to record the alarm history data of word alarm, if checked, it will be saved in the designated storage location.
115
116 **Not save alarm OFF:** If checked, after the alarm is dismissed, the corresponding alarm records will be deleted from the log file.
117
118 **Alarm Condition**: Alarm is triggered when designated address meets the alarm condition, it provides four conditions;
119
120 1. **High alarm:** Alarm is triggered when it reaches high limit. It can be a constant or a variable
121 1. **Low alarm:** Alarm is triggered when it reaches low limit. It can be a constant or a variable
122 1. **Range alarm:** Alarm is triggered when it exceeds the range. It can be a constant or a variable
123 1. **Equivalent alarm: **Alarm is triggered when the value equals to the given data. It can be a constant or a variable
124
125 **Alarm Info: **It is used for setting alarm content (command);
126
127 **Alert: **It is used to mark whether the alarm has occurred. if an alarm occurs, the address of "control bit" will be written to 1. If "clear alert when alarm OFF" is checked, the address of "control bit" will be written to 0.
128
129 **Alarm Screen: **Pop-up alarm screen (it need to be sub-screen);
130
131 1. **Position: **The location of the screen alarm display.
132 1. **Pop-up Interval: **The time of reopen the alarm screen when alarm screen closed.
133 1. **Pop-up once: **Pop up alarm screen once.
134 1. **Close window when alarm off: **Automatically close the alarm screen when alarm off.
135
136 **Beep when alarm ON: **beep works when the alarm is triggered, in the default mode, the beep works until the alarm is released.
137
138 **Beep once:** Beep works once, when alarm is triggered.
139
140 **Alarm List**
141
142 It displays all the word alarm lists; it will show the alarm information;
143
144 **Operating Procedures of Adding One Alarm**
145
146 * Click "Project"→ "Word Alarm" as below shows.
147
148 (% style="text-align:center" %)
149 [[image:8.Basic Function_html_1b59522c984cd7c2.png||height="144" width="492" class="img-thumbnail"]]
150
151 * Click "AddClick" button to open "Word Alarm" setting window.
152
153 (% style="text-align:center" %)
154 [[image:8.Basic Function_html_942107c81fc6901c.png||height="307" width="554" class="img-thumbnail"]]
155
156 * Set Basic information of word alarm.
157 * Set "Content".
158 * Other settings can be set according to the actual situation.
159 * Click "OK" button to complete settings.
160
161 == How to show the variables in alarm info? ==
162
163 We can write some codes in the alarm info and add variables to the alarm info to make the alarm info clearer.
164
165 **{Address,Data format}**
166
167 (% style="height:10px; width:250px" %)
168 |=Letter|=Mean
169 |B|Binary
170 |O|Octal
171 |U|Unsigned
172 |H|Hex
173 |b|BCD
174 |F|32-bit floating
175 |S|Signed
176 |C|String
177 |W|Word
178 |D|Dword
179 |T|Dword string
180
181 Example:
182
183 Unsigned,BCD,32-bit floating,Signed:
184
185 {HDW100,UW2.1} ~-~-- add a variables into the alarm info:address-HDW100 ,data format-unsigned,Word,2 Integer,1 Decimal.
186
187 Binary,Octal,Hex:
188
189 {HDW100,HD8} ~-~-- add a variables into the alarm info:address-HDW100 ,data format-Hex,Dword,8 Integer.
190
191 String
192
193 {HDW100,C32} ~-~-- add a variables into the alarm info:address-HDW100 ,data format-String,32 length.
194
195
196 **HMI Alarm Demo Download Link**
197
198 [[https:~~/~~/drive.google.com/open?id=1Llq03CMISM_1mMIfU308hxFbs4rGdQGP>>url:https://drive.google.com/open?id=1Llq03CMISM_1mMIfU308hxFbs4rGdQGP]]
199
200 = **Recipe** =
201
202 == Overview of recipe ==
203
204 Recipes are composed of multiple groups of information materials with the same structure and different data. Due to the sameness of these materials, users can edit them into a group of recipes to facilitate data transfer between HMI and PLC. Therefore, this function can be utilized for information that has a similar structure to achieve efficient and correct transmission.
205
206 Data operation of recipe: Upload and download. Upload refers to reading the data of [The set address] group and writing the data of this group to the corresponding recipe file. Download refers to reading a group of data from the recipe file and assigning the group of data to [The set address].
207
208 The recipe data can be stored in external equipment, such as USB flash disk and SD card. The whole recipe data can be viewed with the [Recipe record] object.
209
210 (% class="wikigeneratedid" id="HExample" %)
211 **Example**
212
213 Taking automobile paint spraying as an example, suppose that when a newly manufactured automobile needs to be painted, it needs to spray different colors (red, green and blue) on the top, bottom and outside of the automobile, and the original colors provided are only red, green and blue. At this time, to spray different colors, it needs the appropriate ratio of these three colors, and the spraying time of different parts is different. At this time, the function of recipe needs to be executed. Check Table 1 for details.
214
215 Table 1 Example recipe
216
217 |Part|Red (Kg)|Green (Kg)|Blue (Kg)|Spraying time (Seconds)
218 |Top|2|2|1|30
219 |Bottom|3|1|2|40
220 |Outside|2|3|3|20
221
222 From the above table, one group of recipes is needed when spraying different parts, and three groups of recipes can be established, and each group of recipes has four ingredients: Red, Green, Blue, Spraying time. The value of each ingredient is different in different groups of recipes.**Recipe configuration**
223
224 The recipe function needs to be used with the recipe configuration area and [Recipe record] object. Click [Recipe] in the [System configuration/Record setting] in the upper left side of the software [[image:1698393787529-717.png]]and the following interface will pop up:
225
226 (% style="text-align:center" %)
227 [[image:1.png]]
228
229 Click [Add] to pop up the recipe setting interface, as shown in the following figure:
230
231 (% style="text-align:center" %)
232 [[image:2.png]]
233
234 |Recipe configuration options|Description|Notice
235 |Recipe name|Name the current recipe|Note: Recipe name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), ('') and other non-English characters.
236 |Group number|Configure the group number of the current recipe, ranging from 0 to 1000|
237 |Number of ingredients|Configure the number of the current ingredient, ranging from 0 to 1500|
238
239 |Data configuration options|Description|Notice
240 |Starting address|The data of group in the recipe file is read out and displayed in the address, which will be automatically assigned according to the set data format of each ingredient. For example, if each group has 10 ingredients, the ingredient format is 16-bit unsigned decimal number, and the starting address is HDW0, then 10 addresses (HDW0-HDW9) correspond to 10 ingredients respectively, the values in HDWO correspond to the values in ingredient 1, the values in HDW1 correspond to the values in ingredient 2, and so on.|
241 |Recipes are read and written at different addresses|When "recipe written and read address are different" is checked, the address configured by the read address is only used for recipe read data operation, and the address set in this area is used to control recipe written data operation.|
242 |Data format|Configure the data format of this recipe. There are 9 modes of data format: 16-bit BCD code, 16-bit signed decimal, 16-bit unsigned decimal, 32-bit BCD code, 32-bit signed decimal, 32-bit unsigned decimal, 32-bit (single-precision) floating points, 64-bit (double-precision) floating point, string.|(% rowspan="2" %)(% class="box infomessage" %)
243 (((
244 **✎Note:** The data format set here is for all components of the recipe, that is, the data format of all components in a recipe is consistent.
245 )))
246 |Decimal point position|Configure the selection of integer and decimal places of data.
247 |Enable discontinuous addresses|If checked, the address of the recipe list can be modified.|
248 |Language|Recipe display language is selectable.|
249 |Recipe list|The recipe list displays the configured recipe parameter information in the list according to the settings. The parameters of each ingredient in the recipe list can be modified at the same time: For example, the name of the ingredient, the data format of the ingredient, the address of the ingredient, and directly filling in the data of each ingredient in each group.|
250 |Insert group|Click [Insert group], enter the number of groups to insert, and the corresponding row will be added to the recipe list.|
251 |Delete group.|Click [Delete group] to select the group to delete|
252 |Insert ingredient|Click [Insert group], enter the number of groups to insert, and the corresponding row will be added to the recipe list.|
253 |Delete ingredient|Click [Delete ingredient] to select the ingredient to delete.|
254 |Data import|Import existing data files, supporting .xlsx .xls .csv format.|
255 |Data export|Export configured recipe data|
256
257 Traditional recipe is composed of multiple groups of information with the same structure and different data. Due to the similarity of these information, you could edit them into a set of recipes to facilitate the transfer of data between HMI and PLC.
258
259 Data operation
260
261 1. **Read:** Read a group of data from the recipe file and assign the group of data to the set address.
262 1. **Write: **Read a group of data from the set address and assign the group of data to the corresponding recipe file.
263
264 PI Series HMI has Recipe function, Recipe function keeps data in the HMI, used to download the data from HMI to designated device addresses, or upload the data from device addresses to HMI.
265
266 The maximum number of group in recipe is 1000, and the maximum number of member in each group is 1500.
267
268 Recipe could store the data in USB flash disk and SD card and view the recipe data by object "Recipe display". It has two mode: simple mode and advanced mode.
269
270 1. **Simple: **Only support the data operation of one recipe file, including read and write.
271 1. **Advanced:** Support the data operation of multiple recipe files, including read, write, insert and index. View and select recipe file by object "File list".
272
273 Recipe function settings will be display in "[[Recipe display>>http://docs.we-con.com.cn/wiki/pistudio/view/Helps/06.Objects/#HRecipedisplay]]" object.
274
275 **Description**
276
277 (% style="text-align:center" %)
278 [[image:8-1Recipe.png]]
279
280 **Basic**
281
282 * **Recipe Folder:** Give Recipe folder name (It can be used, when setting Recipe display object);
283 ** (% class="box infomessage" %)
284 (((
285 **✎Note: **Recipe Folder name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), (' ') and other non-English characters;
286 )))
287 * **Group: **Set the recipe group number, the number of elements, the data format. The data format has 8 modes: 16-bit signed decimal, 16-bit unsigned decimal, 16-bit BCD, 32-bit signed decimal, 32-bit unsigned decimal, 16-bit BCD, 32-bit floating point number, 64-bit (double-precision) floating-point number, string, and the choice of data integer and decimal places.
288 * **Elements:** It sets members' initial number of each group;
289 * **Data Format:** There are some formats can be supported in Recipe, like 16-bit BCD, 16-bit signed, 16-bit unsigned, 32-bit BCD, 32-bit signed, 32-bit unsigned, 32-bit floating and string. If each member requires different formats, please set it one by one in form;
290 * **Decimal: **It sets integer and scale digits;
291
292 **Mode Selection: **Select Simple or Advanced mode. Recipe file is divided into simple mode and advanced mode. Only in advanced mode can exist multiple recipe files used at the same time. (used wiht file list onject), Simple mode can only support a recipe file; Aadvanced mode can insert group information and reordered.
293
294 Function address: all operations are done through function addresses, different operating value is as follows:
295
296 * = 0: no operation;
297 * = 1: trigger read data;
298 * = 2: new trigger or update (If there is group number, it updates.)
299 * = 4: insert (only valid in advanced mode)
300 * = 8: delete (Delete according to the writing group number. If write and read address are consistent, refer to the reading group number);
301 * = 16: delete and sorted ((Delete according to the writing group number. If write and read address are consistent, refer to the reading group number)
302 * = 64: import CSV recipe file.
303
304 **Use Multiple File**
305
306 Check it to use more than one recipe file in HMI, but this option only valid in [Advanced mode];
307
308 **Select language**
309
310 The text in HMI can be in 8 languages, user can set language in here;
311
312 **Address**
313
314 1. **Group:** This address is for selecting group number;
315 1. **Start: **This is starting address is for reading and writing in recipe, PIStudio will automatically assigns addresses for each members;
316 1. **File(16 words): **This address only available when enable the Use Multiple File. This setting address is for input the recipe file's filename.
317
318 **Use Index**
319
320 If the value from Group address is changed, Read address will display the new data according to new group number immediately. Relatively, if the data of write address is changed, the corresponding group from table is also changed.
321
322 **Query by Element**
323
324 Enable it for querying group by specify element, select a primary key from all the elements, except the group number. This element value from all groups must be unique if want to set as primary key;
325
326 (% class="box infomessage" %)
327 (((
328 **✎Note: **When this option is enabled, Group address will be invalid.
329 )))
330
331 **Use Independent Write Address**
332
333 To separate Recipe read address and write address.
334
335 **Use Insert**
336
337 It inserts data into the specified group, if the specified group already exists, it would not cover the original data, while it will move the original group next one after it.
338
339 **Discontinuous Address**
340
341 Whether enable the non-consecutive recipe operation addresses or not. If disabled, the recipe address will recover as the continuous addresses.
342
343 (% class="box infomessage" %)
344 (((
345 **✎Note: **This function only supported in HMI+, i series, ie series, ig series.
346 )))
347
348 **Description of adcanced mode**
349
350 According to the recipe configuration information in Figure 2 above. The function address is HDW70, and each function configuration corresponds to the group number address, recipe element address and recipe file name address. The recipe information configured in figure 2 can be displayed in the table in figure 3 with the "Record Display" object.
351
352 [[image:image-20220806111333-1.jpeg]]
353
354 **Read recipe**: Input 1 to the file name, when the group number addresses HDW100=1 and HDW70=1 (read), the element data of the first group (ID=1) is written to the recipe address from the recipe file. As shown in Figure 3 above: HDW105=1, HHDW106=2, HDW107=3, HDW108=4, HDW109=5.
355
356 **Write recipe**: Input 1 to the file name, when the group number addresses HDW101=4 and HDW70=2 (write), the data will be read from the recipe address and written to the corresponding group of the recipe file. As shown in figure 3 above: HDW110=20, HHDW111=21, HDW112=22, HDW113=23, HDW114=24. Write the data of this set to the elements of ID=4 in the recipe table (if there is no data of Group 4 in the recipe file, a new set of data will be added; If there is data of Group 4 in the original recipe, the original data will be overwritten and the latest data will be displayed in the recipe file).
357
358 **Index recipe**: When the file name is input 1, when the group number address HDW102=3, the data of ID=3 (Group 3) in the recipe file will be directly displayed in the component address of the index, that is, HDW115=11, HHDW116=12, HDW117=13, HDW118=14 and HDW119=15. If the data of the index component address is modified, the modified data will be automatically filled into the table of the recipe file, that is, the data of the recipe file will be automatically updated after the data is modified.
359
360 [[image:image-20220806111355-2.jpeg]]
361
362 **Insert recipe**: Input 1 to the file name, when the group number addresses HDW103=3 and HDW70=4 (insert), the data of the 3rd group will be inserted, but the data of the third group already exists in the original recipe file (see Figure 3 above), then the original data will be moved down by one group, that is, the original 3rd group will become the 4th group, and so on, and HDW120=16, HHDW121=17, HDW122=18, HDW123=19 and HDW124=20 will be written into the new 3rd group of the recipe file at the same time. The results are shown in Figure 4 above.
363
364 When the group number address HDW101=2 (**The delete function only works on the group number of the write function**), HDW70=8 (delete), the data in the recipe file with ID=2 (Group 2) will be deleted.
365
366 When the group number address HDW101=5 (**The delete function only works on the group number of the write function**), HDW70=16 (delete and sort), the data of ID=5 (Group 5) in the recipe file will be deleted, and the original ID=6 (Group 6) data will be reordered to become the new Group 5 data, the original ID=7 (Group 7) data will be reordered to become the new Group 6 data, and so on.
367
368 **Recipe Demo Download Link: **[[Download>>url:https://drive.google.com/open?id=1Cjbq_tW-NIirHFBpxt47g7IKvoYaWqUR]]
369
370 == Calling CSV recipe file ==
371
372 **Overview**
373
374 The recipe files used by the regular series HMI are in CSV format, and the recipe files used by the current series HMI are in database format. In order to be compatible with CSV format recipe files on the current series of HMI, please follow the instruction when using it.
375
376 **Operations**
377
378 Create the recipe as it is configured. The default recipe file name is “1. rcp2”, which is placed in folder 123, as shown in the following figure.
379
380 (% style="text-align:center" %)
381 (((
382 (% style="display:inline-block" %)
383 [[Figure 1>>image:image-20220806100702-2.jpeg]]
384 )))
385
386 2. Place a "Recipe Record Display" object and a "File List" object on the project screen for viewing the recipe files in the folder 123, and the address configuration in the object should be consistent with the above configuration.
387
388 (% style="text-align:center" %)
389 [[image:image-20220806100753-3.jpeg]]
390
391 By configuring the address in the table and combining the recipe function, the CSV recipe files of regular series are imported.
392
393 |=Address range|=Object type|=Address function
394 |HSW1050 to 1065|Text input object|Enter the CSV recipe file name to import
395 |HSW1066|Numerical input object|Import CSV file type:(((
396 * = 0: Custom CSV file (all data in the file is valid)
397 * = 1: Normal recipe file for regular series HMI (the data in line 1 of the file is invalid)
398 * = 2: Special recipe file for regular series HMI (the data in line 1 and 2 and column 1 of the file are invalid)
399 )))
400 |HSW1067|Numerical input object|(((
401 Where the CSV file is saved:
402
403 * = 0: In the CsvFile directory of U disk
404 * = 1: In the CsvFile directory of the SD card
405
406 **The path for offline simulation is: C:\ HMIEmulation\ CustomFileDir\ CsvFile**
407 )))
408 |HSW242|Numerical input object|Returns the results of the csv import:(((
409 * = 37: CSV file imported successfully
410 * = 38: CSV file import failed
411 )))
412
413 **Select CSV recipe file (take U disk as an example):**
414
415 Using the file list object, select the recipe file in the U disk by path, and configure the recipe file name address directly to the special address HSW1050 in the above table, which can directly detect the CSV file in the U disk; Select the recipe file in the file list, and write the selected recipe file name into the recipe file name: In HSW1050 to 1065.
416
417 Use the special address of the above table to configure the path of the CSV file: HSW106, configure recipe file name: HSW1050 to1065
418
419 Use HSW1066 address to select the corresponding CSV recipe file type.
420
421 * HSW1066 = 0: Import a user-defined CSV recipe file (all data in the custom CSV file must be valid);
422
423 (% style="text-align:center" %)
424 [[image:image-20220806101129-5.jpeg]]
425
426 * HSW1066=1: Import the normal recipe file of regular series HMI (the data in line 1 of the file is invalid);
427
428 The data in line 1 of the normal recipe file is used to define the format of the recipe and will not be imported into the recipe table as recipe information, **but you must ensure that the data in line 1 representing the elements and number of groups is correct, otherwise the CSV recipe file will fail to be imported.**
429
430 (% style="text-align:center" %)
431 [[image:image-20220806101520-6.jpeg]]
432
433 * HSW1066=2: Import the special recipe file of regular series HMI (the data in line 1, 2 and column 1 of the file are invalid);
434
435 In the special recipe file, line 1 is used to define the format of the recipe, line 2 is used to define the element name of the recipe, and column 1 is used to define the group name of the recipe, so lines 1, 2 and column 1 of the special recipe will not be imported into the recipe table as recipe information. **During use, ensure that the data such as the number of groups and elements representing the recipe format in the first line are correct, otherwise the import of the CSV recipe file will fail.**
436
437 (% style="text-align:center" %)
438 [[image:image-20220806102610-7.jpeg]]
439
440 **Perform import**
441
442 After configuring the saving path of CSV recipe file, the name of recipe file and the type of recipe according to the above steps, the method of transferring CSV file to DB file is as follows:
443
444 * Configure the DB recipe file name by text input object: HDW500 = 3 (recipe file configured in Figure 1),
445 * Set the recipe function address to: HDW1000 = 64 (the function address configured in Figure 1),
446 * Transform the CSV recipe file in U disk into DB recipe file with file name “3.rcp2”.
447
448 **DB recipe file for storing CSV data:**
449
450 Simple mode: When the recipe file is set to simple mode, the file of CSV data is saved as the DB recipe file of 1. rcp2 by default.
451
452 Advanced mode: When the recipe is enabled in advanced mode (multi-file recipe), the imported CSV file data is saved to the file recorded at the recipe file address HDW500 (the address configured in Figure 1).
453
454 **Import results:**
455
456 * HSW242 = 37: Import succeeded;
457 * HSW242 = 38: Import failed.
458
459 **Precautions:**
460
461 * Ensure that the data format of each element in the CSV file is the same as the recipe data format set in the software (DB), and ensure that the elements of each row in the valid data area is the same as the elements set in the software (DB);
462 * When the elements of a line in CSV file is more than the elements set in the software (DB), it will prompt the import failure;
463 * When the CSV file imported into the regular series HMI is a recipe file, the data representing the recipe format (elements, number of groups, whether it is a special recipe) in line 1 must be correct, otherwise the import of CSV file will fail.
464
465 == **Recipe record function** ==
466
467 **Basic setting**
468
469 (% style="text-align:center" %)
470 [[image:3.png]]
471
472 Recipe selection: Select the recipe name to be displayed. The list is all the recipes configured in the recipe. If the list is empty, add the recipe in [Recipe].
473
474 Recipe shortcut key setting:
475
476 Add data: Used to add groups.
477
478 Delete data: Used to delete the selected configuration
479
480 Upload recipe: Used to upload the address data of the selected group to the corresponding group in recipe records.
481
482 Download recipe: Used to download the address data of the selected group to the corresponding group in recipe records.
483
484 Import recipe: Used to import the existing recipe files.
485
486 Export recipe: Used to export the current recipe as a file.
487
488 **Graphic**
489
490 (% style="text-align:center" %)
491 [[image:4.png]]
492
493 Style selection: Styles can be switched or customized.
494
495 Background configuration: Set the recipe background, including background color and transparency.
496
497 Table configuration: Set the appearance of recipe table area, including row background color, row spacing color, horizontal header background color, vertical header background color, horizontal header text color, vertical header text color, text color, row selected color, name color, line color and cell style.
498
499 **Expansion**
500
501 (% style="text-align:center" %)
502 [[image:5.png]]
503
504 Object lock: With the interlock address, the object is locked and the lock icon is displayed (upper left corner of the object) when the lock address is 0, and the bit switch is operable only when the bit pointed by the interlock bit address is 1. To lock the bit switch when the interlock bit address is 1, just check "Lock in ON".
505
506 Object lock icon: Icons will not display when the [Not display “Lock” icon] option is checked. Icon display will adapt to the change of object size.
507
508 Gray level display: When the object is locked, the text message will be grayed out.
509
510 == **New recipe function address** ==
511
512 In recipe, new special address is used as Function address.
513
514 **Address Type:** RPG
515
516 (% style="text-align:center" %)
517 [[image:企业微信截图_17570533194720.png]]
518
519 (% style="text-align:center" %)
520 [[image:企业微信截图_17570534728083.png]]
521
522 (% class="box infomessage" %)
523 (((
524 Note: There is a set of function address in each recipe.
525 )))
526
527 |(% style="width:107px" %)Name|(% style="width:162px" %)Data format|Length|Function
528 |(% style="width:107px" %)File name|(% style="width:162px" %)String|15 word address|Input file name
529 |(% style="width:107px" %)Record select|(% style="width:162px" %)16-bit unsigned decimal|(((
530 1 word address
531
532 (0-65535)
533 )))|Currently selected record, numbered starting from 0. When the record selection value changes, the corresponding value will be updated.
534 |(% style="width:107px" %)Function address|(% style="width:162px" %)16-bit unsigned decimal|(((
535 1 word address
536
537 (0-65535)
538 )))|(((
539 Enter a specific value to send a command to the selected record
540
541 "1": Add a new recipe record
542
543 "2": Delete the selected recipe record
544
545 "3": Upload the recipe
546
547 "4": Download the recipe
548
549 "5": Update the selected recipe record
550 )))
551 |(% style="width:107px" %)Result|(% style="width:162px" %)16-bit unsigned decimal|1 word address (-32768~-~-32767)|(((
552 View the result of executing the command.
553
554 Display "1": Successfully executed the command
555
556 Display "2": The record limit has been reached and no new records can be added.
557
558 Display "4": No corresponding option
559
560 Display "8": unknown command
561
562 Display "16": recipe download failed.
563
564 Display "32": recipe upload failed.
565
566 Display "64": recipe update failed.
567 )))
568 |(% style="width:107px" %)Record count|(% style="width:162px" %)16-bit unsigned decimal|(((
569 1 word address
570
571 (0-65535)
572 )))|Display the number of records in the current recipe
573 |(% style="width:107px" %)Element address|(% style="width:162px" %)16-bit unsigned decimal|(((
574 1 word address
575
576 (0-65535)
577 )))|Element address
578
579
580
581 = (% style="color:inherit; font-family:inherit; font-size:29px" %)**Traditional recipe**(%%) =
582
583 Traditional recipe is composed of multiple groups of information with the same structure and different data. Due to the similarity of these information, you could edit them into a set of recipes to facilitate the transfer of data between HMI and PLC.
584
585 Traditional recipe function is valid only when the LEVI project is converted to the PI project, and the original project uses the traditional recipe.
586
587 (% class="box infomessage" %)
588 (((
589 **✎Note**: Currently, only HMI+, i series, ie series, and ig series support the traditional recipe.
590 )))
591
592 == Simple recipe mode ==
593
594 Click the "Traditional Recipe" [[image:8-2TraditionalRecipe.png]] in the "Data tool" bar in the upper side of the software, and the following interface will pop up:
595
596 (% style="text-align:center" %)
597 [[image:8-3TraditionalRecipeConfigScreen.png||class="img-thumbnail"]]
598
599 **✎Note**:
600
601 * The recipe folder name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), ('').
602 * The element name of the recipe cannot include following 5 special characters: " **,** " , " **|** " , " **<** " , " **>** " , " **&** " .
603
604 == Recipe display ==
605
606 Select the file type "Traditional recipe file" in object "Recipe Display", and it is recommended to fill in the traditional recipe group number HSW1612 to the address of select line.
607
608 (% class="box infomessage" %)
609 (((
610 **✎Note**: The Recipe Display can display up to 50 groups of 100 elements by default, which can be to display out of range by enabled "Address Control". After the "Address Control" is enabled, the display group number can be reached to 100. If want to display more than 100, please adjust the "Start Group" from "Address Control" to index the display group, as following shown:
611 )))
612
613 (% style="text-align:center" %)
614 [[image:8-4TraditionalRecipeDisplayConfigScreen.png||class="img-thumbnail"]]
615
616 == Recipe transmission address ==
617
618 The special addresses used in the Recipe are shown in the following table:
619
620 (% class="table-bordered" %)
621 |=Address|=Description|=Function
622 |HSW1611|Traditional Recipe transfer operation.|(((
623 ~=1: Recipe download.
624
625 ~=2: Recipe upload.
626 )))
627 |HSW1612|Traditional Recipe group number.|Traditional Recipe group number.
628 |(((
629 HSW242
630 )))|(((
631 Recipe operation result prompt:
632
633 Upload: Data is written to recipe file from address.
634
635 Download: Data is written to the address from recipe file.
636 )))|(((
637 ~=1: Recipe download, start.
638
639 ~=2: Recipe download, execution error.
640
641 ~=6: Recipe download, successful.
642
643 ~=7: Recipe upload, start.
644
645 ~=8: Recipe upload, execution error.
646
647 ~=11: Recipe group name does not exist.
648
649 ~=12: Recipe upload, successful.
650 )))
651
652 == **Recipe index** ==
653
654 The recipe index address RPW is mainly used for editing traditional recipes, and it is more convenient to modify the data and display of recipes. Only need to modify and display the data of the recipe file through "Numeric Input/Display" Object and "Word Switch".
655
656 The recipe index area (RPW)'s instruction as follows:
657
658 1. RPW~*~*~#~#~#~#, a total of six digits, the first two ~*~* represent the Recipe group number, ~#~#~#~# represents the element order number. For example, RPW010000 indicates the 1st element of the Recipe group No.1, and RPW110002 indicates the 3rd element of the Recipe group No.11.
659 1. If the indexed group number or element number does not exist, the value of RPW defaults to zero. For example, RPW110011 represents the 12th element of the Recipe group No.11. If it does not exist, the value returned by accessing RPW110011 is zero. The value written in RPW110011 will not be saved to the recipe file.
660
661 * **✎Note**: As long as RPW~*~*~#~#~#~# exists, any object "writes" to HPW~*~*~#~#~#~# will be saved to the recipe file. 
662
663 (% start="3" %)
664 1. The RPW register only supports word address access.
665 1. It can be known from the coding method of RPW~*~*~#~#~#~# that the range of RPW is from RPW000000-RPW990450, wherein the range of group number is 0-100, and the range of element is 0-450.
666
667 == Recipe example ==
668
669 The recipe index makes the modification and display of recipe data more convenient. Only need to modify and display the data of the recipe file through "Numeric Input/Display" Object and "Word Switch".
670
671 Edit the recipe configuration, create three groups of recipes, 4 elements for per group: Red, green, blue, spraying time, as following shown:
672
673 (% style="text-align:center" %)
674 [[image:8-5TraditionalRecipeCaseConfig.png]]
675
676 RPW 0~~3 can display the data of group for the selected line. RPW10000~~10003, RPW20000~~20003, RPW30000~~30003 each address can display the single element. Directly modify the content of the RPW address and then modify the recipe data, as following shown:
677
678 (% style="text-align:center" %)
679 [[image:8-7TraditionalRecipeCaseShowNoOpera.png]]
680
681 After selecting the 2nd group, trigger the download button to download the whole group data to the corresponding element address (For this case, the data will write into HDW0~~3), or trigger the upload button to upload the content of the element address to the specified recipe group.
682
683 (% style="text-align:center" %)
684 [[image:8-6TraditionalRecipeCaseShow.png]]
685
686 = **Trend chart** =
687
688 Trend chart function is used for displaying the real-time data in HMI as curve graph, which X axis represent as time, Y axis represent as data.
689
690 Click "Project" → "Trend chart", it will pop up the following screen. Click "Add" to creat new curve record.
691
692 (% style="text-align:center" %)
693 [[image:趋势图配置 001.png||class="img-thumbnail"]]
694
695 **Settings**
696
697 (% style="text-align:center" %)
698 [[image:趋势图设置 2.png||height="507" width="866"]]
699
700 **(1) Basic settings**
701
702 1. **Curve NO.: **It is for setting curve number,
703 1. **Curve Name:** It is for setting curve name. The length limitation is 31 bytes.
704 1. **Curve (1~~8):** It is for setting the number of curves. The default is 3.
705 1. **Dots of one curve: **It is for setting dots number of each curve. The default is 1000, but the maximum dots are 10,000 for all the curves.
706
707 **(2) Sample Type**
708
709 1. **Sample method:** There are two types, one is Cycle sample, the other is Trigger cycle sample. If you select Trigger cycle same mode, the trigger sample address is required to edit.
710 1. **Sample unit:** 100ms.
711
712 **(3) Quick Setting**
713
714 1. **Data format: **It is for setting all the curves, select the data format for all curves, and setting the reading addresses for curves. There are as follows.
715
716 (% style="text-align:center" %)
717 [[image:趋势图设置 3.png||class="img-thumbnail"]]
718
719 (% start="2" %)
720 1. **Sample address: **Fill in the start address that read the device data. If the sampl address is consecutive, check "use continuous address". For example, set HDW0 as start address, curve number is 3, then the HDW0 is for Curve 1, HDW1 is for Curve2, HDW2 is for Curve 3.
721
722 **(4) Curve Table:** The sample address you have set would display on it. Click the corresponding box to modify the content.
723
724 (% class="box infomessage" %)
725 (((
726 **✎Note: **Curve names can only consist of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_') (' '), and other non-English characters.
727 )))
728
729 **Trend Chart Demo Download Link**
730
731 [[https:~~/~~/drive.google.com/open?id=1smnaAvSxOWC0WQK4_uvqHXWn4vUZxGJC>>url:https://drive.google.com/open?id=1smnaAvSxOWC0WQK4_uvqHXWn4vUZxGJC]]
732
733 = **History XY plot** =
734
735 Different from TrendChart, uses need to set history XY curve items in project. Please click "Project"-> "History XY Plot" to open the setting screen.
736
737 Recipe function settings will be display in "[[History XY Plot>>path:https://docs.we-con.com.cn/bin/view/PIStudio/08.Basic%20Function/#HHistoryXYplot]]" object.
738
739 (% style="text-align:center" %)
740 [[image:历史XY 2.png||class="img-thumbnail"]]
741
742 (% style="text-align:center" %)
743 [[image:历史XY 3.png||class="img-thumbnail"]]
744
745 **(1) Basic settings**
746
747 1. **Curve NO.: **It is for setting curve number,
748 1. **Curve Name:** It is for setting curve name. The length limitation is 31 bytes.
749 1. **Curve (1~~8):** It is for setting the number of curves. The default is 3.
750 1. **Dots of one curve: **It is for setting dots number of each curve. The default is 1000, but the maximum dots are 10,000 for all the curves.
751
752 **(2) Sample Type**
753
754 1. **Sample method:** There are two types, one is Cycle sample, the other is Trigger cycle sample. If you select Trigger cycle same mode, the trigger sample address is required to edit.
755 1. **Sample unit:** 100ms.
756
757 **(3) Quick Setting**
758
759 1. **Data format: **It is for setting all the curves, select the data format for all curves, and setting the reading addresses for curves. There are as follows.
760
761 (% style="text-align:center" %)
762 [[image:image-20220616145435-1.png]]
763
764 (% start="2" %)
765 1. **Sample address: **Fill in the start address that read the device data. If the sample address is consecutive, check "use continuous address". For example, set HDW0 as start address, curve number is 3, then the HDW0 is for Curve 1, HDW1 is for Curve2, HDW2 is for Curve 3.
766
767 **(4) Curve Table:** The sample address you have set would display on it. Click the corresponding box to modify the content.
768
769 (% class="box infomessage" %)
770 (((
771 **✎Note: **Curve names can only consist of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_') (' '), and other non-English characters.
772 )))
773
774 **Operating Procedure**
775
776 * Click "Project" → "History XY Plot" to open the function selecting windows.
777
778 (% style="text-align:center" %)
779 [[image:8.Basic Function_html_5da6ca44bd28acbe.png||height="144" width="533" class="img-thumbnail"]]
780
781 * Click "Add" button to open "History XY Plot” setting windows.
782
783 (% style="text-align:center" %)
784 [[image:8.Basic Function_html_6345b50ea55168fa.png||height="307" width="554" class="img-thumbnail"]]
785
786 * Setting the function of History XY Plot.
787 * Click "OK" to save the setting.
788
789 **Download Link**
790
791 [[https:~~/~~/drive.google.com/open?id=1t4_HuRmIJJ-B5ryA2kVMadD9FywKhZ4r>>url:https://drive.google.com/open?id=1t4_HuRmIJJ-B5ryA2kVMadD9FywKhZ4r]]
792
793 = (% style="color:inherit; font-family:inherit; font-size:29px" %)**Data record**(%%) =
794
795 The data record function is organized according to the structure below. In a project, there can be multiple record groups, each record group containing multiple channels. Different groups have different sampling times.
796
797 The topology is shown in the following figure.
798
799 (% style="text-align:center" %)
800 [[image:8.Basic Function_html_1b4bd09dafa7e049.png||height="332" width="554" class="img-thumbnail"]]
801
802 The data record stored in SD card is also organized according to the above figure.
803
804 The sample time and save time is consistent in the same record group. There are multiple channels in the group, When the sampling time is up, every channel would collect data to PLC register according to its own address.
805
806 **Sampling interval: **The interval between two consecutive samples was recorded.
807
808 As long as the project uses the data record function and supports the large-capacity storage module, the system will sample data according to the set sampling interval and save data according to the set saving interval.
809
810 For the file storage of data, see the file size configuration during data record configuration.
811
812 ✎**Note: **
813
814 After enable the Cloud and check the box of Upload to Cloud, the communication port settings of the address in the imported Data record configuration must be the same as the communication port settings of the current project, otherwise it cannot be used normally.
815
816 The number of Data records upload to Cloud shall not exceed the limit value, or the sum of the imported Data records and the number of existing alarm records shall not exceed the limit value. the specific limitation as following table:
817
818 (% style="margin-left:auto; margin-right:auto; width:513px" %)
819 |=(% style="width: 70px;" %)Series|=(% style="width: 442px;" %)Number of Data Record upload to Cloud
820 |(% style="width:70px" %)8000-R|(% style="text-align:center; width:442px" %)100
821 |(% style="width:70px" %)9000-R|(% style="text-align:center; width:442px" %)100
822 |(% style="width:70px" %)3000ig|(% style="text-align:center; width:442px" %)50
823 |(% style="width:70px" %)8000ig|(% style="text-align:center; width:442px" %)100
824 |(% style="width:70px" %)MD|(% style="text-align:center; width:442px" %)50
825
826 The record group name can only be composed of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_'), ('') and other non-English characters.
827
828 Channel name cannot incloud following symbols: :" , ", " | ", " < ", " > ", " & ".
829
830 (% class="wikigeneratedid" id="HSettings" %)
831 **Settings**
832
833 (% style="text-align:center" %)
834 [[image:数据记录设置 1.png||height="533" width="848" class="img-thumbnail"]]
835
836 **Operating Procedures**
837
838 1. Click "Project"->"Data record" as below shows.
839 1. Click "Add" button to open "Data record" setting window.
840 1. Enter group name, the default is "GroupName0"
841 1. Select "Trigger function" mode, such as "No trigger".
842 1. Set "Total channels", such as 3.
843 1. Click "Apply" button.
844 1. Set Sample cycle, such as 15.
845 1. Set "Start channel" in "Quick settings", such as 4 0.
846 1. Check group information in "Channel list" as below.
847 1. Click "Save" button to complete settings.
848
849 The figure above display the group of current project. The data record file would stored in "DataLogFile" folder, and the data of every  group would have a data file. The file suffix is in "db" format.
850
851 ✎**Note: **
852
853 * For HMI series 8000 and above, the size of a single file cannot exceed 300M and the total file capacity cannot exceed 1000M.
854 * For HMI series 3000, the size of a single file cannot exceed 4M and the total file capacity cannot exceed 10M.
855 * If the total amount exceeds the range, an alarm will be given during project compilation.
856
857 (% style="text-align:center" %)
858 [[image:数据记录设置 2.png||height="572" width="850" class="img-thumbnail"]]
859
860 **(1) Group name:** Set group name, and he name should be unique.
861
862 **(2) Trigger function:** There are four modes to trigger record.
863
864 1. **No trigger: **Data will be recorded in every sample time.
865 1. **Trigger to record by sample cycle: **Data will be recorded in every same time, when trigger control bit set ON.
866 1. **Trigger to record once and reset: **Data will be recorded when trigger control bit set ON, and the bit will be reset automatically.
867 1. **Trigger to record once: **Data will be recorded when trigger control bit set ON, and the bit need to be reset manually.
868 1. **Trigger address: **It is only valid when the trigger condition is selected. The monitoring cycle for trigger sampling address is 1s.
869
870 **(3) Total channels (1~~100): **Set the numbers of channels. Click "apply" to view the channel lists on the right record channel.
871
872 **(4) Sampling cycle: **If you check "collect control address", the sampling interval is the value of the address. The unit is second. For example, Sample cycle=15s. It means that records data one time every 15s.
873
874 **Timing address:** It sets address to change sample time when HMI is running;
875
876 **(5) Total records:** It sets data record number in one data record file. If the data file size is beyond the current file size. The old data will be deleted, and the new data will replace the old data. Please remember to back up the old data record file.
877
878 **Abnormal value:** It sets a value, when communication fails, data record will record this value;
879
880 **(6) Upload to Cloud**: The data uploaded by Data Record is stored in the Cloud(Only ig series). The maximum number of record is 20.
881
882 **(7) Quick Settings**
883
884 1. **Start Channel:** It sets the continuous addresses for channels.
885 1. **Data Format: **It sets the same data format for channels.
886 1. **Number of Digits:** It sets the digits’ number for channels.
887 1. **Language Settings**: The text in HMI can be in 8 languages, user can set language in here.
888
889 **(8) Channel List**: Besides quick settings, user can set channel name, address, data format, and so on one by one according to real situation.
890
891 **✎Note:**
892
893 * After enabling the Cloud function and checking the upload to the Cloud, the communication port settings of the address in the imported Data record configuration must be the same as the communication settings of the current project, otherwise it cannot be used normally.
894 * The range of upload to the Cloud from Data record configuration must not exceed 50, or the total number of imported Data records and the number of currently existing Data records must not exceed 50. If it exceeds, it will prompt you to reconfigure, should reduce the number.
895 * The channel name can only be composed of English characters, (0~~9), (a~~z), (A~~Z), ('_'), ('').
896 * The channel name does not include these 5 special characters: ", ", "| "," <", "> "," & ".
897 * The data would be overwritten automatically if the capacity exceed the maximum capacity. For 8000/9000 series, the size of single file cannot exceed 300MB, and total capacity of data records cannot exceed 1000MB. For 3000/3000i/3000ie series, the size of single file cannot exceed 4MB, and total capacity of data records cannot exceed 10MB. If the total amount exceeds the range , an error will be prompted when the project is compiled.
898
899 You could click here to jump to object "[[Data Record Display>>https://docs.we-con.com.cn/bin/view/PIStudio/06.Objects/#HDatarecorddisplay]]"
900
901 = Column Chart =
902
903 = **User permission** =
904
905 **Introduction**
906
907 1. User permission is one of expansion function in PI Series HMI; it provides multi-level of permission for control HMI operations.
908 1. User need to set the user and group during designing project. Different groups have different permission levels for accessing. Each user should be added into the specified group; it is possible to add the same user into different groups.
909 1. Operating record: it records user operations information, the records files are saved in HMI flash; its path is [~\~\flash~\~\UserOperationLogs.db].
910 1. When it is on simulator mode, the files are saved in C disk, its path is [C:~\~\WECON\UserMgrFile\UserOperationLogs.db].
911
912 (% class="box infomessage" %)
913 (((
914 ✎**Note: **
915
916 * The user name and password must be unique. Username can be up to 32 characters, and password can be up to 8 characters.
917 * The multi language function of User permission only supported on HMI system version V2.0 or above
918 )))
919
920 == Settings ==
921
922 Open PIStudio software, then operate as the following figure.
923
924 (% style="text-align:center" %)
925 [[image:用户权限 1.png||class="img-thumbnail"]]
926
927 Click on the cell from UserName and Desc, which can support the multi language.
928
929 (% style="text-align:center" %)
930 [[image:UserPermissionMultilan.png]]
931
932 1. Click "User Permission" in "Data Tool" toolbar.
933 1. Edit user name, click "User0" cell under "UserName", and then enter the user name, one project allows maximum 20 users.
934 1. Edit password, click "User0" cell under "PassWord", and then enter the user name.
935 1. Edit description, click "User0" cell under "Desc", and then enter, description is not necessary。
936 1. Check the groups for each user, there are 11 groups beside admin.
937 1. Editing groups' description, but it is not necessary.
938 1. {{id name="OLE_LINK7"/}}{{id name="OLE_LINK6"/}}Click "Save and Exit" button to complete all settings.
939
940 (% class="box infomessage" %)
941 (((
942 ✎**Note:**
943
944 * Only a maximum of one administrator permission is allowed in a profile with one user permission. If you want to use "Funtion address" to modify the user permission, you must log in the administrator account to operate.
945 * When the configured file does not have the administrator account, a new user can be added  through "Funtion address" and set as the administrator.
946 * If you select hidden fucntion when configuring user account, the account would display as "~*~*~*~*~*~*" in the list. You only need to enter the password of the corresponding hidden user to log in.
947 * (((
948 Adding new UserName and Desc on the HMI by special addresses in the current language of the HMI, other languages will also configure the user names and user descriptions to the current language by default, i.e. switching to other languages, the new user names and user descriptions will not change with the language.
949 )))
950 )))
951
952 (((
953
954 )))
955
956 == Object permission configuration ==
957
958 (% style="text-align:center" %)
959 [[image:用户权限 2.png||class="img-thumbnail"]]
960
961 User operation logs support multi languages configuration. Click on the Log Message, the text editor of multi language will be pop up:
962
963 (% style="text-align:center" %)
964 [[image:LogMessagesMultilan.png]]
965
966 **Operation Procedure of Object Permission**
967
968 1. Open the object setting windows;
969 1. Select "Security" windows;
970 1. Check the "User Permission";
971 1. Select "Level" to set permission level;
972 1. Enter "Log Message", it is for operation records, if it was empty, the operation for this object would be not be recorded;
973 1. Select the "Access Denied Setting" mode;
974
975 **Log information description**
976
977 A combination of Chinese characters, numbers, and uppercase and lowercase letters can be entered, and the number does not exceed 63.
978
979 The format of insert variable:{variable address, data format}. e.g., {HDW100,UW2.1}.
980
981 The data format are as follows.
982
983 (% class="table-bordered" %)
984 |=Letter|=Meaning
985 |B|Binary
986 |O|Octonary
987 |U|Unsigned decimal
988 |H|Hexadecimal
989 |b|BCD
990 |F|32-bit float
991 |S|Signed decimal
992 |C|Character
993 |W|Single word
994 |D|Double word
995
996 Examples.
997
998 * Unsigned decimal, BCD, 32-bit float and Signed decimal are as follows.
999
1000 {HDW100,UW2.1}:  Indicates the variable address is HDW100. The data format are: unsigned decimal, single word, two integer bits, one decimal place.
1001
1002 * (((
1003 Binary, Octonary and Hexadecimal are as follows.
1004 )))
1005
1006 {HDW100,HD8}: Indicates the variable address is HDW100. The data format are: hexadecimal, double word, eight integer bits.
1007
1008 * (((
1009 Character is as follows.
1010 )))
1011
1012 {HDW100,C32}: Indicates the variable address is HDW100. The data format are: 32 characters.
1013
1014 When a record is generated, the contents of this variable are replaced by the value of your corresponding address.
1015
1016 == **Function address** ==
1017
1018 A user must first log in before performing an operation, and after the login is successful, the user can perform the required operation, and log out after completing the operation, making the operation permission invalid. User login, log out, modification of user password during operation and user management and other functions need to be configured.
1019
1020 HMI allows managing user accounts on screen. Including adding, deleting and editing the user account. HMI provide built-in screen for [Sign in] and [change password] (screen No. 1006 and 1007).
1021
1022 Functions and addresses are as follows.
1023
1024 (% class="table-bordered" %)
1025 |=**Function**|=**Address**|=**Object type**|=**Address function**
1026 |(% rowspan="3" %)Sign in|HUW1158~~1335|Drop down list|User name
1027 |HUW1002|Character input object|Password
1028 |HUW1000|Word Switch (Input 1)|OK (sign in)
1029 |(% rowspan="5" %)Change password|HUW1158~~1335|Drop down list|User name
1030 |HUW1002|Character input object|Old password
1031 |HUW1006|Character input object|New password
1032 |HUW1010|Character input object|Confirm password
1033 |HUW1000|Word Switch (Input 2)|OK(change password)
1034 |Sign out|HUW1000|Word Switch (Input 3) |Sign out
1035 |(% rowspan="7" %)(((
1036 New user ***1**
1037 )))|HUW1014|Character input object|User name
1038 |HUW1006|Character input object|password
1039 |HUW1010|Character input object|Confirm password
1040 |HUW1000|Word Switch (Input 4) |OK(add new user)
1041 |HUW1336~~1345|Character input object|User description
1042 |HUX1347.0|Bit switch|(((
1043 ~=1: User hidden
1044
1045 ~=0: Visible (Defaults)
1046 )))
1047 |HUW1000|Word Switch (Input 8) |Save(add Hide features)
1048 |(% rowspan="2" %)(((
1049 Delete user ***2**
1050 )))|HUW1158~~1335|Drop down list|User name
1051 |HUW1000|Word Switch (Input 5)|OK (delete user)
1052 |Delete Profile|HUW1000|Word Switch (Input 9)|OK(delete)
1053 |Export Profile|HUW1000|Word Switch (Input 10)|OK(export)
1054 |Import profile|HUW1000|Word Switch (Input 11)|OK(import)
1055 |Export log file|HUW1000|Word Switch (Input 12)|OK(export)
1056 |Delete log file|HUW1000|Word Switch (Input 13)|OK (delete)
1057 |Current user name|HUW1349|Character object|32 Word
1058 |System state information|HUW1030|Character input object|System state information
1059 |(% rowspan="3" %)Permission settings|HUW1014|Character input object|User name
1060 |HUW1348|Bit switch|(((
1061 Set the user group:
1062
1063 HUX1348.0 = 1 administrator;
1064
1065 HUX1348.1 = 1 group 0 permission;
1066
1067 HUX1348.2 = 1 group 1 permission;
1068
1069 (Total group 0 - group 10)
1070 )))
1071 |HUW1000|Word Switch (Input 6)|Add user rights (set according to HUW1348)
1072 |User login mode setting|HUW1382|Word Switch/Numeric input object|(((
1073 0: Select a user name from the drop-down list
1074
1075 1: Use character input object (address HUW1014) to log in with a user name
1076 )))
1077
1078 When the user performs a function operation, the operation result is displayed in the HUW1001.
1079
1080 (% class="table-bordered" %)
1081 |=**Value (HUW1001)**|=**Meaning**
1082 |1|Insufficient permissions.
1083 |2|Username does not exist.
1084 |3|Username already exists.
1085 |4|Wrong username or password.
1086 |5|Login successfully.
1087 |6|Passwords are inconsistent in twice time.
1088 |7|Password changed successfully.
1089 |8|User added successfully.
1090 |9|User deleted successfully.
1091 |10|Maximum number of users exceeded.
1092 |11|Admin user already exists.
1093 |12|User permission modified successfully.
1094 |13|File imported successfully.
1095 |14|File imported failed.
1096 |15|File exported successfully.
1097 |16|File exported failed.
1098 |17|Logout successfully.
1099 |18|Profile deleted successfully.
1100 |19|Log file deleted successfully.
1101 |20|Hide settings modified successfully.
1102 |21|Hide settings modified failed.
1103 |22|(((
1104 Password already occupied, please reset.
1105
1106 (For both username and password, it can not repetition)
1107 )))
1108
1109 (% class="box infomessage" %)
1110 (((
1111 **✎Note:**
1112
1113 * *1: If there is an admin user account, then the new user can no longer add one more admin, that is, one project can only have one administrator account.
1114 * *1: When adding new user, the password could not be duplicated with other users.
1115 * *2: When deleting user, it is forbidden to delete the admin user.
1116 )))
1117
1118 **User Permission Demo Download**
1119
1120 [[https:~~/~~/drive.google.com/open?id=1qOiEDvo_1H1YqpoLDpS77dGaAFm8nrGq>>url:https://drive.google.com/open?id=1qOiEDvo_1H1YqpoLDpS77dGaAFm8nrGq]]
1121
1122 = Message prompt =
1123
1124 A message box is a window used to show some prompts or warnings to users. For example, the application process a task in the process of pop-up message box, suggesting that "U disk has been detected", then the customer can carry out data dump function.
1125
1126 (% style="text-align:center" %)
1127 [[image:消息提示 2.png||class="img-thumbnail"]]
1128
1129 (% style="text-align:center" %)
1130 [[image:8.Basic Function_html_5ce2091d6f7cd732.png||height="515" width="704" class="img-thumbnail"]]
1131
1132 **(1) Message**
1133
1134 It includes system classes (u disk, SD card, and others), chart classes (alarm, data record, recipe, file list), curve classes (Trend Chart, historical XY trend Plot).
1135
1136 **(2) Control**
1137
1138 1. **Current item: **It shows selected message information.
1139 1. **Use trigger address: **When the message is triggered, the trigger address would be set ON.
1140
1141 **For Example:**
1142
1143 Trigger address is 011, during inserting a USB flash disk into HMI, and 011 would be set ON, once HMI recognizes USB flash disk, and display message.
1144
1145 1. **Show message: **Check it to display message when HMI is running. It is checked by default.
1146 1. **Show on web: **Check it to display message when remote access HMI screen, it is unchecked by default.
1147
1148 **(3) Message Content**
1149
1150 Each message has default content, but you could set different content according to the actual situation. And the same message could be displayed in 8 languages.
1151
1152 **(4) Reload Text: **It means discard changes.
1153
1154 **For Example**
1155
1156 User deletes default content or modifies default content, but he wants to give up modification back to original, just click "Reload text".
1157
1158 (% class="box infomessage" %)
1159 (((
1160 **✎Note:**
1161
1162 * If you do not want this prompt during the running of HMI, please uncheck "Show message".
1163 * "Reload text" function would be invalid after clicking "save".
1164 * These 5 special characters are not supported in the header Multi language settings: ",", "|", "<", ">", "&".
1165 )))
1166
1167 == **Appendix** ==
1168
1169 The following pop-up message and code only available for HMI System V1.0, to indicate some system errors:
1170
1171 |=**Message code**|=**Description**|=
1172 |=10001|Failed to delete folder directory|(% rowspan="3" %)First confirm whether the U disk SD card is read-only, or if there are other abnormalities, if it cannot handle by prevouis advises, please provide the back label and background version info.
1173 |=10002|Failed to renaming file
1174 |=10003|Failed to delete file
1175 |=10004|Inconsistent data record tables|The files in the U disk SD card may be from other projects, or the same project but the number of channels in the current project is inconsistent with the record. Please consider verifying it first.
1176 |=10009|(% rowspan="4" %)
1177 LAN monitoring error|(% rowspan="4" %)Data packet loss during the monitoring process may cause this problem. Confirm the software version. The company has updated this issue. Older versions can be updated
1178 |=10010
1179 |=10011
1180 |=10012
1181 |=10015|Failed to initialize project|It is recommended to send the project back to the company for testing
1182 |=10022|U Disk Safe Exit Failed|(% rowspan="5" %)It may be in use, data is exported, or the storage location is U disk or SD card. It is best to trigger again and wait for its successful exit.
1183 |=10023|SD card safe exit failed
1184 |=10024|U disk is busy
1185 |=10025|SD card is busy
1186 |=10026|Cannot recognize the U disk/SD card
1187 |=10027|U disk/SD card cannot be read or written|(% rowspan="3" %)Detect the format of U disk/SD card. Fat32 and ntfs can be recognized normally. If the computer can use it normally and the HMI cannot recognize it, you can only consider formatting the U disk first and then try again.
1188 |=10028|U disk/SD card unknown error
1189 |=10029|U disk/SD card format error
1190 |=11000|(% rowspan="2" %)Alarm record error|(% rowspan="29" %)(((
1191 The version before Sept. 19th considers the flash problem. Please provide the back label and the backstage version info . Make sure to ask the customer to update the version first, and the customer's similar projects must be updated even if there is no problem. After the update, the flash usage should be checked and. If the flash is on a severe status, return to the company replaces the flash with a new one.
1192
1193 When the question is returned, the text behind the prompt is as complete as possible, which can help R&D to confirm the problem faster.
1194 )))
1195 |=11001
1196 |=11002|Failed to delete Alarm record in Flash
1197 |=11006|Failed to save the Alarm records to Flash
1198 |=11007|Alarm record error
1199 |=11009|(% rowspan="2" %)Data record error
1200 |=11010
1201 |=11011|Failed to save Data records to Flash
1202 |=11012|Failed to delete Data record in Flash
1203 |=11013|Data record error
1204 |=11014|Failed to transfer Data record to U disk/SD card
1205 |=11015|Failed to copy Data record to U disk/SD card
1206 |=11016|Data record error
1207 |=11017|User permission related operation error
1208 |=11018|SQL trigger monitoring error
1209 |=11019|Data record error
1210 |=11020|Historical XY graph error
1211 |=11021|Failed to save the Historical XY graph to Flash
1212 |=11022|Failed to delete the Historical XY graph in Flash
1213 |=11023|(% rowspan="5" %)
1214 \\Installment payment error
1215 |=11024
1216 |=11025
1217 |=11026
1218 |=11027
1219 |=11028|(% rowspan="3" %)
1220 Real-time trend graph error
1221 |=11029
1222 |=11030
1223 |=11031|Failed to delete the Real-time trend graph data in the memory
1224 |=11032|Failed to save the Real-time trend graph to Flash
1225 |=11033|(% rowspan="13" %)Recipe error|(% rowspan="13" %)If it is a new project download and there is an error, first confirm the settings of the recipe, if it is abnormal after a period of use, confirm whether it is the flash problem
1226 |=11034
1227 |=11035
1228 |=11036
1229 |=11037
1230 |=11038
1231 |=11039
1232 |=11040
1233 |=11041
1234 |=11042
1235 |=11043
1236 |=11044
1237 |=11045
1238 |=11046|(% rowspan="3" %)User permission related operation error|(% rowspan="3" %)If an error occurs when downloading a new project, first confirm the permission configuration, whether the reserved configuration is checked in the download tool, etc., if it is abnormal after a period of use, confirm whether it is a flash problem
1239 |=11047
1240 |=11048
1241 |=11049|Failed to upload operation log file via Ethernet|
1242 |=11050|(% rowspan="8" %)User permission related operation error|(% rowspan="6" %)If an error occurs when downloading a new project, first confirm the permission configuration, whether the reserved configuration is checked in the download tool, etc., if it is abnormal after a period of use, confirm whether it is a flash problem
1243 |=11051
1244 |=11052
1245 |=11053
1246 |=11054
1247 |=11055
1248 |=11056|(% rowspan="2" %)
1249 |=11057
1250 |=11058|Alarm record error|(% rowspan="2" %)Same as flash problem
1251 |=11062|Installment payment error
1252 |=11063|Alarm Runbar error|Mostly, the Runbar is used without config the alarm settings.
1253 |=11069|(% rowspan="3" %)Historical trend graph error|Same as flash problem
1254 |=11070|
1255 |=11071|
1256 |=11072|SQL trigger monitoring error|
1257 |=11073|Real-time trend graph error|Same as flash problem
1258 |=11075|Error getting database table file|Same as flash problem
1259 |=11076|Error getting database table file|Same as flash problem
1260 |=11077|(% rowspan="3" %)Recipe error|(% rowspan="3" %)If it is a new project download and there is an error, first confirm the settings of the recipe, if it is abnormal after a period of use, confirm whether it is the flash problem
1261 |=11078
1262 |=11079
1263 |=11080|(% rowspan="2" %)User permission related operation error|(% rowspan="2" %)Same as 11046
1264 |=11081
1265 |=11082|Drop-down list error|
1266 |=11083|The message prompt error|
1267 |=11084|(% rowspan="2" %)Alarm record error|Same as flash problem
1268 |=11085|
1269 |=11086|(% rowspan="2" %)Data record error|Same as flash problem
1270 |=11087|
1271 |=11088|(% rowspan="2" %)Alarm record error|Same as flash problem
1272 |=11089|
1273 |=11090|Installment payment error|Same as flash problem
1274 |=11091|The message prompt error|
1275 |=11092|The database table file does not exist|
1276 |=11093|Machine code error|
1277 |=11094|Import csv file error|
1278 |=30001|Flash free space is not enough to store Data records|(% rowspan="3" %)Insufficient space, whether any file is copied into the flash
1279 |=30002|Flash free space is not enough, Historical XY trend graph is not stored
1280 |=30003|Flash free space is not enough to store real-time trend graphs
1281 |=30005|System read only|(% rowspan="2" %)Same as the flash problem, if the flash is damaged, then the system must be updated
1282 |=30006|Insufficient reserved blocks
1283
1284 = **Cloud** =
1285
1286 **Introduction**
1287
1288 You may configure the basic settings of Cloud functions, tags, and User MQTT according to your needs. (If the device supports the Cloud function, you can use the function and configure the tags after checking the box to enable it, or upload the data to the 3rd party server.)
1289
1290 Click "Project"-"[[image:hh_B4H5OuNT87.png||height="29" width="30"]]Cloud" in the upper left corner of the software, as shown in the following figure.
1291
1292 (% style="text-align:center" %)
1293 [[image:云配置1.png||height="494" width="750" class="img-thumbnail"]]
1294
1295 **(1) Enable**
1296
1297 If the HMI supports the Cloud function, check it to enable the Cloud function, and it will collect the real-time data from HMI upload to the Cloud. The number of data collection is limited, and the specific parameters are as follows:
1298
1299 |=Series|=Monitoring Tags|=Alarm Record|=Data Record|=OpenCloud Data
1300 |8000-R (HMI V2.0 System)|300|200|100|1000
1301 |9000-R (HMI V2.0 System)|300|200|100|1000
1302 |3000ig|100|20|50|500
1303 |8000ig|300|200|100|1000
1304 |MD|100|20|50|500
1305
1306 For example:
1307
1308 * In 3000ig's Cloud, the monitoring tags upload to the Cloud in real time is limited to 100.
1309 * For 3000ig's Alarm, the Alarm records of word alarms and bit alarms upload to Cloud is limited to 20. (See [["Alarm">>http://docs.we-con.com.cn/wiki/pistudio/view/Helps/08.Basic%20Function/#HAlarm]] for details).
1310 * For 3000ig's Data record, the Data records upload to Cloud is limited to 50. (For details, please refer to [["Data Record">>http://docs.we-con.com.cn/wiki/pistudio/view/Helps/08.Basic%20Function/#HDataRecord]]).
1311
1312 **(2) Server Selection**
1313
1314 **Server**: China, ASEAN, and Europe.
1315
1316 **Password**:
1317
1318 1. If the HMI is not bound, this access password will be updated and downloaded into the HMI screen simultaneously.
1319 1. If the HMI is bound, this access password in the project cannot effectively change the binding password of the device, and it can only be changed through V-NET.
1320
1321 **(3) Upload Selection**: 
1322
1323 To upload the data collected by HMI to the cloud or a to the third-party server, only one upload method can be selected.
1324
1325 1. **to Cloud**: All the configured tags, data records, and alarm records would be pushed to V-NET.
1326 1. **to User MQTT**: All the configured tags, data records, and alarm records would be pushed to to the third-party server, and the relevant Lua function calls please refer to "[[Cloud interface>>http://docs.we-con.com.cn/wiki/pistudio/view/Helps/10.Lua/#HCloudInterface]]".
1327
1328 After the "to User MQTT" is checked. The tags, data records, and alarms cannot be viewed on V-NET, but the device can be bound to V-NET and remote monitoring the device screen normally.
1329
1330 **4) Low Data Mode setting**
1331
1332 1. When you check the "low Data Mod" by default on new tags, the newly added tags will be enabled in Low Data Mode by default.
1333 1. The longer the refresh interval, the slower the data upload, and the more traffic data will be saved. This function is only used for the control of tags.
1334
1335 = MQTT[[image:2.png]] =
1336
1337 (% class="wikigeneratedid" %)
1338 Configurable type MQTT. Users can publish message to the MQTT server or subscribe topics from the MQTT server.
1339
1340 The supported models and series are listed in the following table:
1341
1342 (% style="margin-left:auto; margin-right:auto; width:150px" %)
1343 |Support series
1344 |3000ig
1345 |8000ig
1346
1347
1348
1349 **MQTT Configuration (Common Settings/AWS IOT Settings/ALi Settings/Huawei Settings)**
1350
1351 This chapter explains how to use configurable type MQTT. Users can publish message to the MQTT server or subscribe topics from the MQTT server.
1352
1353 Click “MQTT” in “Data Tool" in the upper side bar of the software.After checking "Enable", the settings window will pop up and select different cloud services for MQTT configuration, as shown in the following figure:
1354
1355 (% style="text-align:center" %)
1356 [[image:1747021182728-276.png]]
1357
1358 **MQTT Server Settings (Common)**
1359
1360 **General**
1361
1362 (% style="text-align:center" %)
1363 [[image:3.jpg]]
1364
1365 **Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.
1366
1367 **Cloud Service**: (Select Common)
1368
1369 ① Common (Common Platform): General MQTT publish-subscribe topic mode.
1370
1371 ② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.
1372
1373 ③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.
1374
1375 ④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.
1376
1377 **Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.
1378
1379 **Custom Client ID length:** User can customize the length of the Client ID (optional), length range: 20 ~~128.
1380
1381 **Custom username/password length:** Customize the length of user name/password length (optional), length range: 16 ~~ 256.
1382
1383 **IP:** Set the MQTT server IP to subscribe message.
1384
1385 **Use domain name:** Support using domain name to the specify server.
1386
1387 **Domain name:** Set the domain name of the MQTT server that subscribe message. Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", “.”. The symbol cannot be placed at the first character or last character of name.
1388
1389 **Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.
1390
1391 **Client ID:** Login name. Variables can be used as login names. For example: Enter% 0 and the Client ID is the device name. (This can be set in the HMI background. If not, the default is HMI model.) **(✎Note: A Client ID can only be used for one device.)** When there is no custom Client ID length, the maximum configurable length of Client ID is 40 characters.
1392
1393 **Verification:** Choose whether to connect to the MQTT server using [User Name] and [Password].
1394
1395 **User Name:** The [User Name] connects to the MQTT server. When there is no custom username/password length, the maximum configurable length of username is 32 characters.
1396
1397 **Password:** The password for connect to the MQTT server. When there is no custom username/password length, the maximum configurable length of password is 32 characters.
1398
1399 **Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.
1400
1401 **Clean message cache when normal connected:** If option is enabled, when the device is disconnected, the message to be published will be cached in the cache area, and then will be published when the device is online again.
1402
1403
1404 **Address**
1405
1406 (% style="text-align:center" %)
1407 [[image:4.jpg]]
1408
1409 **Status address: (Total length: 2 words)**
1410
1411 HDWn: Display [MQTT] connection status.
1412
1413 |Value|Description
1414 |0|Disable MQTT server connection
1415 |1|Disconnected or connecting
1416 |2|Successfully connected the MQTT server
1417
1418 HDWn+1: Error prompt
1419
1420 |Value|Description
1421 |0|No error
1422 |-1|General error code of wrong operation
1423 |-3|Disconnected
1424 |-4|Exceed client data concurrency
1425 |-5|Invalid UTF-8 string
1426 |-6|Null pointer parameter
1427 |-7|Topic name is truncated
1428 |-8|Wrong protocol structure body
1429 |-9|Bad QoS, acceptable range is (0, 1, 2)
1430 |-10|Try to use a non-SSL version library for SSL connection
1431 |-11|Wrong MQTT version
1432 |-14|Wrong protocol type
1433 |-15|Option is not suitable for the current request version
1434 |-16|Call MQTT version that is not applicable to request.
1435 |-17|0 length connects topics
1436
1437 **Buffer usage address: (Total length: 1 word)**
1438
1439 Unsuccessful published message will be stored in memory as cache, with a maximum 100,000 messages or 2M. Value display as unit %, and it is carried unconditionally.
1440
1441 HDWn: Display buffer usage.
1442
1443 **Control address: (Total length: 123 words; If the domain name is not enabled, it will take up 59 words)**
1444
1445 HDWn: Control the execution or stop of [MQTT Server].
1446
1447 |Value|Description
1448 |0|Ready
1449 |1|Start
1450 |2|Stop
1451 |3|Update
1452
1453 HDWn+1: IP address of the MQTT server. (✎**Note: This address is only valid when IP is used.**)
1454
1455 HDWn+5: Port number of the MQTT server.
1456
1457 HDWn+6: Client ID of the MQTT server connection.
1458
1459 HDWn+26: Authentication is enabled or not. = 0, disabled; = 1, enabled.
1460
1461 HDWn+27: User name of MQTT server connection.
1462
1463 HDWn+43: Password of MQTT server connection.
1464
1465 HDWn+59: Domain name of the MQTT server. (**✎Note: This address is only valid if the domain name is used.**)
1466
1467
1468 **TLS/SSL Settings**
1469
1470 (% style="text-align:center" %)
1471 [[image:5.jpg]]
1472
1473 **Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.
1474
1475 **Server authentication:**
1476
1477 Enable: Verify whether the server certificate has been certified by a Certificate Authority Certificate (CA). Server certificates are sent by the server when connection is established.
1478
1479 Import: Select CA certificate to import.
1480
1481 More: After the import is successful, clicking it will display the certificate details.
1482
1483 Reset: Reset the import information.
1484
1485 The server name must match the certificate information: Verify whether the server name or IP matches with the information in the certificate. Domain name and IP are recorded in the Subject Alternative Name from certificate.
1486
1487 **Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.
1488
1489 Certificate:
1490
1491 Import: Select certificate to import.
1492
1493 More: After the import is successful, clicking it will display the certificate details.
1494
1495 Reset: Reset the import information.
1496
1497 Key:
1498
1499 Import: Select the key to import.
1500
1501 More: After the import is successful, clicking it will display key details.
1502
1503 Reset: Reset the import information.
1504
1505
1506 **System topics**
1507
1508 (% style="text-align:center" %)
1509 [[image:6.jpg]]
1510
1511 **Birth Topic: **The message that HMI will publish when it is connected to server.
1512
1513 **Close Topic:** The last send message before HMI actively disconnects from server connection
1514
1515 **Last Will: **Subscription of Last Will receive this message when an abnormal disconnection occurs between HMI and the server. HMI synchronizes the Last Will message to the server when it initially establishes the connection.
1516
1517 **Topic List:** A list of topics in the HMI that is sent to the server after the HMI is connected to the server.
1518
1519 **Topic:** The actual topic name of the system topic. Maximum input length: 255 characters, cannot be empty.
1520
1521 **Retain message: **The MQTT server keeps the latest message.
1522
1523 **QoS: **MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
1524
1525 QoS 0: Messages are sent only once, and delivery is not guaranteed.
1526
1527 QoS 1: Message must be delivered at least once.
1528
1529 QoS 2: Message is delivered just once.
1530
1531 **Content format:**
1532
1533 **JSON (Default):** Use default values, default values for each system topic (**The bold is represented as the current actual value**)
1534
1535 **Birth Topic:** 
1536 {
1537 "d": {
1538 "connected": true
1539 },
1540 "ts": " **Current time**"
1541 }**Close Topic: **
1542 {
1543 "d": {
1544 "connected": false
1545 },
1546 "ts": " **Current time**"
1547 }**Last Will: **
1548 {
1549 "d": {
1550 "connected": false
1551 }
1552 }**Topic list:** 
1553 {
1554 "d": {
1555 "topics": [
1556 {
1557 "compression": "
1558
1559
1560 ",
1561
1562 "nickname": "**Subject name**",
1563
1564 "topic": "**Theme**"
1565 },
1566 {
1567 "compression": "**Compression type**",
1568
1569 "nickname": "**Subject nam**e",
1570
1571 "topic": "**Theme**"
1572 }
1573 ]
1574 },
1575 "ts": "**Current time**"
1576 }
1577
1578 Messages within topics vary depending on the actual topic settings. The above is an example of two topics.
1579
1580 **JSON (Customized):** Use custom content.
1581
1582 **Choose the connection network card**
1583
1584 (% style="text-align:center" %)
1585 [[image:7.jpg]]
1586
1587 **Default:** According to the priority order of network adapters set in the HMI background to connect server.
1588
1589 **Ethernet 1: **Specify Ethernet 1 network card to connect to the server. When the system does not find Ethernet 1, connect to the server by “Default”. When system finds Ethernet 1 and binds it to connect to the server.
1590
1591 **Ethernet 2: **Specify Ethernet 2 network card to connect to the server. When the system does not find Ethernet 2, connect to the server by “Default”. When system finds Ethernet 2 and binds it to connect to the server.
1592
1593 **4G:** Specify 4G network card to connect to server. When the system does not find 4G, connect to the server by “Default”. When system finds 4G and binds it to connect to the server.
1594
1595 **Wi-Fi:** Specify Wi-Fi network card to connect to server. When the system does not find Wi-Fi, connect to the server by “Default”. When the system finds Wi-Fi and bind it to connect to the server.
1596
1597
1598 **MQTT Topic**
1599
1600 **MQTT topic publish**
1601
1602 Select [Topic publish], click [Add], enter [Add MQTT topic publish object], and set the general settings and address. The maximum number of MQTT published topics is 255.
1603
1604 (% style="text-align:center" %)
1605 [[image:8.jpg]]
1606
1607 **General properties**
1608
1609 (% style="text-align:center" %)
1610 [[image:9.jpg]]
1611
1612 **Alias:** Set the project name of the MQTT topic. Maximum input length: 255 characters, cannot be empty.
1613
1614 **Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.
1615
1616 Sending mode: (AUTO/TRIGGER)
1617
1618 **① AUTO **value change mode: When any value changes, MQTT message is published.
1619
1620 a. Minimum time interval between messages: The minimum time interval can be set between messages to avoid over-publishing MQTT messages. When the interval of value change is less than the minimum time interval between messages, the message will be put in the cache. The MQTT message will not be published until the minimum interval between messages is met. Range: 0~~3600000ms.
1621
1622 b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing. The range is 1~~3600s.
1623
1624 **② TRIGGER**
1625
1626 When the specified bit is triggered, the MQTT message is published. When HDX0.0 changes from OFF to ON, an MQTT message is published, and HDX0.0 is automatically set to OFF after publishing.
1627
1628 **Compression type:** Message is compressed before it is transmitted. The compressed message needs to be decompressed before the MQTT client reads it. Zilb, Gzip, or Deflate algorithm can be chosen to compress or decompress the message.
1629
1630 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
1631
1632 0: Messages are sent only once, and delivery is not guaranteed.
1633
1634 1: Message must be delivered at least once.
1635
1636 2: Message is delivered just once.
1637
1638 **Retain message: **When checked, the MQTT server keeps the latest message.
1639
1640 **Content format:**
1641
1642 Raw data: Data composed of BYTE data.
1643
1644 JSON (General): Put all data in JSON format of member "d".
1645
1646 JSON (Advanced): JSON format of flexibly customizable nested structure.
1647
1648 **Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.
1649
1650 **Use the top "d" symbol in the message format:**
1651
1652 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
1653
1654 {
1655
1656 "d": {
1657
1658 "addressName1": ...,
1659
1660 "addressName2":...
1661
1662 },
1663
1664 "ts":...
1665
1666 }
1667
1668 When unchecked, the message format is as follows:
1669
1670 {
1671
1672 "addressName1": ...,
1673
1674 "addressName2":...,
1675
1676 "ts":...
1677
1678 }
1679
1680 As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.
1681
1682 **Address setting**
1683
1684 ①Address settings when content formats use [Raw Data] and [JSON (General)].
1685
1686 (% style="text-align:center" %)
1687 [[image:10.jpg]]
1688
1689 **Add:** Establish the address source of the topic. The length of each address can be set separately.
1690
1691 **Delete:** Delete the address.
1692
1693 **Settings:** Modify the address and name.
1694
1695 (% style="text-align:center" %)
1696 [[image:11.jpg]]
1697
1698 **Included in all message sent**
1699
1700 Check the options: This topic will include this address every time it publishes a message.
1701
1702 Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.
1703
1704 **Remove JSON array brackets' ['and'] ':**
1705
1706 Check the options: Remove the array symbol name when using non-array bits or characters.
1707
1708 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
1709
1710 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
1711
1712 (% style="text-align:center" %)
1713 [[image:12.jpg]]
1714
1715 The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.
1716
1717 {
1718 "object": {
1719 "value": "teststring",
1720 "value (1)": 123,
1721 "value (2)": true,
1722 "value (3)": "",
1723 "value (4)": 0,
1724 "value (5)": true
1725 },
1726 "array": [
1727 10,
1728 20,
1729 30
1730 ],
1731 "value (6)": " 2023-04-27T03: 53: 20.156271 "
1732 }
1733
1734 **New component:** Add a new data component. Components can have multiple data formats; each data format has its own Name and Value. The data of the component is included in braces {}.
1735
1736 **New value:** Add a new value, string, or timestamp. When it is a value or a string, it can be fixed value or read data from a specified address.
1737
1738 **Delete:** Delete the selected field.
1739
1740 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
1741
1742 **Template:** Paste the JSON text here, and the system will automatically arrange the style to conform to this JSON format, saving the time of self-definition.
1743
1744 **Preview:** Preview JSON data in an easy-to-read format.
1745
1746 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
1747
1748 **Security settings**
1749
1750 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
1751
1752 (% style="text-align:center" %)
1753 [[image:13.jpg]]
1754
1755 **MQTT topic subscription**
1756
1757 Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.
1758
1759 (% style="text-align:center" %)
1760 [[image:14.jpg]]
1761
1762 **General properties**
1763
1764 (% style="text-align:center" %)
1765 [[image:15.jpg]]
1766
1767 **Alias:** Set the project name of the MQTT topic. Maximum input length: 255 characters, cannot be empty.
1768
1769 **Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.
1770
1771 **Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.
1772
1773 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
1774
1775 0: Messages are sent only once, and delivery is not guaranteed.
1776
1777 1: Message must be delivered at least once.
1778
1779 2: Message is delivered just once.
1780
1781 **Content format:**
1782
1783 Raw data: There is no original data in a specific format.
1784
1785 JSON (General): JSON format of single-layer structure.
1786
1787 JSON (Advanced): JSON format of flexibly customizable nested structure.
1788
1789 **Verify timestamp:** The user can decide whether to verify the timestamp or not. When checked, it indicates that the received data timestamp must be strictly incremented before it can be updated. Otherwise, it will be judged as outdated data and not updated.
1790
1791 **Use the top "d" symbol in the message format:**
1792
1793 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
1794
1795 {
1796
1797 "d": {
1798
1799 "addressName1": ...,
1800
1801 "addressName2":...
1802
1803 },
1804
1805 "ts":...
1806
1807 }
1808
1809 When unchecked, the message format is as follows:
1810
1811 {
1812
1813 "addressName1": ..., "addressName2":...,
1814
1815 "ts":...
1816
1817 }
1818
1819 Please select the appropriate settings according to the data source.
1820
1821 **Address settings**
1822
1823 ①Address settings when content formats use [Raw Data] and [JSON (General)].
1824
1825 (% style="text-align:center" %)
1826 [[image:16.jpg]]
1827
1828 **Add:** Establish the address where the data is stored after the topic is subscribed, and the length of each address can be set separately.
1829
1830 **Delete:** Delete the address.
1831
1832 **Settings:** Modify the address and name.
1833
1834 (% style="text-align:center" %)
1835 [[image:17.jpg]]
1836
1837 **Remove JSON array brackets' ['and'] ':**
1838
1839 When using non-array bits or characters, array symbol can manually be removed.
1840
1841 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
1842
1843 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
1844
1845 (% style="text-align:center" %)
1846 [[image:18.jpg]]
1847
1848 **New component:** Add a new data component. There can be multiple data formats in a component, each with a name and a value. The data of the component is included in braces {}.
1849
1850 **New Array:** Add a new data array. Arrays can have multiple data formats, but only one name. The data of the component is included in brackets [].
1851
1852 **New value:** Add a new value, string, or timestamp. When it is a value or a string, it can be fixed value or read data from a specified address.
1853
1854 **Delete:** Delete the selected field.
1855
1856 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
1857
1858 **Template:** Paste the JSON text here, and the system will automatically arrange the style to conform to this JSON format, saving the time of self-definition.
1859
1860 **Preview:** Preview JSON data in an easy-to-read format.
1861
1862 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
1863
1864 **(3) Security settings**
1865
1866 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
1867
1868 (% style="text-align:center" %)
1869 [[image:19.jpg]]
1870
1871 **MQTT Server Settings (AWS IOT)**
1872
1873 **General**
1874
1875 (% style="text-align:center" %)
1876 [[image:20.jpg]]
1877
1878 **Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.
1879
1880 **Cloud service description**: (Select AWS IOT)
1881
1882 ① Common (Common Platform): General MQTT publish-subscribe topic mode.
1883
1884 ② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.
1885
1886 ③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.
1887
1888 ④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.
1889
1890 **Communication protocol**: MQTT v3.1.1 is supported.
1891
1892 **Domain name:** Set the domain name of the MQTT server that receives message. (Obtained from the AWS IOT platform) Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", “.”. The symbol cannot be placed at the first character or last character of name.
1893
1894 **Port number:** Set the MQTT server port to receive message. Range: 0~~65535, cannot be empty. (AWS IOT platform is generally 8883).
1895
1896 **Client ID:** Login name. Variables can be used as login names. For example: Enter %0 and the Client ID is the device name (This can be set in the HMI background. If not, the default is HMI model). **(✎Note: A Client ID can only be used on one device.)** The maximum configurable length is 40 characters.
1897
1898 **Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.
1899
1900
1901 **Address**
1902
1903 (% style="text-align:center" %)
1904 [[image:21.jpg]]
1905
1906 **Status address: (Total length: 2 words)**
1907
1908 HDWn: Display [MQTT] connection status.
1909
1910 |Value|Description
1911 |0|Disable MQTT server connection
1912 |1|Disconnected or connecting
1913 |2|Successfully connected the MQTT server
1914
1915 HDWn+1: Error prompt
1916
1917 |Value|Description
1918 |0|No error
1919 |-1|General error code of wrong operation
1920 |-3|Disconnected
1921 |-4|Exceed client data concurrency
1922 |-5|Invalid UTF-8 string
1923 |-6|Null pointer parameter
1924 |-7|Topic name is truncated
1925 |-8|Wrong protocol structure body
1926 |-9|Wrong QOS.  (0, 1, 2) is acceptable.
1927 |-10|Attempt to use a non-SSL library for SSL connection
1928 |-11|Wrong MQTT version
1929 |-14|Wrong protocol type
1930 |-15|Option is not suitable for the current request version
1931 |-16|Call MQTT version that is not applicable to request.
1932 |-17|0 length topic connection
1933
1934 **Buffer usage address:** Not available.
1935
1936 **Control address: (Total length: 90 words)**
1937
1938 HDWn: Control the execution or stop of [MQTT Server].
1939
1940 |Value|Description
1941 |0|Ready
1942 |1|Start
1943 |2|Stop
1944 |3|Update
1945
1946 HDWn+1: Reserved for use.
1947
1948 HDWn+5: Port number of the AWS IOT connection.
1949
1950 HDWn+6: Client ID of the AWS IOT connection.
1951
1952 HDWn+26: Domain name of the AWS IOT connection. 
1953
1954 **TLS/SSL Settings**
1955
1956 (% style="text-align:center" %)
1957 [[image:22.jpg]]
1958
1959 **Enable:**
1960
1961 Enabled by default. The default is TLS V1.2.
1962
1963 **Server authentication:**
1964
1965 Enabled by default: Verify whether the server certificate has been certified by a Certificate Authority Certificate (CA). Server certificates are sent by the server when connection is established.
1966
1967 Import: Select CA certificate to import.
1968
1969 More: After the import is successful, clicking it will display the certificate details.
1970
1971 Reset: Reset the import information.
1972
1973 The server name must be matched with the certificate information to verify whether the server name or IP matches the records in the certificate. Domain name and IP are recorded in the Subject Alternative Name in the certificate.
1974
1975 **(3) Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.
1976
1977 Certificate:
1978
1979 Import: Select certificate to import.
1980
1981 More: After the import is successful, clicking it will display the certificate details.
1982
1983 Reset: Reset the import information.
1984
1985 Key:
1986
1987 Import: Select the key to import.
1988
1989 More: After the import is successful, clicking it will display key details.
1990
1991 Reset: Reset the import information.
1992
1993
1994 **Device setting**
1995
1996 Select [Add] to enter [General property settings and address settings]. To delete a device, select the device and click Delete.
1997
1998 (% style="text-align:center" %)
1999 [[image:23.jpg]]
2000
2001 **General**
2002
2003 (% style="text-align:center" %)
2004 [[image:24.jpg]]
2005
2006 **Device name:** It is consistent with the item name on AWS IOT. Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", "_".
2007
2008 **Description:** For distinguish purpose. Maximum input length: 255 characters.
2009
2010 **Minimum time interval between messages:** The minimum time interval can be set between messages to avoid over-publishing MQTT messages. That is, when the interval of value change is less than the minimum time interval between messages, the message will be put in the cache, and the MQTT message will not be released until the minimum time interval between messages is met. Range: 0~~3600000ms.
2011
2012 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
2013
2014 0: Messages are sent only once, and delivery is not guaranteed.
2015
2016 1: Message must be delivered at least once.
2017
2018 2: Message is delivered just once.
2019
2020 **Content format:** Not configurable. All data is in JSON format.
2021
2022 **Include timestamps:** Whether to include the timestamp can be decided manually.
2023
2024 **Use the top "d" symbol in the message format:**
2025
2026 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
2027
2028 {
2029
2030 "d": {
2031
2032 "addressName1": ...,
2033
2034 "addressName2":...
2035
2036 },
2037
2038 "ts":...
2039
2040 }
2041
2042 When unchecked, the message format is as follows:
2043
2044 {
2045
2046 "addressName1": ...,
2047
2048 "addressName2":...,
2049
2050 "ts":...
2051
2052 }
2053
2054 As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.
2055
2056 **Address**
2057
2058 (% style="text-align:center" %)
2059 [[image:25.jpg]]
2060
2061 **Add:** Establish the address source of the topic. The length of each address can be set separately.
2062
2063 **Delete:** Delete the address.
2064
2065 **Settings:** Modify the address and name.
2066
2067 (% style="text-align:center" %)
2068 [[image:26.jpg]]
2069
2070 **Advanced Mode:**
2071
2072 Check the options: Check to configure four “Settings/Status".
2073
2074 Uncheck the options: Check to configure two "Settings/Status".
2075
2076 **Name:** Correspond to the key value in JSON.
2077
2078 **Type:** “Bit" and “Word” are optional. “Word” configuration can choose system of numeration.
2079
2080 **Length:**
2081
2082 Length 1: General JSON format.
2083
2084 Length > 1: Enable the format of JSON array. The values of continuous address with the configuration address as the first address as the elements of the array. This length is valid to the selected "settings/status”. (For example, the length is set to 3, and 4 "settings/states" are checked, so the length of these 4 are all 3). Range: 1-255.
2085
2086 For example, configure as the following figure:
2087
2088 (% style="text-align:center" %)
2089 [[image:27.jpg]]
2090
2091 Then HDW0, HDW2 and HDW4 will be read and published to the reported key; HDW10, HDW12, HDW14 will be read and published to the desired key. For example, if HDW0=1, HDW2=2, HDW4=3, HDW10=4, HDW12=5, and HDW14=6, the subscribed message format is as follows.
2092
2093 {
2094
2095 "state": {
2096
2097 "desired": {
2098
2099 "welcome": [1, 2, 3]
2100
2101 },
2102
2103 "reported": {
2104
2105 "welcome": [4, 5, 6]
2106
2107 }
2108
2109 }
2110
2111 }
2112
2113 **Status (Device address~-~->AWS IOT "reported"):** Pass a value from the Device address to the AWS IOT “reported” in one direction, which is equivalent to publishing to "reported".
2114
2115 **Setting (Device address->AWS IOT "desired"):** Pass a value from the Device address to the AWS IOT “desired” in one direction, which is equivalent to publishing to “desired".
2116
2117 **Status (AWS IOT "reported"->Device address):** Pass a value from AWS IOT "reported" to Device address in one direction, which is equivalent to subscribing to "reported".
2118
2119 **Settings (AWS IOT "desired"->Device address):** Pass a value from the AWS IOT "desired" to the Device address in one direction, which is equivalent to subscribing to "desired".
2120
2121 **Remove JSON array brackets' ['and'] ':** Check to remove array symbols when using non-array bits or characters. (Configurable when length is 1).
2122
2123 **MQTT Server Settings (ALi)**
2124
2125 **General**
2126
2127 (% style="text-align:center" %)
2128 [[image:28.jpg]]
2129
2130 **Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.
2131
2132 **Cloud service description**: (Select Ali)
2133
2134 ① Common (Common Platform): General MQTT publish-subscribe topic mode.
2135
2136 ② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.
2137
2138 ③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.
2139
2140 ④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.
2141
2142 **Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.
2143
2144 **Domain name:** Set the domain name of the MQTT server that receives message. Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", “.”. The symbol cannot be placed at the first character or last character of name.
2145
2146 **Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.
2147
2148 **Client ID:** Login name. Variables can be used as login names. For example: Enter %0 and the Client ID is the device name (This can be set in the HMI background. If not, the default is HMI model). (Note: A Client ID can only be used for one device.) When there is no custom Client ID length, the maximum configurable length of a Client ID is 64 characters.
2149
2150 **ProductId:** The key of the product to which the device belongs, that is, the globally unique identifier issued by the IoT platform for the product. (Obtained from Alibaba Cloud Platform) Maximum input length: 128 characters.
2151
2152 **DeviceId:** Unique identifier of the device within the product. DeviceName is combined with ProductKey of the product to which the device belongs as the device identification, which is used for connection authentication and communication with the IoT platform. (Obtained from Alibaba Cloud Platform) Maximum input length: 64 characters.
2153
2154 **DeviceSecret:** The device key issued by the IoT platform for devices is used for authentication and encryption. It needs to be used in pairs with DeviceName. (Obtained from Alibaba Cloud Platform) Maximum input length: 128 characters.
2155
2156 **Encryption algorithm:** Alibaba Cloud's signature algorithm type supports hmacmd5 and hmacsha1.
2157
2158 **Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Use UTC+0 time.
2159
2160 **Clean message cache when normal connected:** If option is enabled, when the device is disconnected, the message to be published will be cached in the cache area, and then will be published when the device is online again.
2161
2162
2163 **Address**
2164
2165 (% style="text-align:center" %)
2166 [[image:29.jpg]]
2167
2168 **Status address: (Total length: 2 words)**
2169
2170 HDWn: Display [MQTT] connection status.
2171
2172 |Value|Description
2173 |0|Disable MQTT server connection
2174 |1|Disconnected or connecting
2175 |2|Successfully connected the MQTT server
2176
2177 HDWn+1: Error prompt
2178
2179 |Value|Description
2180 |0|No error
2181 |-1|General error code of wrong operation
2182 |-3|Disconnected
2183 |-4|Exceed client data concurrency
2184 |-5|Invalid UTF-8 string
2185 |-6|Null pointer parameter
2186 |-7|Topic name is truncated
2187 |-8|Wrong protocol structure body
2188 |-9|Wrong QOS.  (0, 1, 2) is acceptable.
2189 |-10|Attempt to use a non-SSL library for SSL connection
2190 |-11|Wrong MQTT version
2191 |-14|Wrong protocol type
2192 |-15|Option is not suitable for the current request version
2193 |-16|Call MQTT version that is not applicable to request.
2194 |-17|0 length topic connection
2195
2196 **Buffer usage address: (Total length: 1 word)**
2197
2198 Unsuccessful published message will be stored in memory as cache, with a maximum 100,000 messages or 2M. Value display as unit %, and it is carried unconditionally.
2199
2200 HDWn: Display buffer usage.
2201
2202 **Control address: (Total length: 258 words)**
2203
2204 HDWn: Control the execution or stop of [MQTT Server].
2205
2206 |Value|Description
2207 |0|Ready
2208 |1|Start
2209 |2|Stop
2210 |3|Update
2211
2212 HDWn+1: Port number of the Alibaba Cloud connection.
2213
2214 HDWn+2: Domain name title of the Alibaba Cloud connection.
2215
2216 HDWn+66: Client ID of the Alibaba Cloud connection.
2217
2218 HDWn+98: ProductId of the Alibaba Cloud connection.
2219
2220 HDWn+162: DeviceId of the Alibaba Cloud connection.
2221
2222 HDWn+194: DeviceSecret of the Alibaba Cloud connection.
2223
2224 **TLS/SSL Settings**
2225
2226 (% style="text-align:center" %)
2227 [[image:30.jpg]]
2228
2229 **Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.
2230
2231 **Server authentication:**
2232
2233 Enable: Verify whether the server certificate has been certified by a Certificate Authority Certificate (CA). Server certificates are sent by the server when connection is established.
2234
2235 Import: Select CA certificate to import.
2236
2237 More: After the import is successful, clicking it will display the certificate details.
2238
2239 Reset: Reset the import information.
2240
2241 The server name must be matched with the certificate information to verify whether the server name or IP matches the records in the certificate. Domain name and IP are recorded in the Subject Alternative Name in the certificate.
2242
2243 **(3) Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.
2244
2245 Certificate:
2246
2247 Import: Select certificate to import.
2248
2249 More: After the import is successful, clicking it will display the certificate details.
2250
2251 Reset: Reset the import information.
2252
2253 Key:
2254
2255 Import: Select the key to import.
2256
2257 More: After the import is successful, clicking it will display key details.
2258
2259 Reset: Reset the import information.
2260
2261
2262 **MQTT Topic**
2263
2264 (% class="wikigeneratedid" id="H1.MQTTtopicpublish" %)
2265 **MQTT topic publish**
2266
2267 Select [Topic publish], click [Add], enter [Add MQTT topic publish object], and set the general settings and address. The maximum number of MQTT published topics is 255.
2268
2269 (% style="text-align:center" %)
2270 [[image:31.jpg]]
2271
2272 **General properties**
2273
2274 (% style="text-align:center" %)
2275 [[image:32.jpg]]
2276
2277
2278 **Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.
2279
2280 **Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.
2281
2282 **Sending mode:** **(AUTO/TRIGGER)**
2283
2284 **① AUTO **value change mode: When any value changes, MQTT message is published.
2285
2286 a. Minimum time interval between messages: The minimum time interval can be set between messages to avoid over-publishing MQTT messages. When the interval of value change is less than the minimum time interval between messages, the message will be put in the cache. The MQTT message will not be published until the minimum interval between messages is met. Range: 0~~3600000ms.
2287
2288 b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing, ranging from 1 to 3600s.
2289
2290 **② TRIGGER**
2291
2292 When the specified bit is triggered, the MQTT message is published. When HDX0.0 changes from OFF to ON, an MQTT message is published, and HDX0.0 is automatically set to OFF after publishing.
2293
2294 **Compression type:** Message is compressed before it is transmitted. The compressed message needs to be decompressed before the MQTT client reads it. Zlib, Gzip, or Deflate algorithm can be chosen to compress or decompress the message.
2295
2296 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
2297
2298 0: Messages are sent only once, and delivery is not guaranteed.
2299
2300 1: Message must be delivered at least once.
2301
2302 2: Message is delivered just once.
2303
2304 **Retain message:** When checked, the MQTT server will keep the latest message.
2305
2306 **Content format:**
2307
2308 Raw data: Data composed of BYTE data.
2309
2310 JSON (General): Put all data in JSON format of member "d".
2311
2312 JSON (Advanced): JSON format of flexibly customizable nested structure.
2313
2314 **Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.
2315
2316 **Use the top "d" symbol in the message format:**
2317
2318 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
2319
2320 {
2321
2322 "d": {
2323
2324 "addressName1": ...,
2325
2326 "addressName2":...
2327
2328 },
2329
2330 "ts":...
2331
2332 }
2333
2334 When unchecked, the message format is as follows:
2335
2336 {
2337
2338 "addressName1": ...,
2339
2340 "addressName2":...,
2341
2342 "ts":...
2343
2344 }
2345
2346 As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.
2347
2348
2349 **Address setting**
2350
2351 ①Address settings when content formats use [Raw Data] and [JSON (General)].
2352
2353 (% style="text-align:center" %)
2354 [[image:33.jpg]]
2355
2356 **Add:** Establish the address source of the topic. The length of each address can be set separately.
2357
2358 **Delete:** Delete the address.
2359
2360 **Settings:** Modify the address and name.
2361
2362 (% style="text-align:center" %)
2363 [[image:34.jpg]]
2364
2365 **Included in all message sent**
2366
2367 Check the options: This topic will include this address every time it publishes a message.
2368
2369 Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.
2370
2371 **Remove JSON array brackets' ['and'] ':**
2372
2373 Check the options: Remove the array symbol name when using non-array bits or characters.
2374
2375 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
2376
2377 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
2378
2379 (% style="text-align:center" %)
2380 [[image:HMIEditor_Db5tLtioq7.jpg]]
2381
2382 The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.
2383
2384 {
2385 "object": {
2386 "value": "teststring",
2387 "value (1)": 123,
2388 "value (2)": true,
2389 "value (3)": "",
2390 "value (4)": 0,
2391 "value (5)": true
2392 },
2393 "array": [
2394 10,
2395 20,
2396 30
2397 ],
2398 "value (6)": " 2023-04-27T03: 53: 20.156271 "
2399 }
2400
2401 **New component:** Add a new data component. Components can have multiple data formats; each data format has its own Name and Value. The data of the component is included in braces {}.
2402
2403 **New value:** Add a value, string, or timestamp. When it is a value or a string, data can be read for a fixed value or from a specified address.
2404
2405 **Delete:** Delete the selected field.
2406
2407 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
2408
2409 **Template:** Paste the JSON text, and the system will automatically arrange the schema to conform to this JSON format, saving the time of self-definition.
2410
2411 **Preview:** Preview JSON data in an easy-to-read format.
2412
2413 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
2414
2415
2416 **Security settings**
2417
2418 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
2419
2420 (% style="text-align:center" %)
2421 [[image:35.jpg]]
2422
2423 **MQTT topic subscription**
2424
2425 Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.
2426
2427 (% style="text-align:center" %)
2428 [[image:36.jpg]]
2429
2430 **General properties**
2431
2432 (% style="text-align:center" %)
2433 [[image:37.jpg]]
2434
2435 **Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.
2436
2437 **Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.
2438
2439 **Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.
2440
2441 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
2442
2443 0: Messages are sent only once, and delivery is not guaranteed.
2444
2445 1: Message must be delivered at least once.
2446
2447 2: Message is delivered just once.
2448
2449 **Content format:**
2450
2451 Raw data: There is no original data in a specific format.
2452
2453 JSON (General): JSON format of single-layer structure.
2454
2455 JSON (Advanced): JSON format of flexibly customizable nested structure.
2456
2457 **Verify timestamp:** The user can decide whether to verify the timestamp or not. When checked, it indicates that the received data timestamp must be strictly incremented before it can be updated. Otherwise, it will be judged as outdated data and not updated.
2458
2459 **Use the top "d" symbol in the message format:**
2460
2461 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
2462
2463 {
2464
2465 "d": {
2466
2467 "addressName1": ...,
2468
2469 "addressName2":...
2470
2471 },
2472
2473 "ts":...
2474
2475 }
2476
2477 When unchecked, the message format is as follows:
2478
2479 {
2480
2481 "addressName1": ..., "addressName2":...,
2482
2483 "ts":...
2484
2485 }
2486
2487 Please select the appropriate settings according to the data source.
2488
2489 **Address setting**
2490
2491 ①Address settings when content formats use [Raw Data] and [JSON (General)].
2492
2493 (% style="text-align:center" %)
2494 [[image:38.jpg]]
2495
2496 **Add:** Establish the address where the data is placed after the topic is subscribed, and the length of each address can be set separately.
2497
2498 **Delete:** Delete the address.
2499
2500 **Settings:** Modify the address and name.
2501
2502 (% style="text-align:center" %)
2503 [[image:39.jpg]]
2504
2505 **Remove JSON array brackets' ['and'] ':**
2506
2507 When using non-array bits or characters, array symbol can manually be removed.
2508
2509 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
2510
2511 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
2512
2513 (% style="text-align:center" %)
2514 [[image:40.jpg]]
2515
2516 **New component:** Add a new data component. There can be multiple data formats in a component, each with a name and a value. The data of the component is included in braces {}.
2517
2518 **New Array:** Add a new data array. Arrays can have multiple data formats, but only one name. The data of the component is included in brackets [].
2519
2520 **New value:** Add a value, string, or timestamp. When it is a value or a string, data can be read for a fixed value or from a specified address.
2521
2522 **Delete:** Delete the selected field.
2523
2524 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
2525
2526 **Template:** Paste the JSON text, and the system will automatically arrange the schema to conform to this JSON format, saving the time of self-definition.
2527
2528 **Preview:** Preview JSON data in an easy-to-read format.
2529
2530 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
2531
2532
2533 **Security settings**
2534
2535 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
2536
2537 (% style="text-align:center" %)
2538 [[image:41.jpg]]
2539
2540 **MQTT Server Settings (Huawei)**
2541
2542 **General**
2543
2544 (% style="text-align:center" %)
2545 [[image:42.jpg]]
2546
2547 **Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.
2548
2549 **Cloud service description**: (Select Huawei)
2550
2551 ① Common (Common Platform): General MQTT publish-subscribe topic mode.
2552
2553 ② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.
2554
2555 ③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.
2556
2557 ④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.
2558
2559 **Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.
2560
2561 **Domain name:** Set the domain name of the MQTT server that subscribe message. Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", “.”. The symbol cannot be placed at the first character or last character of name.
2562
2563 **Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.
2564
2565 **DeviceId:** **Device ID** generated when registering the device in Huawei Cloud. Maximum input length: 128 characters
2566
2567 **DeviceSecret:** Customized **password **when registering devices on Huawei Cloud Maximum input length: 128 characters.
2568
2569 **Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.
2570
2571 **Clean message cache when normal connected:** If option is enabled, when the device is disconnected, the message to be published will be cached in the cache area, and then will be published when the device is online again.
2572
2573
2574 **Address**
2575
2576 (% style="text-align:center" %)
2577 [[image:43.jpg]]
2578
2579 **Status address: (Total length: 2 words)**
2580
2581 HDWn: Display [MQTT] connection status.
2582
2583 |Value|Description
2584 |0|Disable MQTT server connection
2585 |1|Disconnected or connecting
2586 |2|Successfully connected the MQTT server
2587
2588 HDWn+1: Error prompt
2589
2590 |Value|Description
2591 |0|No error
2592 |-1|General error code of wrong operation
2593 |-3|Disconnected
2594 |-4|Exceed client data concurrency
2595 |-5|Invalid UTF-8 string
2596 |-6|Null pointer parameter
2597 |-7|Topic name is truncated
2598 |-8|Wrong protocol structure body
2599 |-9|Wrong QOS.  (0, 1, 2) is acceptable.
2600 |-10|Attempt to use a non-SSL library for SSL connection
2601 |-11|Wrong MQTT version
2602 |-14|Wrong protocol type
2603 |-15|Option is not suitable for the current request version
2604 |-16|Call MQTT version that is not applicable to request.
2605 |-17|0 length topic connection
2606
2607 **Buffer usage address: (Total length: 1 word)**
2608
2609 Unsuccessful published message will be stored in memory as cache, with a maximum 100,000 messages or 2M. Value display as unit %, and it is carried unconditionally.
2610
2611 HDWn: Display buffer usage.
2612
2613 **Control address: (Total length: 194 words)**
2614
2615 HDWn: Control the execution or stop of [MQTT Server].
2616
2617 |Value|Description
2618 |0|Ready
2619 |1|Start
2620 |2|Stop
2621 |3|Update
2622
2623 HDWn+1: Port number of the Huawei Cloud.
2624
2625 HDWn+2: Domain name of the Huawei Cloud.
2626
2627 HDWn+66: DeviceSecret of the Huawei Cloud.
2628
2629 HDWn+130: DeviceSecret of the Huawei Cloud.
2630
2631 **TLS/SSL Settings**
2632
2633 (% style="text-align:center" %)
2634 [[image:44.jpg]]
2635
2636 **Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.
2637
2638 **Server authentication:**
2639
2640 Enable: Verify whether the server certificate has been certified by a Certificate Authority Certificate (CA). Server certificates are sent by the server when connection is established.
2641
2642 Import: Select CA certificate to import.
2643
2644 More: After the import is successful, clicking it will display the certificate details.
2645
2646 Reset: Reset the import information.
2647
2648 The server name must match the certificate information: Verify whether the server name or IP matches with the information in the certificate. Domain name and IP are recorded in the Subject Alternative Name from certificate.
2649
2650 **Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.
2651
2652 Certificate:
2653
2654 Import: Select certificate to import.
2655
2656 More: After the import is successful, clicking it will display the certificate details.
2657
2658 Reset: Reset the import information.
2659
2660 Key:
2661
2662 Import: Select the key to import.
2663
2664 More: After the import is successful, clicking it will display key details.
2665
2666 Reset: Reset the import information.
2667
2668 **MQTT Topic**
2669
2670 **MQTT topic publish**
2671
2672 Select [Topic publish], click [Add], enter [Add MQTT topic publish object], and set the general settings and address. The maximum number of MQTT published topics is 255.
2673
2674 (% style="text-align:center" %)
2675 [[image:45.jpg]]
2676
2677 **General properties**
2678
2679 (% style="text-align:center" %)
2680 [[image:46.jpg]]
2681
2682 **Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.
2683
2684 **Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.
2685
2686 **Sending mode:** **(AUTO/TRIGGER)**
2687
2688 **① AUTO **value change mode: When any value changes, MQTT message is published.
2689
2690 a. Minimum time interval between messages: The minimum time interval can be set between messages to avoid over-publishing MQTT messages. When the interval of value change is less than the minimum time interval between messages, the message will be put in the cache. The MQTT message will not be published until the minimum interval between messages is met. Range: 0~~3600000ms.
2691
2692 b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing, ranging from 1 to 3600s.
2693
2694 **② TRIGGER**
2695
2696 When the specified bit is triggered, the MQTT message is published. When HDX0.0 changes from OFF to ON, an MQTT message is published, and HDX0.0 is automatically set to OFF after publishing.
2697
2698 **Compression type:** Message is compressed before it is transmitted. The compressed message needs to be decompressed before the MQTT client reads it. Zlib, Gzip, or Deflate algorithm can be chosen to compress or decompress the message.
2699
2700 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
2701
2702 0: Messages are sent only once, and delivery is not guaranteed.
2703
2704 1: Message must be delivered at least once.
2705
2706 2: Message is delivered just once.
2707
2708 **Retain message:** When checked, the MQTT server will keep the latest message.
2709
2710 **Content format:**
2711
2712 Raw data: Data composed of BYTE data.
2713
2714 JSON (General): Put all data in JSON format of member "d".
2715
2716 JSON (Advanced): JSON format of flexibly customizable nested structure.
2717
2718 **Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.
2719
2720 **Use the top "d" symbol in the message format:**
2721
2722 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
2723
2724 {
2725
2726 "d": {
2727
2728 "addressName1": ...,
2729
2730 "addressName2":...
2731
2732 },
2733
2734 "ts":...
2735
2736 }
2737
2738 When unchecked, the message format is as follows:
2739
2740 {
2741
2742 "addressName1": ...,
2743
2744 "addressName2":...,
2745
2746 "ts":...
2747
2748 }
2749
2750 As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.
2751
2752
2753 **Address setting**
2754
2755 ①Address settings when content formats use [Raw Data] and [JSON (General)].
2756
2757 (% style="text-align:center" %)
2758 [[image:47.jpg]]
2759
2760 **Add:** Establish the address source of the topic. The length of each address can be set separately.
2761
2762 **Delete:** Delete the address.
2763
2764 **Settings:** Modify the address and name.
2765
2766 (% style="text-align:center" %)
2767 [[image:48.jpg]]
2768
2769 **Included in all message sent**
2770
2771 Check the options: This topic will include this address every time it publishes a message.
2772
2773 Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.
2774
2775 **Remove JSON array brackets' ['and'] ':**
2776
2777 Check the options: Remove the array symbol name when using non-array bits or characters.
2778
2779 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
2780
2781 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
2782
2783 (% style="text-align:center" %)
2784 [[image:49.jpg]]
2785
2786 The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.
2787
2788 {
2789 "object": {
2790 "value": "teststring",
2791 "value (1)": 123,
2792 "value (2)": true,
2793 "value (3)": "",
2794 "value (4)": 0,
2795 "value (5)": true
2796 },
2797 "array": [
2798 10,
2799 20,
2800 30
2801 ],
2802 "value (6)": " 2023-04-27T03: 53: 20.156271 "
2803 }
2804
2805 **New component:** Add a new data component. Components can have multiple data formats; each data format has its own Name and Value. The data of the component is included in braces {}.
2806
2807 **New value:** Add a value, string, or timestamp. When it is a value or a string, data can be read for a fixed value or from a specified address.
2808
2809 **Delete:** Delete the selected field.
2810
2811 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
2812
2813 **Template:** Paste the JSON text, and the system will automatically arrange the schema to conform to this JSON format, saving the time of self-definition.
2814
2815 **Preview:** Preview JSON data in an easy-to-read format.
2816
2817 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
2818
2819
2820 **Security settings**
2821
2822 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
2823
2824 (% style="text-align:center" %)
2825 [[image:50.jpg]]
2826
2827
2828 **MQTT topic subscription**
2829
2830 Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.
2831
2832 (% style="text-align:center" %)
2833 [[image:51.jpg]]
2834
2835 **General properties**
2836
2837 (% style="text-align:center" %)
2838 [[image:52.jpg]]
2839
2840 **Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.
2841
2842 **Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.
2843
2844 **Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.
2845
2846 **QoS:** MQTT provides three levels of reliability called service quality. The service quality of message transmission determines whether the message is guaranteed to be delivered.
2847
2848 0: Messages are sent only once, and delivery is not guaranteed.
2849
2850 1: Message must be delivered at least once.
2851
2852 2: Message is delivered just once.
2853
2854 **Content format:**
2855
2856 Raw data: There is no original data in a specific format.
2857
2858 JSON (General): JSON format of single-layer structure.
2859
2860 JSON (Advanced): JSON format of flexibly customizable nested structure.
2861
2862 **Verify timestamp:** The user can decide whether to verify the timestamp or not. When checked, it indicates that the received data timestamp must be strictly incremented before it can be updated. Otherwise, it will be judged as outdated data and not updated.
2863
2864 **Use the top "d" symbol in the message format:**
2865
2866 This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:
2867
2868 {
2869
2870 "d": {
2871
2872 "addressName1": ...,
2873
2874 "addressName2":...
2875
2876 },
2877
2878 "ts":...
2879
2880 }
2881
2882 When unchecked, the message format is as follows:
2883
2884 {
2885
2886 "addressName1": ..., "addressName2":...,
2887
2888 "ts":...
2889
2890 }
2891
2892 Please select the appropriate settings according to the data source.
2893
2894 **Address setting**
2895
2896 ①Address settings when content formats use [Raw Data] and [JSON (General)].
2897
2898 (% style="text-align:center" %)
2899 [[image:53.jpg]]
2900
2901 **Add:** Establish the address where the data is placed after the topic is subscribed. The length of each address can be set separately.
2902
2903 **Delete:** Delete the address.
2904
2905 **Settings:** Modify the address and name.
2906
2907 (% style="text-align:center" %)
2908 [[image:54.jpg]]
2909
2910 **Remove JSON array brackets' ['and'] ':**
2911
2912 When using non-array bits or characters, array symbol can manually be removed.
2913
2914 **✎Note: A topic can be configured up to 255 nodes. The name length of a node can be configured up to a maximum of 255 characters and cannot be empty.**
2915
2916 ② Address setting when the content format uses [JSON (Advanced)]. [JSON (Advanced)] supports nested structure, which can use components, arrays and other forms. Timestamps and data names can also be customized, which is a more flexible design method.
2917
2918 (% style="text-align:center" %)
2919 [[image:HMIEditor_Db5tLtioq7.jpg]]
2920
2921 **New component:** Add a new data component. There can be multiple data formats in a component, each with a name and a value. The data of the component is included in braces {}.
2922
2923 **New Array:** Add a new data array. Arrays can have multiple data formats, but only one name. The data of the component is included in brackets [].
2924
2925 **New value:** Add a value, string, or timestamp. When it is a value or a string, data can be read for a fixed value or from a specified address.
2926
2927 **Delete:** Delete the selected field.
2928
2929 **Settings:** Modify the selected field. If the selected fields are components and arrays, only the names can be modified. But components and arrays include values that can modify parameters.
2930
2931 **Template:** Paste the JSON text, and the system will automatically arrange the schema to conform to this JSON format, saving the time of self-definition.
2932
2933 **Preview:** Preview JSON data in an easy-to-read format.
2934
2935 **✎Note: A Topic can be up to 512 nodes (including payload), and a node name can be configured to be up to 255 characters length.**
2936
2937
2938 **Security settings**
2939
2940 The topic is published only when the register status matches the setting. As shown in the following figure, this topic will not be published until the address HDX0.0 is set to ON.
2941
2942 (% style="text-align:center" %)
2943 [[image:56.jpg]]
2944
2945 = OPCUA Server =
2946
2947 (% class="box infomessage" %)
2948 (((
2949 ✎Note: Only 8000ig Series support OPC UA Server.
2950 )))
2951
2952 1.Open the OPCUA server tool
2953
2954 [Project]→[OPCUA server]→[Enable]
2955
2956 (% style="text-align:center" %)
2957 [[image:QOBzq5f8HF.png]]
2958
2959 2.Set General properties
2960
2961 (% style="text-align:center" %)
2962 [[image:e9rHcIHKsj.png]]
2963
2964 **Description:**Description of OPCUA server, character length 0~~255.** **
2965
2966 **OPC TCP:**Set URL of OPCUA server.
2967
2968 **Port number:**The port used by the client for communication.Default: 4840.
2969
2970 **Server name:**Set the name of Server,character length 0~~255.
2971
2972 **Security:**OPCUA server provides four security policies and three authentication methods, and different encryption methods can be implemented through different combinations.
2973
2974 3.User authentication
2975
2976 (% style="text-align:center" %)
2977 [[image:1733132656389-393.png]]
2978
2979 **Anonymous:**When the client chooses to log in anonymously, the permissions to interact with the server include brows, read and write.
2980
2981 **User name password:**The user name and password here are equivalent to the user name and password set on the [Project Settiing\User Login] page. When the client logs in to the server by using the user name and password, the user password used has the same group level as that configured by the server and has corresponding permissions.
2982
2983 4.Main interface
2984
2985 (% style="text-align:center" %)
2986 [[image:1733133255552-776.png]]
2987
2988 **Enable:**Check to configure the relevant properties of the OPC UA server
2989
2990 **Server\Settings:**Configure OPC UA Server Properties
2991
2992 **List of tags:**Display the defined tags
2993
2994 **New group:**Add a new group to manage tags
2995
2996 **New label:**Add the address label you want to monitor, and the name cannot be empty. The length of the label name ranges from 1 to 255.
2997
2998 **Settings:**When a label is selected, click to jump to the label configuration interface.
2999
3000 When a group is selected, click to configure the group name.
3001
3002 **Cancel:**Able to delete tags or groups
3003
3004 (% class="box infomessage" %)
3005 (((
3006 ✎Note: Setting and cancel options are only for the New label and New group, and do not apply to groups that exist by default
3007 )))
3008
3009 5.Label configuration
3010
3011 (% style="text-align:center" %)
3012 [[image:1733133363652-686.png]]
3013
3014
3015 **Name:**Tag name
3016
3017 **Type:**Indicate the read and write attributes of the label. The read attributes are checked by default** **
3018
3019 **Address:**Configure the address to be monitored by the label
3020
3021 **Data Type:**Represent the data type of this label
3022
3023 **Array length:**When the set length exceeds 1, it means that the label is an array, and the array range is 1 to 255.