06 Data Tool

* **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" %)

(((

**✎Note:**

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

**✎Note:**

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

56

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

57

58

**Operating Procedures of Adding One Alarm**

59

60

* Click "Project"→"Bit Alarm" as below shows.

61

62

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

63

[[image:8.Basic Function_html_5f8da20315334bac.png||data-xwiki-image-style-alignment="center" height="144" width="539" class="img-thumbnail"]]

64

65

* Click "Add" button to open "Bit Alarm" setting window.

66

67

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

68

[[image:8.Basic Function_html_94a019683b506e15.png||data-xwiki-image-style-alignment="center" height="307" width="554" class="img-thumbnail"]]

69

70

* Set "Bit Address".

71

* Set "Alarm Condition".

72

* Set "Content".

73

* Other settings can be set according to the actual situation".

74

* Click "OK" button to complete settings.

== Word alarm ==

Word alarm is to monitor the word address of a device. If the data meets the set conditions, an alarm will be generated.

79

80

Click "Project"→"Word alarm", it is displayed as the following figure.

81

82

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

83

[[image:字报警 1.png||class="img-thumbnail"]]

84

85

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

86

87

**Alarm Address: **It is used for setting word address for word alarm, such as HDW0.

88

89

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

90

91

**Group No.: **Group number of word alarm. The name is unique and cannot be duplicated.

92

93

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

94

95

(% class="box infomessage" %)

(((

**✎Note:**

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

100

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

101

102

(% style="margin-left:auto; margin-right:auto; width:358px" %)

103

|=(% style="width: 79px;" %)Series|=(% style="width: 276px;" %)Number of Alarm upload to Cloud

104

|(% style="width:79px" %)8000-R|(% style="text-align:center; width:276px" %)200

105

|(% style="width:79px" %)9000-R|(% style="text-align:center; width:276px" %)200

106

|(% style="width:79px" %)3000ig|(% style="text-align:center; width:276px" %)20

107

|(% style="width:79px" %)8000ig|(% style="text-align:center; width:276px" %)200

108

|(% style="width:79px" %)MD|(% style="text-align:center; width:276px" %)20

109

)))

110

111

**Record alarm:** Whether to record the alarm history data of word alarm, if checked, it will be saved in the designated storage location.

112

113

**Not save alarm OFF:** If checked, after the alarm is dismissed, the corresponding alarm records will be deleted from the log file.

114

115

**Alarm Condition**: Alarm is triggered when designated address meets the alarm condition, it provides four conditions;

116

117

1. **High alarm:** Alarm is triggered when it reaches high limit. It can be a constant or a variable

118

1. **Low alarm:** Alarm is triggered when it reaches low limit. It can be a constant or a variable

119

1. **Range alarm:** Alarm is triggered when it exceeds the range. It can be a constant or a variable

120

1. **Equivalent alarm: **Alarm is triggered when the value equals to the given data. It can be a constant or a variable

121

122

**Alarm Info: **It is used for setting alarm content (command);

123

124

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

125

126

**Alarm Screen: **Pop-up alarm screen (it need to be sub-screen);

127

128

1. **Position: **The location of the screen alarm display.

129

1. **Pop-up Interval: **The time of reopen the alarm screen when alarm screen closed.

130

1. **Pop-up once: **Pop up alarm screen once.

131

1. **Close window when alarm off: **Automatically close the alarm screen when alarm off.

132

133

**Beep when alarm ON: **beep works when the alarm is triggered, in the default mode, the beep works until the alarm is released.

134

135

**Beep once:** Beep works once, when alarm is triggered.

**Alarm List**

It displays all the word alarm lists; it will show the alarm information;

140

141

**Operating Procedures of Adding One Alarm**

142

143

* Click "Project"→ "Word Alarm" as below shows.

144

145

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

146

[[image:8.Basic Function_html_1b59522c984cd7c2.png||height="144" width="492" class="img-thumbnail"]]

147

148

* Click "AddClick" button to open "Word Alarm" setting window.

149

150

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

151

[[image:8.Basic Function_html_942107c81fc6901c.png||height="307" width="554" class="img-thumbnail"]]

152

153

* Set Basic information of word alarm.

154

* Set "Content".

155

* Other settings can be set according to the actual situation.

156

* Click "OK" button to complete settings.

157

158

**HMI Alarm Demo Download Link**

159

160

[[https:~~/~~/drive.google.com/open?id=1Llq03CMISM_1mMIfU308hxFbs4rGdQGP>>url:https://drive.google.com/open?id=1Llq03CMISM_1mMIfU308hxFbs4rGdQGP]]

= **Recipe** =

== Overview of recipe ==

165

166

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.

167

168

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

169

170

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.

171

172

(% class="wikigeneratedid" id="HExample" %)

173

**Example**

174

175

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.

176

177

Table 1 Example recipe

|Top|2|2|1|30

|Bottom|3|1|2|40

|Outside|2|3|3|20

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

185

186

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:

187

188

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

189

[[image:1.png]]

190

191

Click [Add] to pop up the recipe setting interface, as shown in the following figure:

192

193

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

194

[[image:2.png]]

195

196

|Recipe configuration options|Description|Notice

197

|Recipe name|Name the current recipe|Note: Recipe name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), ('') and other non-English characters.

198

|Group number|Configure the group number of the current recipe, ranging from 0 to 1000|

199

|Number of ingredients|Configure the number of the current ingredient, ranging from 0 to 1500|

200

201

|Data configuration options|Description|Notice

202

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

203

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

204

|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" %)**✎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.

205

|Decimal point position|Configure the selection of integer and decimal places of data.

206

|Enable discontinuous addresses|If checked, the address of the recipe list can be modified.|

207

|Language|Recipe display language is selectable.|

208

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

209

|Insert group|Click [Insert group], enter the number of groups to insert, and the corresponding row will be added to the recipe list.|

210

|Delete group.|Click [Delete group] to select the group to delete|

211

|Insert ingredient|Click [Insert group], enter the number of groups to insert, and the corresponding row will be added to the recipe list.|

212

|Delete ingredient|Click [Delete ingredient] to select the ingredient to delete.|

213

|Data import|Import existing data files, supporting .xlsx .xls .csv format.|

214

|Data export|Export configured recipe data|

215

216

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.

Data operation

1. **Read:** Read a group of data from the recipe file and assign the group of data to the set address.

221

1. **Write: **Read a group of data from the set address and assign the group of data to the corresponding recipe file.

222

223

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.

224

225

The maximum number of group in recipe is 1000, and the maximum number of member in each group is 1500.

226

227

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.

228

229

1. **Simple: **Only support the data operation of one recipe file, including read and write.

230

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

231

232

Recipe function settings will be display in "[[Recipe display>>http://docs.we-con.com.cn/wiki/pistudio/view/Helps/06.Objects/#HRecipedisplay]]" object.

**Description**

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

237

[[image:8-1Recipe.png]]

**Basic**

* **Recipe Folder:** Give Recipe folder name (It can be used, when setting Recipe display object);

242

** (% class="box infomessage" %)

243

(((

244

**✎Note: **Recipe Folder name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), (' ') and other non-English characters;

245

)))

246

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

247

* **Elements:** It sets members' initial number of each group;

248

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

249

* **Decimal: **It sets integer and scale digits;

250

251

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

252

253

Function address: all operations are done through function addresses, different operating value is as follows:

254

255

* = 0: no operation;

256

* = 1: trigger read data;

257

* = 2: new trigger or update (If there is group number, it updates.)

258

* = 4: insert (only valid in advanced mode)

259

* = 8: delete (Delete according to the writing group number. If write and read address are consistent, refer to the reading group number);

260

* = 16: delete and sorted ((Delete according to the writing group number. If write and read address are consistent, refer to the reading group number)

261

* = 64: import CSV recipe file.

262

263

**Use Multiple File**

264

265

Check it to use more than one recipe file in HMI, but this option only valid in [Advanced mode];

**Select language**

The text in HMI can be in 8 languages, user can set language in here;

**Address**

1. **Group:** This address is for selecting group number;

274

1. **Start: **This is starting address is for reading and writing in recipe, PIStudio will automatically assigns addresses for each members;

275

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.

**Use Index**

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.

**Query by Element**

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;

284

285

(% class="box infomessage" %)

286

(((

287

**✎Note: **When this option is enabled, Group address will be invalid.

288

)))

289

290

**Use Independent Write Address**

291

292

To separate Recipe read address and write address.

**Use Insert**

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.

297

298

**Discontinuous Address**

299

300

Whether enable the non-consecutive recipe operation addresses or not. If disabled, the recipe address will recover as the continuous addresses.

301

302

(% class="box infomessage" %)

303

(((

304

**✎Note: **This function only supported in HMI+, i series, ie series, ig series.

305

)))

306

307

**Description of adcanced mode**

308

309

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.

310

311

[[image:image-20220806111333-1.jpeg]]

312

313

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

314

315

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

316

317

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

318

319

[[image:image-20220806111355-2.jpeg]]

320

321

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

322

323

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.

324

325

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.

326

327

**Recipe Demo Download Link: **[[Download>>url:https://drive.google.com/open?id=1Cjbq_tW-NIirHFBpxt47g7IKvoYaWqUR]]

328

329

== Calling CSV recipe file ==

**Overview**

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.

**Operations**

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.

338

339

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

340

(((

341

(% style="display:inline-block" %)

342

[[Figure 1>>image:image-20220806100702-2.jpeg]]

343

)))

344

345

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.

346

347

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

348

[[image:image-20220806100753-3.jpeg]]

349

350

By configuring the address in the table and combining the recipe function, the CSV recipe files of regular series are imported.

351

352

|=Address range|=Object type|=Address function

353

|HSW1050 to 1065|Text input object|Enter the CSV recipe file name to import

354

|HSW1066|Numerical input object|Import CSV file type:(((

355

* = 0: Custom CSV file (all data in the file is valid)

356

* = 1: Normal recipe file for regular series HMI (the data in line 1 of the file is invalid)

357

* = 2: Special recipe file for regular series HMI (the data in line 1 and 2 and column 1 of the file are invalid)

358

)))

359

|HSW1067|Numerical input object|(((

360

Where the CSV file is saved:

361

362

* = 0: In the CsvFile directory of U disk

363

* = 1: In the CsvFile directory of the SD card

364

365

**The path for offline simulation is: C:\ HMIEmulation\ CustomFileDir\ CsvFile**

366

)))

367

|HSW242|Numerical input object|Returns the results of the csv import:(((

368

* = 37: CSV file imported successfully

369

* = 38: CSV file import failed

370

)))

371

372

**Select CSV recipe file (take U disk as an example):**

373

374

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.

375

376

Use the special address of the above table to configure the path of the CSV file: HSW106, configure recipe file name: HSW1050 to1065

377

378

Use HSW1066 address to select the corresponding CSV recipe file type.

379

380

* HSW1066 = 0: Import a user-defined CSV recipe file (all data in the custom CSV file must be valid);

381

382

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

383

[[image:image-20220806101129-5.jpeg]]

384

385

* HSW1066=1: Import the normal recipe file of regular series HMI (the data in line 1 of the file is invalid);

386

387

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

388

389

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

390

[[image:image-20220806101520-6.jpeg]]

391

392

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

393

394

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

395

396

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

397

[[image:image-20220806102610-7.jpeg]]

**Perform import**

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:

402

403

* Configure the DB recipe file name by text input object: HDW500 = 3 (recipe file configured in Figure 1),

404

* Set the recipe function address to: HDW1000 = 64 (the function address configured in Figure 1),

405

* Transform the CSV recipe file in U disk into DB recipe file with file name “3.rcp2”.

406

407

**DB recipe file for storing CSV data:**

408

409

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.

410

411

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

**Import results:**

* HSW242 = 37: Import succeeded;

416

* HSW242 = 38: Import failed.

**Precautions:**

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

421

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

422

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

423

424

== **Recipe record function** ==

**Basic setting**

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

429

[[image:3.png]]

430

431

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

432

433

Recipe shortcut key setting:

434

435

Add data: Used to add groups.

436

437

Delete data: Used to delete the selected configuration

438

439

Upload recipe: Used to upload the address data of the selected group to the corresponding group in recipe records.

440

441

Download recipe: Used to download the address data of the selected group to the corresponding group in recipe records.

442

443

Import recipe: Used to import the existing recipe files.

444

445

Export recipe: Used to export the current recipe as a file.

**Graphic**

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

450

[[image:4.png]]

451

452

Style selection: Styles can be switched or customized.

453

454

Background configuration: Set the recipe background, including background color and transparency.

455

456

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.

**Expansion**

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

461

[[image:5.png]]

462

463

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

464

465

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.

466

467

Gray level display: When the object is locked, the text message will be grayed out.

468

469

= (% style="color:inherit; font-family:inherit; font-size:29px" %)**Traditional recipe**(%%) =

470

471

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.

472

473

Traditional recipe function is valid only when the LEVI project is converted to the PI project, and the original project uses the traditional recipe.

474

475

(% class="box infomessage" %)

476

(((

477

**✎Note**: Currently, only HMI+, i series, ie series, and ig series support the traditional recipe.

478

)))

479

480

== Simple recipe mode ==

481

482

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:

483

484

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

485

[[image:8-3TraditionalRecipeConfigScreen.png||class="img-thumbnail"]]

**✎Note**:

* The recipe folder name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), ('').

490

* The element name of the recipe cannot include following 5 special characters: " **,** " , " **|** " , " **<** " , " **>** " , " **&** " .

== Recipe display ==

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.

495

496

(% class="box infomessage" %)

497

(((

498

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

499

)))

500

501

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

502

[[image:8-4TraditionalRecipeDisplayConfigScreen.png||class="img-thumbnail"]]

503

504

== Recipe transmission address ==

505

506

The special addresses used in the Recipe are shown in the following table:

507

508

(% class="table-bordered" %)

509

|=Address|=Description|=Function

510

|HSW1611|Traditional Recipe transfer operation.|(((

511

~=1: Recipe download.

~=2: Recipe upload.

)))

|HSW1612|Traditional Recipe group number.|Traditional Recipe group number.

|(((

HSW242

)))|(((

Recipe operation result prompt:

520

521

Upload: Data is written to recipe file from address.

522

523

Download: Data is written to the address from recipe file.

524

)))|(((

525

~=1: Recipe download, start.

526

527

~=2: Recipe download, execution error.

528

529

~=6: Recipe download, successful.

530

531

~=7: Recipe upload, start.

532

533

~=8: Recipe upload, execution error.

534

535

~=11: Recipe group name does not exist.

536

537

~=12: Recipe upload, successful.

538

)))

539

540

== **Recipe index** ==

541

542

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

543

544

The recipe index area (RPW)'s instruction as follows:

545

546

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.

547

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.

548

549

* **✎Note**: As long as RPW~*~*~#~#~#~# exists, any object "writes" to HPW~*~*~#~#~#~# will be saved to the recipe file.

550

551

(% start="3" %)

552

1. The RPW register only supports word address access.

553

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.

== Recipe example ==

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

558

559

Edit the recipe configuration, create three groups of recipes, 4 elements for per group: Red, green, blue, spraying time, as following shown:

560

561

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

562

[[image:8-5TraditionalRecipeCaseConfig.png]]

563

564

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:

565

566

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

567

[[image:8-7TraditionalRecipeCaseShowNoOpera.png]]

568

569

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.

570

571

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

572

[[image:8-6TraditionalRecipeCaseShow.png]]

= **Trend chart** =

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.

577

578

Click "Project" → "Trend chart", it will pop up the following screen. Click "Add" to creat new curve record.

579

580

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

581

[[image:趋势图配置 001.png||class="img-thumbnail"]]

**Settings**

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

586

[[image:趋势图设置 2.png||height="507" width="866"]]

587

588

**(1) Basic settings**

589

590

1. **Curve NO.: **It is for setting curve number,

591

1. **Curve Name:** It is for setting curve name. The length limitation is 31 bytes.

592

1. **Curve (1~~8):** It is for setting the number of curves. The default is 3.

593

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.

**(2) Sample Type**

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.

598

1. **Sample unit:** 100ms.

599

600

**(3) Quick Setting**

601

602

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.

603

604

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

605

[[image:趋势图设置 3.png||class="img-thumbnail"]]

606

607

(% start="2" %)

608

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.

609

610

**(4) Curve Table:** The sample address you have set would display on it. Click the corresponding box to modify the content.

611

612

(% class="box infomessage" %)

613

(((

614

**✎Note: **Curve names can only consist of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_') (' '), and other non-English characters.

615

)))

616

617

**Trend Chart Demo Download Link**

618

619

[[https:~~/~~/drive.google.com/open?id=1smnaAvSxOWC0WQK4_uvqHXWn4vUZxGJC>>url:https://drive.google.com/open?id=1smnaAvSxOWC0WQK4_uvqHXWn4vUZxGJC]]

620

621

= **History XY plot** =

622

623

Different from TrendChart, uses need to set history XY curve items in project. Please click "Project"-> "History XY Plot" to open the setting screen.

624

625

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.

626

627

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

628

[[image:历史XY 2.png||class="img-thumbnail"]]

629

630

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

631

[[image:历史XY 3.png||class="img-thumbnail"]]

632

633

**(1) Basic settings**

634

635

1. **Curve NO.: **It is for setting curve number,

636

1. **Curve Name:** It is for setting curve name. The length limitation is 31 bytes.

637

1. **Curve (1~~8):** It is for setting the number of curves. The default is 3.

638

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.

**(2) Sample Type**

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.

643

1. **Sample unit:** 100ms.

644

645

**(3) Quick Setting**

646

647

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.

648

649

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

650

[[image:image-20220616145435-1.png]]

651

652

(% start="2" %)

653

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.

654

655

**(4) Curve Table:** The sample address you have set would display on it. Click the corresponding box to modify the content.

656

657

(% class="box infomessage" %)

658

(((

659

**✎Note: **Curve names can only consist of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_') (' '), and other non-English characters.

660

)))

661

662

**Operating Procedure**

663

664

* Click "Project" → "History XY Plot" to open the function selecting windows.

665

666

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

667

[[image:8.Basic Function_html_5da6ca44bd28acbe.png||height="144" width="533" class="img-thumbnail"]]

668

669

* Click "Add" button to open "History XY Plot” setting windows.

670

671

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

672

[[image:8.Basic Function_html_6345b50ea55168fa.png||height="307" width="554" class="img-thumbnail"]]

673

674

* Setting the function of History XY Plot.

675

* Click "OK" to save the setting.

**Download Link**

[[https:~~/~~/drive.google.com/open?id=1t4_HuRmIJJ-B5ryA2kVMadD9FywKhZ4r>>url:https://drive.google.com/open?id=1t4_HuRmIJJ-B5ryA2kVMadD9FywKhZ4r]]

680

681

= (% style="color:inherit; font-family:inherit; font-size:29px" %)**Data record**(%%) =

682

683

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.

684

685

The topology is shown in the following figure.

686

687

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

688

[[image:8.Basic Function_html_1b4bd09dafa7e049.png||height="332" width="554" class="img-thumbnail"]]

689

690

The data record stored in SD card is also organized according to the above figure.

691

692

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.

693

694

**Sampling interval: **The interval between two consecutive samples was recorded.

695

696

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.

697

698

For the file storage of data, see the file size configuration during data record configuration.

✎**Note: **

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.

703

704

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:

705

706

(% style="margin-left:auto; margin-right:auto; width:513px" %)

707

|=(% style="width: 70px;" %)Series|=(% style="width: 442px;" %)Number of Data Record upload to Cloud

708

|(% style="width:70px" %)8000-R|(% style="text-align:center; width:442px" %)100

709

|(% style="width:70px" %)9000-R|(% style="text-align:center; width:442px" %)100

710

|(% style="width:70px" %)3000ig|(% style="text-align:center; width:442px" %)50

711

|(% style="width:70px" %)8000ig|(% style="text-align:center; width:442px" %)100

712

|(% style="width:70px" %)MD|(% style="text-align:center; width:442px" %)50

713

714

The record group name can only be composed of Chinese characters, (0~~9), (a~~z), (A~~Z), ('_'), ('') and other non-English characters.

715

716

Channel name cannot incloud following symbols: ：" , ", " | ", " < ", " > ", " & ".

717

718

(% class="wikigeneratedid" id="HSettings" %)

719

**Settings**

720

721

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

722

[[image:数据记录设置 1.png||height="533" width="848" class="img-thumbnail"]]

723

724

**Operating Procedures**

725

726

1. Click "Project"->"Data record" as below shows.

727

1. Click "Add" button to open "Data record" setting window.

728

1. Enter group name, the default is "GroupName0"

729

1. Select "Trigger function" mode, such as "No trigger".

730

1. Set "Total channels", such as 3.

731

1. Click "Apply" button.

732

1. Set Sample cycle, such as 15.

733

1. Set "Start channel" in "Quick settings", such as 4 0.

734

1. Check group information in "Channel list" as below.

735

1. Click "Save" button to complete settings.

736

737

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.

✎**Note: **

* For HMI series 8000 and above, the size of a single file cannot exceed 300M and the total file capacity cannot exceed 1000M.

742

* For HMI series 3000, the size of a single file cannot exceed 4M and the total file capacity cannot exceed 10M.

743

* If the total amount exceeds the range, an alarm will be given during project compilation.

744

745

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

746

[[image:数据记录设置 2.png||height="572" width="850" class="img-thumbnail"]]

747

748

**(1) Group name:** Set group name, and he name should be unique.

749

750

**(2) Trigger function:** There are four modes to trigger record.

751

752

1. **No trigger: **Data will be recorded in every sample time.

753

1. **Trigger to record by sample cycle: **Data will be recorded in every same time, when trigger control bit set ON.

754

1. **Trigger to record once and reset: **Data will be recorded when trigger control bit set ON, and the bit will be reset automatically.

755

1. **Trigger to record once: **Data will be recorded when trigger control bit set ON, and the bit need to be reset manually.

756

1. **Trigger address: **It is only valid when the trigger condition is selected. The monitoring cycle for trigger sampling address is 1s.

757

758

**(3) Total channels (1~~100): **Set the numbers of channels. Click "apply" to view the channel lists on the right record channel.

759

760

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

761

762

**Timing address:** It sets address to change sample time when HMI is running;

763

764

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

765

766

**Abnormal value:** It sets a value, when communication fails, data record will record this value;

767

768

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

769

770

**(7) Quick Settings**

771

772

1. **Start Channel:** It sets the continuous addresses for channels.

773

1. **Data Format: **It sets the same data format for channels.

774

1. **Number of Digits:** It sets the digits’ number for channels.

775

1. **Language Settings**: The text in HMI can be in 8 languages, user can set language in here.

776

777

**(8) Channel List**: Besides quick settings, user can set channel name, address, data format, and so on one by one according to real situation.

**✎Note:**

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

782

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

783

* The channel name can only be composed of English characters, (0~~9), (a~~z), (A~~Z), ('_'), ('').

784

* The channel name does not include these 5 special characters: ", ", "| "," <", "> "," & ".

785

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

786

787

You could click here to jump to object "[[Data Record Display>>https://docs.we-con.com.cn/bin/view/PIStudio/06.Objects/#HDatarecorddisplay]]"

788

789

= **User permission** =

**Introduction**

1. User permission is one of expansion function in PI Series HMI; it provides multi-level of permission for control HMI operations.

794

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.

795

1. Operating record: it records user operations information, the records files are saved in HMI flash; its path is [~\~\flash~\~\UserOperationLogs.db].

796

1. When it is on simulator mode, the files are saved in C disk, its path is [C:~\~\WECON\UserMgrFile\UserOperationLogs.db].

797

798

(% class="box infomessage" %)

(((

✎**Note: **

* The user name and password must be unique. Username can be up to 32 characters, and password can be up to 8 characters.

803

* The multi language function of User permission only supported on HMI system version V2.0 or above

)))

== Settings ==

Open PIStudio software, then operate as the following figure.

809

810

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

811

[[image:用户权限 1.png||class="img-thumbnail"]]

812

813

Click on the cell from UserName and Desc, which can support the multi language.

814

815

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

816

[[image:UserPermissionMultilan.png]]

817

818

1. Click "User Permission" in "Data Tool" toolbar.

819

1. Edit user name, click "User0" cell under "UserName", and then enter the user name, one project allows maximum 20 users.

820

1. Edit password, click "User0" cell under "PassWord", and then enter the user name.

821

1. Edit description, click "User0" cell under "Desc", and then enter, description is not necessary。

822

1. Check the groups for each user, there are 11 groups beside admin.

823

1. Editing groups' description, but it is not necessary.

824

1. {{id name="OLE_LINK7"/}}{{id name="OLE_LINK6"/}}Click "Save and Exit" button to complete all settings.

825

826

(% class="box infomessage" %)

(((

✎**Note:**

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

831

* When the configured file does not have the administrator account, a new user can be added through "Funtion address" and set as the administrator.

832

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

833

* (((

834

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.

)))

)))

(((

)))

== Object permission configuration ==

843

844

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

845

[[image:用户权限 2.png||class="img-thumbnail"]]

846

847

User operation logs support multi languages configuration. Click on the Log Message, the text editor of multi language will be pop up:

848

849

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

850

[[image:LogMessagesMultilan.png]]

851

852

**Operation Procedure of Object Permission**

853

854

1. Open the object setting windows;

855

1. Select "Security" windows;

856

1. Check the "User Permission";

857

1. Select "Level" to set permission level;

858

1. Enter "Log Message", it is for operation records, if it was empty, the operation for this object would be not be recorded;

859

1. Select the "Access Denied Setting" mode;

860

861

**Log information description**

862

863

A combination of Chinese characters, numbers, and uppercase and lowercase letters can be entered, and the number does not exceed 63.

864

865

The format of insert variable:{variable address, data format}. e.g., {HDW100,UW2.1}.

866

867

The data format are as follows.

868

869

(% class="table-bordered" %)

|=Letter|=Meaning

|B|Binary

|O|Octonary

|U|Unsigned decimal

|H|Hexadecimal

|b|BCD

|F|32-bit float

|S|Signed decimal

|C|Character

|W|Single word

|D|Double word

Examples.

* Unsigned decimal, BCD, 32-bit float and Signed decimal are as follows.

885

886

{HDW100,UW2.1}: Indicates the variable address is HDW100. The data format are: unsigned decimal, single word, two integer bits, one decimal place.

887

888

* (((

889

Binary, Octonary and Hexadecimal are as follows.

890

)))

891

892

{HDW100,HD8}: Indicates the variable address is HDW100. The data format are: hexadecimal, double word, eight integer bits.

893

894

* (((

895

Character is as follows.

896

)))

897

898

{HDW100,C32}: Indicates the variable address is HDW100. The data format are: 32 characters.

899

900

When a record is generated, the contents of this variable are replaced by the value of your corresponding address.

901

902

== **Function address** ==

903

904

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.

905

906

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

907

908

Functions and addresses are as follows.

909

910

(% class="table-bordered" %)

911

|=**Function**|=**Address**|=**Object type**|=**Address function**

912

|(% rowspan="3" %)Sign in|HUW1158~~1335|Drop down list|User name

913

|HUW1002|Character input object|Password

914

|HUW1000|Word Switch (Input 1)|OK (sign in)

915

|(% rowspan="5" %)Change password|HUW1158~~1335|Drop down list|User name

916

|HUW1002|Character input object|Old password

917

|HUW1006|Character input object|New password

918

|HUW1010|Character input object|Confirm password

919

|HUW1000|Word Switch (Input 2)|OK(change password)

920

|Sign out|HUW1000|Word Switch (Input 3) |Sign out

921

|(% rowspan="7" %)(((

922

New user ***1**

923

)))|HUW1014|Character input object|User name

924

|HUW1006|Character input object|password

925

|HUW1010|Character input object|Confirm password

926

|HUW1000|Word Switch (Input 4) |OK(add new user)

927

|HUW1336~~1345|Character input object|User description

928

|HUX1347.0|Bit switch|(((

929

~=1: User hidden

930

931

~=0: Visible (Defaults)

932

)))

933

|HUW1000|Word Switch (Input 8) |Save(add Hide features)

934

|(% rowspan="2" %)(((

935

Delete user ***2**

936

)))|HUW1158~~1335|Drop down list|User name

937

|HUW1000|Word Switch (Input 5)|OK (delete user)

938

|Delete Profile|HUW1000|Word Switch (Input 9)|OK(delete)

939

|Export Profile|HUW1000|Word Switch (Input 10)|OK(export)

940

|Import profile|HUW1000|Word Switch (Input 11)|OK(import)

941

|Export log file|HUW1000|Word Switch (Input 12)|OK(export)

942

|Delete log file|HUW1000|Word Switch (Input 13)|OK (delete)

943

|Current user name|HUW1349|Character object|32 Word

944

|System state information|HUW1030|Character input object|System state information

945

|(% rowspan="3" %)Permission settings|HUW1014|Character input object|User name

946

|HUW1348|Bit switch|(((

947

Set the user group:

948

949

HUX1348.0 = 1 administrator;

950

951

HUX1348.1 = 1 group 0 permission;

952

953

HUX1348.2 = 1 group 1 permission;

954

955

(Total group 0 - group 10)

956

)))

957

|HUW1000|Word Switch (Input 6)|Add user rights (set according to HUW1348)

958

|User login mode setting|HUW1382|Word Switch/Numeric input object|(((

959

0: Select a user name from the drop-down list

960

961

1: Use character input object (address HUW1014) to log in with a user name

962

)))

963

964

When the user performs a function operation, the operation result is displayed in the HUW1001.

965

966

(% class="table-bordered" %)

967

|=**Value (HUW1001)**|=**Meaning**

968

|1|Insufficient permissions.

969

|2|Username does not exist.

970

|3|Username already exists.

971

|4|Wrong username or password.

972

|5|Login successfully.

973

|6|Passwords are inconsistent in twice time.

974

|7|Password changed successfully.

975

|8|User added successfully.

976

|9|User deleted successfully.

977

|10|Maximum number of users exceeded.

978

|11|Admin user already exists.

979

|12|User permission modified successfully.

980

|13|File imported successfully.

981

|14|File imported failed.

982

|15|File exported successfully.

983

|16|File exported failed.

984

|17|Logout successfully.

985

|18|Profile deleted successfully.

986

|19|Log file deleted successfully.

987

|20|Hide settings modified successfully.

988

|21|Hide settings modified failed.

989

|22|(((

990

Password already occupied, please reset.

991

992

(For both username and password, it can not repetition)

993

)))

994

995

(% class="box infomessage" %)

(((

**✎Note:**

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

1000

* *1: When adding new user, the password could not be duplicated with other users.

1001

* *2: When deleting user, it is forbidden to delete the admin user.

1002

)))

1003

1004

**User Permission Demo Download**

1005

1006

[[https:~~/~~/drive.google.com/open?id=1qOiEDvo_1H1YqpoLDpS77dGaAFm8nrGq>>url:https://drive.google.com/open?id=1qOiEDvo_1H1YqpoLDpS77dGaAFm8nrGq]]

= Message prompt =

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.

1011

1012

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

1013

[[image:消息提示 2.png||class="img-thumbnail"]]

1014

1015

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

1016

[[image:8.Basic Function_html_5ce2091d6f7cd732.png||height="515" width="704" class="img-thumbnail"]]

**(1) Message**

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

**(2) Control**

1. **Current item: **It shows selected message information.

1025

1. **Use trigger address: **When the message is triggered, the trigger address would be set ON.

**For Example:**

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.

1030

1031

1. **Show message: **Check it to display message when HMI is running. It is checked by default.

1032

1. **Show on web: **Check it to display message when remote access HMI screen, it is unchecked by default.

1033

1034

**(3) Message Content**

1035

1036

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.

1037

1038

**(4) Reload Text: **It means discard changes.

**For Example**

User deletes default content or modifies default content, but he wants to give up modification back to original, just click "Reload text".

1043

1044

(% class="box infomessage" %)

(((

**✎Note:**

* If you do not want this prompt during the running of HMI, please uncheck "Show message".

1049

* "Reload text" function would be invalid after clicking "save".

1050

* These 5 special characters are not supported in the header Multi language settings: ",", "|", "<", ">", "&".

)))

= **Cloud** =

**Introduction**

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

1058

1059

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.

1060

1061

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

1062

[[image:云配置1.png||height="494" width="750" class="img-thumbnail"]]

**(1) Enable**

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:

1067

1068

1069

|8000-R (HMI V2.0 System)|300|200|100|1000

1070

|9000-R (HMI V2.0 System)|300|200|100|1000

1071

|3000ig|100|20|50|500

1072

|8000ig|300|200|100|1000

|MD|100|20|50|500

For example:

* In 3000ig's Cloud, the monitoring tags upload to the Cloud in real time is limited to 100.

1078

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

1079

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

1080

1081

**(2) Server Selection**

1082

1083

**Server**: China, ASEAN, and Europe.

**Password**:

1. If the HMI is not bound, this access password will be updated and downloaded into the HMI screen simultaneously.

1088

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.

1089

1090

**(3) Upload Selection**:

1091

1092

To upload the data collected by HMI to the cloud or a to the third-party server, only one upload method can be selected.

1093

1094

1. **to Cloud**: All the configured tags, data records, and alarm records would be pushed to V-NET.

1095

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]]".

1096

1097

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.

1098

1099

**4) Low Data Mode setting**

1100

1101

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.

1102

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.

1103

1104

= MQTT[[image:2.png]] =

1105

1106

(% class="wikigeneratedid" %)

1107

Configurable type MQTT. Users can publish message to the MQTT server or subscribe topics from the MQTT server.

1108

1109

**MQTT Configuration (Common Settings/AWS IOT Settings/ALi Settings/Huawei Settings)**

1110

1111

This chapter explains how to use configurable type MQTT. Users can publish message to the MQTT server or subscribe topics from the MQTT server.

1112

1113

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:

1114

1115

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

1116

[[image:2.jpg]]

1117

1118

**MQTT Server Settings (Common)**

**General**

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

1123

[[image:3.jpg]]

1124

1125

**Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.

1126

1127

**Cloud Service**: (Select Common)

1128

1129

① Common (Common Platform): General MQTT publish-subscribe topic mode.

1130

1131

② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.

1132

1133

③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.

1134

1135

④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.

1136

1137

**Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.

1138

1139

**Custom Client ID length:** User can customize the length of the Client ID (optional), length range: 20 ~~128.

1140

1141

**Custom username/password length:** Customize the length of user name/password length (optional), length range: 16 ~~ 256.

1142

1143

**IP:** Set the MQTT server IP to subscribe message.

1144

1145

**Use domain name:** Support using domain name to the specify server.

1146

1147

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

1148

1149

**Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.

1150

1151

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

1152

1153

**Verification:** Choose whether to connect to the MQTT server using [User Name] and [Password].

1154

1155

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

1156

1157

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

1158

1159

**Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.

1160

1161

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

**Address**

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

1167

[[image:4.jpg]]

1168

1169

**Status address: (Total length: 2 words)**

1170

1171

HDWn: Display [MQTT] connection status.

1172

1173

|Value|Description

1174

|0|Disable MQTT server connection

1175

|1|Disconnected or connecting

1176

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1183

|-3|Disconnected

1184

|-4|Exceed client data concurrency

1185

|-5|Invalid UTF-8 string

1186

|-6|Null pointer parameter

1187

|-7|Topic name is truncated

1188

|-8|Wrong protocol structure body

1189

|-9|Bad QoS, acceptable range is (0, 1, 2)

1190

|-10|Try to use a non-SSL version library for SSL connection

1191

|-11|Wrong MQTT version

1192

|-14|Wrong protocol type

1193

|-15|Option is not suitable for the current request version

1194

|-16|Call MQTT version that is not applicable to request.

1195

|-17|0 length connects topics

1196

1197

**Buffer usage address: (Total length: 1 word)**

1198

1199

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.

1200

1201

HDWn: Display buffer usage.

1202

1203

**Control address: (Total length: 123 words; If the domain name is not enabled, it will take up 59 words)**

1204

1205

HDWn: Control the execution or stop of [MQTT Server].

|Value|Description

|0|Ready

|1|Start

|2|Stop

|3|Update

HDWn+1: IP address of the MQTT server. (✎**Note: This address is only valid when IP is used.**)

1214

1215

HDWn+5: Port number of the MQTT server.

1216

1217

HDWn+6: Client ID of the MQTT server connection.

1218

1219

HDWn+26: Authentication is enabled or not. = 0, disabled; = 1, enabled.

1220

1221

HDWn+27: User name of MQTT server connection.

1222

1223

HDWn+43: Password of MQTT server connection.

1224

1225

HDWn+59: Domain name of the MQTT server. (**✎Note: This address is only valid if the domain name is used.**)

**TLS/SSL Settings**

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

1231

[[image:5.jpg]]

1232

1233

**Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.

1234

1235

**Server authentication:**

1236

1237

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.

1238

1239

Import: Select CA certificate to import.

1240

1241

More: After the import is successful, clicking it will display the certificate details.

1242

1243

Reset: Reset the import information.

1244

1245

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.

1246

1247

**Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.

Certificate:

Import: Select certificate to import.

1252

1253

More: After the import is successful, clicking it will display the certificate details.

1254

1255

Reset: Reset the import information.

Key:

Import: Select the key to import.

1260

1261

More: After the import is successful, clicking it will display key details.

1262

1263

Reset: Reset the import information.

**System topics**

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

1269

[[image:6.jpg]]

1270

1271

**Birth Topic: **The message that HMI will publish when it is connected to server.

1272

1273

**Close Topic:** The last send message before HMI actively disconnects from server connection

1274

1275

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

1276

1277

**Topic List:** A list of topics in the HMI that is sent to the server after the HMI is connected to the server.

1278

1279

**Topic:** The actual topic name of the system topic. Maximum input length: 255 characters, cannot be empty.

1280

1281

**Retain message: **The MQTT server keeps the latest message.

1282

1283

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

1284

1285

QoS 0: Messages are sent only once, and delivery is not guaranteed.

1286

1287

QoS 1: Message must be delivered at least once.

1288

1289

QoS 2: Message is delivered just once.

**Content format:**

**JSON (Default):** Use default values, default values for each system topic (**The bold is represented as the current actual value**)

**Birth Topic:**

{

"d": {

"connected": true

},

"ts": " **Current time**"

}**Close Topic: **

{

"d": {

"connected": false

},

"ts": " **Current time**"

}**Last Will: **

{

"d": {

"connected": false

}

}**Topic list:**

{

"d": {

"topics": [

{

"compression": "

",

"nickname": "**Subject name**",

"topic": "**Theme**"

},

{

"compression": "**Compression type**",

1328

1329

"nickname": "**Subject nam**e",

"topic": "**Theme**"

}

]

},

"ts": "**Current time**"

1336

}

1337

1338

Messages within topics vary depending on the actual topic settings. The above is an example of two topics.

1339

1340

**JSON (Customized):** Use custom content.

1341

1342

**Choose the connection network card**

1343

1344

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

1345

[[image:7.jpg]]

1346

1347

**Default:** According to the priority order of network adapters set in the HMI background to connect server.

1348

1349

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

1350

1351

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

1352

1353

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

1354

1355

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

**MQTT Topic**

**MQTT topic publish**

1361

1362

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.

1363

1364

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

1365

[[image:8.jpg]]

1366

1367

**General properties**

1368

1369

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

1370

[[image:9.jpg]]

1371

1372

**Alias:** Set the project name of the MQTT topic. Maximum input length: 255 characters, cannot be empty.

1373

1374

**Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.

1375

1376

Sending mode: (AUTO/TRIGGER)

1377

1378

**① AUTO **value change mode: When any value changes, MQTT message is published.

1379

1380

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.

1381

1382

b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing. The range is 1~~3600s.

**② TRIGGER**

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.

1387

1388

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

1389

1390

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

1391

1392

0: Messages are sent only once, and delivery is not guaranteed.

1393

1394

1: Message must be delivered at least once.

1395

1396

2: Message is delivered just once.

1397

1398

**Retain message: **When checked, the MQTT server keeps the latest message.

**Content format:**

Raw data: Data composed of BYTE data.

1403

1404

JSON (General): Put all data in JSON format of member "d".

1405

1406

JSON (Advanced): JSON format of flexibly customizable nested structure.

1407

1408

**Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.

1409

1410

**Use the top "d" symbol in the message format:**

1411

1412

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ...,

"addressName2":...,

"ts":...

}

As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.

**Address setting**

①Address settings when content formats use [Raw Data] and [JSON (General)].

1445

1446

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

1447

[[image:10.jpg]]

1448

1449

**Add:** Establish the address source of the topic. The length of each address can be set separately.

1450

1451

**Delete:** Delete the address.

1452

1453

**Settings:** Modify the address and name.

1454

1455

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

1456

[[image:11.jpg]]

1457

1458

**Included in all message sent**

1459

1460

Check the options: This topic will include this address every time it publishes a message.

1461

1462

Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.

1463

1464

**Remove JSON array brackets' ['and'] ':**

1465

1466

Check the options: Remove the array symbol name when using non-array bits or characters.

1467

1468

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

1469

1470

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

1471

1472

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

1473

[[image:12.jpg]]

1474

1475

The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.

{

"object": {

"value": "teststring",

"value (1)": 123,

"value (2)": true,

"value (3)": "",

"value (4)": 0,

"value (5)": true

},

"array": [

10,

20,

30

],

"value (6)": " 2023-04-27T03: 53: 20.156271 "

1492

}

1493

1494

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

1495

1496

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

1497

1498

**Delete:** Delete the selected field.

1499

1500

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

1501

1502

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

1503

1504

**Preview:** Preview JSON data in an easy-to-read format.

1505

1506

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

1507

1508

**Security settings**

1509

1510

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.

1511

1512

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

1513

[[image:13.jpg]]

1514

1515

**MQTT topic subscription**

1516

1517

Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.

1518

1519

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

1520

[[image:14.jpg]]

1521

1522

**General properties**

1523

1524

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

1525

[[image:15.jpg]]

1526

1527

**Alias:** Set the project name of the MQTT topic. Maximum input length: 255 characters, cannot be empty.

1528

1529

**Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.

1530

1531

**Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.

1532

1533

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

1534

1535

0: Messages are sent only once, and delivery is not guaranteed.

1536

1537

1: Message must be delivered at least once.

1538

1539

2: Message is delivered just once.

**Content format:**

Raw data: There is no original data in a specific format.

1544

1545

JSON (General): JSON format of single-layer structure.

1546

1547

JSON (Advanced): JSON format of flexibly customizable nested structure.

1548

1549

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

1550

1551

**Use the top "d" symbol in the message format:**

1552

1553

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ..., "addressName2":...,

"ts":...

}

Please select the appropriate settings according to the data source.

**Address settings**

①Address settings when content formats use [Raw Data] and [JSON (General)].

1584

1585

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

1586

[[image:16.jpg]]

1587

1588

**Add:** Establish the address where the data is stored after the topic is subscribed, and the length of each address can be set separately.

1589

1590

**Delete:** Delete the address.

1591

1592

**Settings:** Modify the address and name.

1593

1594

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

1595

[[image:17.jpg]]

1596

1597

**Remove JSON array brackets' ['and'] ':**

1598

1599

When using non-array bits or characters, array symbol can manually be removed.

1600

1601

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

1602

1603

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

1604

1605

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

1606

[[image:18.jpg]]

1607

1608

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

1609

1610

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

1611

1612

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

1613

1614

**Delete:** Delete the selected field.

1615

1616

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

1617

1618

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

1619

1620

**Preview:** Preview JSON data in an easy-to-read format.

1621

1622

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

1623

1624

**(3) Security settings**

1625

1626

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.

1627

1628

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

1629

[[image:19.jpg]]

1630

1631

**MQTT Server Settings (AWS IOT)**

**General**

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

1636

[[image:20.jpg]]

1637

1638

**Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.

1639

1640

**Cloud service description**: (Select AWS IOT)

1641

1642

① Common (Common Platform): General MQTT publish-subscribe topic mode.

1643

1644

② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.

1645

1646

③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.

1647

1648

④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.

1649

1650

**Communication protocol**: MQTT v3.1.1 is supported.

1651

1652

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

1653

1654

**Port number:** Set the MQTT server port to receive message. Range: 0~~65535, cannot be empty. (AWS IOT platform is generally 8883).

1655

1656

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

1657

1658

**Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.

**Address**

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

1664

[[image:21.jpg]]

1665

1666

**Status address: (Total length: 2 words)**

1667

1668

HDWn: Display [MQTT] connection status.

1669

1670

|Value|Description

1671

|0|Disable MQTT server connection

1672

|1|Disconnected or connecting

1673

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1680

|-3|Disconnected

1681

|-4|Exceed client data concurrency

1682

|-5|Invalid UTF-8 string

1683

|-6|Null pointer parameter

1684

|-7|Topic name is truncated

1685

|-8|Wrong protocol structure body

1686

|-9|Wrong QOS. (0, 1, 2) is acceptable.

1687

|-10|Attempt to use a non-SSL library for SSL connection

1688

|-11|Wrong MQTT version

1689

|-14|Wrong protocol type

1690

|-15|Option is not suitable for the current request version

1691

|-16|Call MQTT version that is not applicable to request.

1692

|-17|0 length topic connection

1693

1694

**Buffer usage address:** Not available.

1695

1696

**Control address: (Total length: 90 words)**

1697

1698

HDWn: Control the execution or stop of [MQTT Server].

|Value|Description

|0|Ready

|1|Start

|2|Stop

|3|Update

HDWn+1: Reserved for use.

1707

1708

HDWn+5: Port number of the AWS IOT connection.

1709

1710

HDWn+6: Client ID of the AWS IOT connection.

1711

1712

HDWn+26: Domain name of the AWS IOT connection.

**TLS/SSL Settings**

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

[[image:22.jpg]]

**Enable:**

Enabled by default. The default is TLS V1.2.

1722

1723

**Server authentication:**

1724

1725

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.

1726

1727

Import: Select CA certificate to import.

1728

1729

More: After the import is successful, clicking it will display the certificate details.

1730

1731

Reset: Reset the import information.

1732

1733

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.

1734

1735

**(3) Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.

Certificate:

Import: Select certificate to import.

1740

1741

More: After the import is successful, clicking it will display the certificate details.

1742

1743

Reset: Reset the import information.

Key:

Import: Select the key to import.

1748

1749

More: After the import is successful, clicking it will display key details.

1750

1751

Reset: Reset the import information.

**Device setting**

Select [Add] to enter [General property settings and address settings]. To delete a device, select the device and click Delete.

1757

1758

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

[[image:23.jpg]]

**General**

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

1764

[[image:24.jpg]]

1765

1766

**Device name:** It is consistent with the item name on AWS IOT. Maximum input length: 128 characters, cannot be empty, supports letters, numbers, "-", "_".

1767

1768

**Description:** For distinguish purpose. Maximum input length: 255 characters.

1769

1770

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

1771

1772

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

1773

1774

0: Messages are sent only once, and delivery is not guaranteed.

1775

1776

1: Message must be delivered at least once.

1777

1778

2: Message is delivered just once.

1779

1780

**Content format:** Not configurable. All data is in JSON format.

1781

1782

**Include timestamps:** Whether to include the timestamp can be decided manually.

1783

1784

**Use the top "d" symbol in the message format:**

1785

1786

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ...,

"addressName2":...,

"ts":...

}

As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.

**Address**

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

1819

[[image:25.jpg]]

1820

1821

**Add:** Establish the address source of the topic. The length of each address can be set separately.

1822

1823

**Delete:** Delete the address.

1824

1825

**Settings:** Modify the address and name.

1826

1827

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

[[image:26.jpg]]

**Advanced Mode:**

Check the options: Check to configure four “Settings/Status".

1833

1834

Uncheck the options: Check to configure two "Settings/Status".

1835

1836

**Name:** Correspond to the key value in JSON.

1837

1838

**Type:** “Bit" and “Word” are optional. “Word” configuration can choose system of numeration.

**Length:**

Length 1: General JSON format.

1843

1844

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.

1845

1846

For example, configure as the following figure:

1847

1848

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

1849

[[image:27.jpg]]

1850

1851

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.

{

"state": {

"desired": {

"welcome": [1, 2, 3]

},

"reported": {

"welcome": [4, 5, 6]

}

}

}

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

1874

1875

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

1876

1877

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

1878

1879

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

1880

1881

**Remove JSON array brackets' ['and'] ':** Check to remove array symbols when using non-array bits or characters. (Configurable when length is 1).

1882

1883

**MQTT Server Settings (ALi)**

**General**

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

1888

[[image:28.jpg]]

1889

1890

**Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.

1891

1892

**Cloud service description**: (Select Ali)

1893

1894

① Common (Common Platform): General MQTT publish-subscribe topic mode.

1895

1896

② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.

1897

1898

③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.

1899

1900

④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.

1901

1902

**Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.

1903

1904

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

1905

1906

**Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.

1907

1908

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

1909

1910

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

1911

1912

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

1913

1914

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

1915

1916

**Encryption algorithm:** Alibaba Cloud's signature algorithm type supports hmacmd5 and hmacsha1.

1917

1918

**Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Use UTC+0 time.

1919

1920

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

**Address**

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

1926

[[image:29.jpg]]

1927

1928

**Status address: (Total length: 2 words)**

1929

1930

HDWn: Display [MQTT] connection status.

1931

1932

|Value|Description

1933

|0|Disable MQTT server connection

1934

|1|Disconnected or connecting

1935

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1942

|-3|Disconnected

1943

|-4|Exceed client data concurrency

1944

|-5|Invalid UTF-8 string

1945

|-6|Null pointer parameter

1946

|-7|Topic name is truncated

1947

|-8|Wrong protocol structure body

1948

|-9|Wrong QOS. (0, 1, 2) is acceptable.

1949

|-10|Attempt to use a non-SSL library for SSL connection

1950

|-11|Wrong MQTT version

1951

|-14|Wrong protocol type

1952

|-15|Option is not suitable for the current request version

1953

|-16|Call MQTT version that is not applicable to request.

1954

|-17|0 length topic connection

1955

1956

**Buffer usage address: (Total length: 1 word)**

1957

1958

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.

1959

1960

HDWn: Display buffer usage.

1961

1962

**Control address: (Total length: 258 words)**

1963

1964

HDWn: Control the execution or stop of [MQTT Server].

|Value|Description

|0|Ready

|1|Start

|2|Stop

|3|Update

HDWn+1: Port number of the Alibaba Cloud connection.

1973

1974

HDWn+2: Domain name title of the Alibaba Cloud connection.

1975

1976

HDWn+66: Client ID of the Alibaba Cloud connection.

1977

1978

HDWn+98: ProductId of the Alibaba Cloud connection.

1979

1980

HDWn+162: DeviceId of the Alibaba Cloud connection.

1981

1982

HDWn+194: DeviceSecret of the Alibaba Cloud connection.

**TLS/SSL Settings**

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

1987

[[image:30.jpg]]

1988

1989

**Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.

1990

1991

**Server authentication:**

1992

1993

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.

1994

1995

Import: Select CA certificate to import.

1996

1997

More: After the import is successful, clicking it will display the certificate details.

1998

1999

Reset: Reset the import information.

2000

2001

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.

2002

2003

**(3) Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.

Certificate:

Import: Select certificate to import.

2008

2009

More: After the import is successful, clicking it will display the certificate details.

2010

2011

Reset: Reset the import information.

Key:

Import: Select the key to import.

2016

2017

More: After the import is successful, clicking it will display key details.

2018

2019

Reset: Reset the import information.

**MQTT Topic**

(% class="wikigeneratedid" id="H1.MQTTtopicpublish" %)

2025

**MQTT topic publish**

2026

2027

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.

2028

2029

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

2030

[[image:31.jpg]]

2031

2032

**General properties**

2033

2034

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

[[image:32.jpg]]

**Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.

2039

2040

**Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.

2041

2042

**Sending mode:** **(AUTO/TRIGGER)**

2043

2044

**① AUTO **value change mode: When any value changes, MQTT message is published.

2045

2046

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.

2047

2048

b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing, ranging from 1 to 3600s.

**② TRIGGER**

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.

2053

2054

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

2055

2056

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

2057

2058

0: Messages are sent only once, and delivery is not guaranteed.

2059

2060

1: Message must be delivered at least once.

2061

2062

2: Message is delivered just once.

2063

2064

**Retain message:** When checked, the MQTT server will keep the latest message.

**Content format:**

Raw data: Data composed of BYTE data.

2069

2070

JSON (General): Put all data in JSON format of member "d".

2071

2072

JSON (Advanced): JSON format of flexibly customizable nested structure.

2073

2074

**Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.

2075

2076

**Use the top "d" symbol in the message format:**

2077

2078

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ...,

"addressName2":...,

"ts":...

}

As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.

**Address setting**

①Address settings when content formats use [Raw Data] and [JSON (General)].

2112

2113

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

2114

[[image:33.jpg]]

2115

2116

**Add:** Establish the address source of the topic. The length of each address can be set separately.

2117

2118

**Delete:** Delete the address.

2119

2120

**Settings:** Modify the address and name.

2121

2122

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

2123

[[image:34.jpg]]

2124

2125

**Included in all message sent**

2126

2127

Check the options: This topic will include this address every time it publishes a message.

2128

2129

Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.

2130

2131

**Remove JSON array brackets' ['and'] ':**

2132

2133

Check the options: Remove the array symbol name when using non-array bits or characters.

2134

2135

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

2136

2137

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

2138

2139

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

2140

[[image:HMIEditor_Db5tLtioq7.jpg]]

2141

2142

The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.

{

"object": {

"value": "teststring",

"value (1)": 123,

"value (2)": true,

"value (3)": "",

"value (4)": 0,

"value (5)": true

},

"array": [

10,

20,

30

],

"value (6)": " 2023-04-27T03: 53: 20.156271 "

2159

}

2160

2161

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

2162

2163

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

2164

2165

**Delete:** Delete the selected field.

2166

2167

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

2168

2169

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

2170

2171

**Preview:** Preview JSON data in an easy-to-read format.

2172

2173

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

2174

2175

2176

**Security settings**

2177

2178

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.

2179

2180

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

2181

[[image:35.jpg]]

2182

2183

**MQTT topic subscription**

2184

2185

Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.

2186

2187

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

2188

[[image:36.jpg]]

2189

2190

**General properties**

2191

2192

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

2193

[[image:37.jpg]]

2194

2195

**Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.

2196

2197

**Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.

2198

2199

**Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.

2200

2201

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

2202

2203

0: Messages are sent only once, and delivery is not guaranteed.

2204

2205

1: Message must be delivered at least once.

2206

2207

2: Message is delivered just once.

**Content format:**

Raw data: There is no original data in a specific format.

2212

2213

JSON (General): JSON format of single-layer structure.

2214

2215

JSON (Advanced): JSON format of flexibly customizable nested structure.

2216

2217

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

2218

2219

**Use the top "d" symbol in the message format:**

2220

2221

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ..., "addressName2":...,

"ts":...

}

Please select the appropriate settings according to the data source.

**Address setting**

①Address settings when content formats use [Raw Data] and [JSON (General)].

2252

2253

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

2254

[[image:38.jpg]]

2255

2256

**Add:** Establish the address where the data is placed after the topic is subscribed, and the length of each address can be set separately.

2257

2258

**Delete:** Delete the address.

2259

2260

**Settings:** Modify the address and name.

2261

2262

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

2263

[[image:39.jpg]]

2264

2265

**Remove JSON array brackets' ['and'] ':**

2266

2267

When using non-array bits or characters, array symbol can manually be removed.

2268

2269

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

2270

2271

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

2272

2273

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

2274

[[image:40.jpg]]

2275

2276

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

2277

2278

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

2279

2280

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

2281

2282

**Delete:** Delete the selected field.

2283

2284

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

2285

2286

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

2287

2288

**Preview:** Preview JSON data in an easy-to-read format.

2289

2290

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

2291

2292

2293

**Security settings**

2294

2295

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.

2296

2297

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

2298

[[image:41.jpg]]

2299

2300

**MQTT Server Settings (Huawei)**

**General**

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

2305

[[image:42.jpg]]

2306

2307

**Description:** Enter a description or comment about the server. Maximum input length: 255 characters, cannot be empty.

2308

2309

**Cloud service description**: (Select Huawei)

2310

2311

① Common (Common Platform): General MQTT publish-subscribe topic mode.

2312

2313

② AWS IoT (Amazon): Using "AWS IoT" as the Broker, using Thing to transfer data and support Shadow function.

2314

2315

③ ALi (Alibaba Cloud): Using "Alibaba Cloud" as Broker.

2316

2317

④ Huawei (Huawei Cloud): Using "Huawei Cloud" as Broker.

2318

2319

**Communication protocol**: MQTTv3.1, v3.1.1 and v5 are supported.

2320

2321

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

2322

2323

**Port number:** Set the MQTT server port to subscribe message. Range: 0~~65535, cannot be empty.

2324

2325

**DeviceId:** **Device ID** generated when registering the device in Huawei Cloud. Maximum input length: 128 characters

2326

2327

**DeviceSecret:** Customized **password **when registering devices on Huawei Cloud Maximum input length: 128 characters.

2328

2329

**Timestamp:** LOCAL: Using the HMI time as the timestamp. UTC Time: Using UTC+0.

2330

2331

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

**Address**

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

2337

[[image:43.jpg]]

2338

2339

**Status address: (Total length: 2 words)**

2340

2341

HDWn: Display [MQTT] connection status.

2342

2343

|Value|Description

2344

|0|Disable MQTT server connection

2345

|1|Disconnected or connecting

2346

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

2353

|-3|Disconnected

2354

|-4|Exceed client data concurrency

2355

|-5|Invalid UTF-8 string

2356

|-6|Null pointer parameter

2357

|-7|Topic name is truncated

2358

|-8|Wrong protocol structure body

2359

|-9|Wrong QOS. (0, 1, 2) is acceptable.

2360

|-10|Attempt to use a non-SSL library for SSL connection

2361

|-11|Wrong MQTT version

2362

|-14|Wrong protocol type

2363

|-15|Option is not suitable for the current request version

2364

|-16|Call MQTT version that is not applicable to request.

2365

|-17|0 length topic connection

2366

2367

**Buffer usage address: (Total length: 1 word)**

2368

2369

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.

2370

2371

HDWn: Display buffer usage.

2372

2373

**Control address: (Total length: 194 words)**

2374

2375

HDWn: Control the execution or stop of [MQTT Server].

|Value|Description

|0|Ready

|1|Start

|2|Stop

|3|Update

HDWn+1: Port number of the Huawei Cloud.

2384

2385

HDWn+2: Domain name of the Huawei Cloud.

2386

2387

HDWn+66: DeviceSecret of the Huawei Cloud.

2388

2389

HDWn+130: DeviceSecret of the Huawei Cloud.

**TLS/SSL Settings**

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

2394

[[image:44.jpg]]

2395

2396

**Enable:** Enable TLS/SSL encryption. User can manually select encrypted versions of TLS 1.0, TLS 1.1, or TLS 1.2.

2397

2398

**Server authentication:**

2399

2400

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.

2401

2402

Import: Select CA certificate to import.

2403

2404

More: After the import is successful, clicking it will display the certificate details.

2405

2406

Reset: Reset the import information.

2407

2408

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.

2409

2410

**Client authentication:** The private key and client certificate are the data required for the server to authenticate the client end.

Certificate:

Import: Select certificate to import.

2415

2416

More: After the import is successful, clicking it will display the certificate details.

2417

2418

Reset: Reset the import information.

Key:

Import: Select the key to import.

2423

2424

More: After the import is successful, clicking it will display key details.

2425

2426

Reset: Reset the import information.

**MQTT Topic**

**MQTT topic publish**

2431

2432

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.

2433

2434

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

2435

[[image:45.jpg]]

2436

2437

**General properties**

2438

2439

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

2440

[[image:46.jpg]]

2441

2442

**Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.

2443

2444

**Topic:** The topic received by the MQTT server when sending message. Maximum input length: 255 characters, cannot be empty.

2445

2446

**Sending mode:** **(AUTO/TRIGGER)**

2447

2448

**① AUTO **value change mode: When any value changes, MQTT message is published.

2449

2450

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.

2451

2452

b. Periodic mode: Publish MQTT message by the fixed time. Time interval: Set the time interval for periodic publishing, ranging from 1 to 3600s.

**② TRIGGER**

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.

2457

2458

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

2459

2460

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

2461

2462

0: Messages are sent only once, and delivery is not guaranteed.

2463

2464

1: Message must be delivered at least once.

2465

2466

2: Message is delivered just once.

2467

2468

**Retain message:** When checked, the MQTT server will keep the latest message.

**Content format:**

Raw data: Data composed of BYTE data.

2473

2474

JSON (General): Put all data in JSON format of member "d".

2475

2476

JSON (Advanced): JSON format of flexibly customizable nested structure.

2477

2478

**Include timestamps:** This function is only supported when the content format uses [JSON (General)], and whether to include the timestamp can be decided manually.

2479

2480

**Use the top "d" symbol in the message format:**

2481

2482

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ...,

"addressName2":...,

"ts":...

}

As shown above, when unchecked, ts and address names are both key at the same level. Therefore, avoid taking the address name as ts.

**Address setting**

①Address settings when content formats use [Raw Data] and [JSON (General)].

2516

2517

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

2518

[[image:47.jpg]]

2519

2520

**Add:** Establish the address source of the topic. The length of each address can be set separately.

2521

2522

**Delete:** Delete the address.

2523

2524

**Settings:** Modify the address and name.

2525

2526

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

2527

[[image:48.jpg]]

2528

2529

**Included in all message sent**

2530

2531

Check the options: This topic will include this address every time it publishes a message.

2532

2533

Uncheck the options: When the sending mode is value, message is published only when the value of the address changes.

2534

2535

**Remove JSON array brackets' ['and'] ':**

2536

2537

Check the options: Remove the array symbol name when using non-array bits or characters.

2538

2539

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

2540

2541

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

2542

2543

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

2544

[[image:49.jpg]]

2545

2546

The above figure is an example. If setting like above figure, the subscription side will receive the MQTT message like following format.

{

"object": {

"value": "teststring",

"value (1)": 123,

"value (2)": true,

"value (3)": "",

"value (4)": 0,

"value (5)": true

},

"array": [

10,

20,

30

],

"value (6)": " 2023-04-27T03: 53: 20.156271 "

2563

}

2564

2565

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

2566

2567

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

2568

2569

**Delete:** Delete the selected field.

2570

2571

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

2572

2573

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

2574

2575

**Preview:** Preview JSON data in an easy-to-read format.

2576

2577

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

2578

2579

2580

**Security settings**

2581

2582

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.

2583

2584

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

[[image:50.jpg]]

**MQTT topic subscription**

2589

2590

Select [Topic subscription] and click [Add] to enter general property settings and address settings. The maximum number of MQTT subscription topics is 255.

2591

2592

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

2593

[[image:51.jpg]]

2594

2595

**General properties**

2596

2597

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

2598

[[image:52.jpg]]

2599

2600

**Alias:** Set the project name of the MQTT theme. Maximum input length: 255 characters, cannot be empty.

2601

2602

**Topic:** Topics subscribed from the MQTT server. Maximum input length: 255 characters, cannot be empty.

2603

2604

**Compression type:** The transport compression type of a subscription topic must be the same as that of a publication topic.

2605

2606

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

2607

2608

0: Messages are sent only once, and delivery is not guaranteed.

2609

2610

1: Message must be delivered at least once.

2611

2612

2: Message is delivered just once.

**Content format:**

Raw data: There is no original data in a specific format.

2617

2618

JSON (General): JSON format of single-layer structure.

2619

2620

JSON (Advanced): JSON format of flexibly customizable nested structure.

2621

2622

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

2623

2624

**Use the top "d" symbol in the message format:**

2625

2626

This function is only supported when the content format uses [JSON (General)]. When checked, the message format is as follows:

{

"d": {

"addressName1": ...,

"addressName2":...

},

"ts":...

}

When unchecked, the message format is as follows:

{

"addressName1": ..., "addressName2":...,

"ts":...

}

Please select the appropriate settings according to the data source.

**Address setting**

①Address settings when content formats use [Raw Data] and [JSON (General)].

2657

2658

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

2659

[[image:53.jpg]]

2660

2661

**Add:** Establish the address where the data is placed after the topic is subscribed. The length of each address can be set separately.

2662

2663

**Delete:** Delete the address.

2664

2665

**Settings:** Modify the address and name.

2666

2667

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

2668

[[image:54.jpg]]

2669

2670

**Remove JSON array brackets' ['and'] ':**

2671

2672

When using non-array bits or characters, array symbol can manually be removed.

2673

2674

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

2675

2676

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

2677

2678

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

2679

[[image:HMIEditor_Db5tLtioq7.jpg]]

2680

2681

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

2682

2683

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

2684

2685

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

2686

2687

**Delete:** Delete the selected field.

2688

2689

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

2690

2691

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

2692

2693

**Preview:** Preview JSON data in an easy-to-read format.

2694

2695

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

2696

2697

2698

**Security settings**

2699

2700

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.

2701

2702

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

2703

[[image:56.jpg]]

Wiki source code of 06 Data Tool

Navigation

Table of Contents