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.

52

53

(% 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 bit alarm record must be the same as that of the current project; otherwise, it cannot be used normally.

58

* The number of alarm configuration points reported to the cloud cannot exceed 20, or the sum of imported alarm records and the current alarm records cannot exceed 20. If it exceeds, please reconfigure.

59

)))

60

61

**Operating Procedures of Adding One Alarm**

62

63

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

64

65

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

66

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

67

68

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

69

70

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

71

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

72

73

* Set "Bit Address".

74

* Set "Alarm Condition".

75

* Set "Content".

76

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

77

* Click "OK" button to complete settings.

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

82

83

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

84

85

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

86

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

87

88

**Alarm Name:** You can set alarm name for it. Alarm Name can only consist of (0~~9), (a~~z), (A~~Z), ('_'), (' ') and other non-English characters.

89

90

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

91

92

**Data Format: **16-bit unsigned decimal, 16-bit signed decimal, 16-bit BCD, 32-bit unsigned decimal, 32-bit signed decimal, 32-bit BCD, 32-bit float.

93

94

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

95

96

**Upload to Cloud: **The data upload by "word alarm" is stored in the Cloud and it is alarm data. (Only ig series and 8000/9000 series with -R after system upgrade are supported)

97

98

(% class="box infomessage" %)

(((

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

103

* The number of alarm configuration points reported to the cloud cannot exceed 20, or the sum of imported alarm records and the current alarm records cannot exceed 20. If it exceeds, please reconfigure.

104

105

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

106

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

107

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

108

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

109

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

110

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

111

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

112

)))

113

114

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

115

116

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

117

118

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

119

120

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

121

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

122

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

123

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

124

125

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

126

127

**Alert: **It is used to mark whether the alarm has occurred. if an alarm occurs, the address of "control bit" will be written to 1. If "clear alert when alarm OFF" is checked, the address of "control bit" will be written to 0.

128

129

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

130

131

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

132

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

133

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

134

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

135

136

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

137

138

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

**Alarm List**

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

143

144

**Operating Procedures of Adding One Alarm**

145

146

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

147

148

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

149

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

150

151

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

152

153

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

154

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

155

156

* Set Basic information of word alarm.

157

* Set "Content".

158

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

159

* Click "OK" button to complete settings.

160

161

**HMI Alarm Demo Download Link**

162

163

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

= **Recipe** =

== Overview of recipe ==

168

169

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.

170

171

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

172

173

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.

174

175

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

176

**Example**

177

178

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.

179

180

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

188

189

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:

190

191

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

192

[[image:1.png]]

193

194

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

195

196

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

197

[[image:2.png]]

198

199

|Recipe configuration options|Description|Notice

200

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

201

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

202

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

203

204

|Data configuration options|Description|Notice

205

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

206

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

207

|Data format|Configure the data format of this recipe. There are 9 modes of data format: 16-bit BCD code, 16-bit signed decimal, 16-bit unsigned decimal, 32-bit BCD code, 32-bit signed decimal, 32-bit unsigned decimal, 32-bit (single-precision) floating points, 64-bit (double-precision) floating point, string.|(% rowspan="2" %)(% class="box infomessage" %)

208

(((

209

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

210

)))

211

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

212

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

213

|Language|Recipe display language is selectable.|

214

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

215

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

216

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

217

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

218

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

219

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

220

|Data export|Export configured recipe data|

221

222

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.

227

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

228

229

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.

230

231

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

232

233

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.

234

235

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

236

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

237

238

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

243

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

**Basic**

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

248

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

249

(((

250

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

251

)))

252

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

253

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

254

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

255

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

256

257

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

258

259

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

260

261

* = 0: no operation;

262

* = 1: trigger read data;

263

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

264

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

265

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

266

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

267

* = 64: import CSV recipe file.

268

269

**Use Multiple File**

270

271

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;

280

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

281

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;

290

291

(% class="box infomessage" %)

292

(((

293

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

294

)))

295

296

**Use Independent Write Address**

297

298

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.

303

304

**Discontinuous Address**

305

306

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

307

308

(% class="box infomessage" %)

309

(((

310

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

311

)))

312

313

**Description of adcanced mode**

314

315

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.

316

317

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

318

319

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

320

321

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

322

323

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

324

325

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

326

327

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

328

329

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.

330

331

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.

332

333

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

334

335

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

344

345

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

346

(((

347

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

348

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

349

)))

350

351

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.

352

353

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

354

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

355

356

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

357

358

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

359

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

360

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

361

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

362

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

363

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

364

)))

365

|HSW1067|Numerical input object|(((

366

Where the CSV file is saved:

367

368

* = 0: In the CsvFile directory of U disk

369

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

370

371

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

372

)))

373

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

374

* = 37: CSV file imported successfully

375

* = 38: CSV file import failed

376

)))

377

378

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

379

380

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.

381

382

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

383

384

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

385

386

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

387

388

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

389

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

390

391

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

392

393

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

394

395

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

396

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

397

398

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

399

400

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

401

402

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

403

[[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:

408

409

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

410

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

411

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

412

413

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

414

415

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.

416

417

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;

422

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

427

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

428

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

429

430

== **Recipe record function** ==

**Basic setting**

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

435

[[image:3.png]]

436

437

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

438

439

Recipe shortcut key setting:

440

441

Add data: Used to add groups.

442

443

Delete data: Used to delete the selected configuration

444

445

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

446

447

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

448

449

Import recipe: Used to import the existing recipe files.

450

451

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

**Graphic**

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

456

[[image:4.png]]

457

458

Style selection: Styles can be switched or customized.

459

460

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

461

462

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

467

[[image:5.png]]

468

469

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

470

471

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.

472

473

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

474

475

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

476

477

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.

478

479

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

480

481

(% class="box infomessage" %)

482

(((

483

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

484

)))

485

486

== Simple recipe mode ==

487

488

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:

489

490

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

491

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

**✎Note**:

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

496

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

501

502

(% class="box infomessage" %)

503

(((

504

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

505

)))

506

507

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

508

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

509

510

== Recipe transmission address ==

511

512

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

513

514

(% class="table-bordered" %)

515

|=Address|=Description|=Function

516

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

517

~=1: Recipe download.

~=2: Recipe upload.

)))

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

|(((

HSW242

)))|(((

Recipe operation result prompt:

526

527

Upload: Data is written to recipe file from address.

528

529

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

530

)))|(((

531

~=1: Recipe download, start.

532

533

~=2: Recipe download, execution error.

534

535

~=6: Recipe download, successful.

536

537

~=7: Recipe upload, start.

538

539

~=8: Recipe upload, execution error.

540

541

~=11: Recipe group name does not exist.

542

543

~=12: Recipe upload, successful.

544

)))

545

546

== **Recipe index** ==

547

548

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

549

550

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

551

552

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.

553

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.

554

555

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

556

557

(% start="3" %)

558

1. The RPW register only supports word address access.

559

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

564

565

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

566

567

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

568

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

569

570

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:

571

572

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

573

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

574

575

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.

576

577

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

578

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

583

584

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

585

586

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

587

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

**Settings**

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

592

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

593

594

**(1) Basic settings**

595

596

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

597

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

598

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

599

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.

604

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

605

606

**(3) Quick Setting**

607

608

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.

609

610

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

611

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

612

613

(% start="2" %)

614

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.

615

616

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

617

618

(% class="box infomessage" %)

619

(((

620

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

621

)))

622

623

**Trend Chart Demo Download Link**

624

625

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

626

627

= **History XY plot** =

628

629

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

630

631

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.

632

633

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

634

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

635

636

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

637

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

638

639

**(1) Basic settings**

640

641

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

642

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

643

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

644

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.

649

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

650

651

**(3) Quick Setting**

652

653

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.

654

655

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

656

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

657

658

(% start="2" %)

659

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.

660

661

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

662

663

(% class="box infomessage" %)

664

(((

665

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

666

)))

667

668

**Operating Procedure**

669

670

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

671

672

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

673

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

674

675

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

676

677

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

678

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

679

680

* Setting the function of History XY Plot.

681

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

686

687

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

688

689

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.

690

691

The topology is shown in the following figure.

692

693

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

694

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

695

696

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

697

698

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.

699

700

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

701

702

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.

703

704

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.

709

710

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:

711

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

720

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

721

722

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

723

724

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

725

**Settings**

726

727

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

728

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

729

730

**Operating Procedures**

731

732

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

733

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

734

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

735

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

736

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

737

1. Click "Apply" button.

738

1. Set Sample cycle, such as 15.

739

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

740

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

741

1. Click "Save" button to complete settings.

742

743

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.

748

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

749

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

750

751

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

752

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

753

754

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

755

756

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

757

758

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

759

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

760

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

761

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

762

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

763

764

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

765

766

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

767

768

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

769

770

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

771

772

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

773

774

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

775

776

**(7) Quick Settings**

777

778

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

779

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

780

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

781

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

782

783

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

788

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

789

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

790

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

791

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

792

793

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

794

795

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

800

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.

801

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

802

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

803

804

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

809

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

815

816

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

817

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

818

819

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

820

821

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

822

[[image:UserPermissionMultilan.png]]

823

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

832

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

837

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

838

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

839

* (((

840

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

849

850

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

851

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

852

853

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

854

855

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

856

[[image:LogMessagesMultilan.png]]

857

858

**Operation Procedure of Object Permission**

859

860

1. Open the object setting windows;

861

1. Select "Security" windows;

862

1. Check the "User Permission";

863

1. Select "Level" to set permission level;

864

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

865

1. Select the "Access Denied Setting" mode;

866

867

**Log information description**

868

869

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

870

871

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

872

873

The data format are as follows.

874

875

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

891

892

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

893

894

* (((

895

Binary, Octonary and Hexadecimal are as follows.

896

)))

897

898

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

899

900

* (((

901

Character is as follows.

902

)))

903

904

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

905

906

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

907

908

== **Function address** ==

909

910

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.

911

912

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

913

914

Functions and addresses are as follows.

915

916

(% class="table-bordered" %)

917

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

918

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

919

|HUW1002|Character input object|Password

920

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

921

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

922

|HUW1002|Character input object|Old password

923

|HUW1006|Character input object|New password

924

|HUW1010|Character input object|Confirm password

925

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

926

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

927

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

928

New user ***1**

929

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

930

|HUW1006|Character input object|password

931

|HUW1010|Character input object|Confirm password

932

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

933

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

934

|HUX1347.0|Bit switch|(((

935

~=1: User hidden

936

937

~=0: Visible (Defaults)

938

)))

939

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

940

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

941

Delete user ***2**

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

|HUW1348|Bit switch|(((

953

Set the user group:

954

955

HUX1348.0 = 1 administrator;

956

957

HUX1348.1 = 1 group 0 permission;

958

959

HUX1348.2 = 1 group 1 permission;

960

961

(Total group 0 - group 10)

962

)))

963

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

964

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

965

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

966

967

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

968

)))

969

970

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

971

972

(% class="table-bordered" %)

973

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

974

|1|Insufficient permissions.

975

|2|Username does not exist.

976

|3|Username already exists.

977

|4|Wrong username or password.

978

|5|Login successfully.

979

|6|Passwords are inconsistent in twice time.

980

|7|Password changed successfully.

981

|8|User added successfully.

982

|9|User deleted successfully.

983

|10|Maximum number of users exceeded.

984

|11|Admin user already exists.

985

|12|User permission modified successfully.

986

|13|File imported successfully.

987

|14|File imported failed.

988

|15|File exported successfully.

989

|16|File exported failed.

990

|17|Logout successfully.

991

|18|Profile deleted successfully.

992

|19|Log file deleted successfully.

993

|20|Hide settings modified successfully.

994

|21|Hide settings modified failed.

995

|22|(((

996

Password already occupied, please reset.

997

998

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

999

)))

1000

1001

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

1006

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

1007

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

1008

)))

1009

1010

**User Permission Demo Download**

1011

1012

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

1017

1018

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

1019

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

1020

1021

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

1022

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

1031

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.

1036

1037

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

1038

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

1039

1040

**(3) Message Content**

1041

1042

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.

1043

1044

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

1049

1050

(% class="box infomessage" %)

(((

**✎Note:**

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

1055

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

1056

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

1064

1065

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.

1066

1067

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

1068

[[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:

1073

1074

1075

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

1076

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

1077

|3000ig|100|20|50|500

1078

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

1084

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

1085

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

1086

1087

**(2) Server Selection**

1088

1089

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

1094

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.

1095

1096

**(3) Upload Selection**:

1097

1098

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

1099

1100

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

1101

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

1102

1103

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.

1104

1105

**4) Low Data Mode setting**

1106

1107

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.

1108

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.

1109

1110

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

1111

1112

(% class="wikigeneratedid" %)

1113

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

1114

1115

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

1116

1117

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

1118

1119

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:

1120

1121

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

1122

[[image:2.jpg]]

1123

1124

**MQTT Server Settings (Common)**

**General**

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

1129

[[image:3.jpg]]

1130

1131

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

1132

1133

**Cloud Service**: (Select Common)

1134

1135

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

1136

1137

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

1138

1139

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

1140

1141

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

1142

1143

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

1144

1145

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

1146

1147

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

1148

1149

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

1150

1151

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

1152

1153

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

1154

1155

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

1156

1157

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

1158

1159

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

1160

1161

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

1162

1163

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

1164

1165

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

1166

1167

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

1173

[[image:4.jpg]]

1174

1175

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

1176

1177

HDWn: Display [MQTT] connection status.

1178

1179

|Value|Description

1180

|0|Disable MQTT server connection

1181

|1|Disconnected or connecting

1182

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1189

|-3|Disconnected

1190

|-4|Exceed client data concurrency

1191

|-5|Invalid UTF-8 string

1192

|-6|Null pointer parameter

1193

|-7|Topic name is truncated

1194

|-8|Wrong protocol structure body

1195

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

1196

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

1197

|-11|Wrong MQTT version

1198

|-14|Wrong protocol type

1199

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

1200

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

1201

|-17|0 length connects topics

1202

1203

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

1204

1205

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.

1206

1207

HDWn: Display buffer usage.

1208

1209

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

1210

1211

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

1220

1221

HDWn+5: Port number of the MQTT server.

1222

1223

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

1224

1225

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

1226

1227

HDWn+27: User name of MQTT server connection.

1228

1229

HDWn+43: Password of MQTT server connection.

1230

1231

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

1237

[[image:5.jpg]]

1238

1239

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

1240

1241

**Server authentication:**

1242

1243

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.

1244

1245

Import: Select CA certificate to import.

1246

1247

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

1248

1249

Reset: Reset the import information.

1250

1251

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.

1252

1253

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

1258

1259

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

1260

1261

Reset: Reset the import information.

Key:

Import: Select the key to import.

1266

1267

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

1268

1269

Reset: Reset the import information.

**System topics**

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

1275

[[image:6.jpg]]

1276

1277

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

1278

1279

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

1280

1281

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

1282

1283

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

1284

1285

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

1286

1287

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

1288

1289

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

1290

1291

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

1292

1293

QoS 1: Message must be delivered at least once.

1294

1295

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

1334

1335

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

"topic": "**Theme**"

}

]

},

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

1342

}

1343

1344

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

1345

1346

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

1347

1348

**Choose the connection network card**

1349

1350

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

1351

[[image:7.jpg]]

1352

1353

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

1354

1355

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

1356

1357

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

1358

1359

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

1360

1361

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

1367

1368

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.

1369

1370

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

1371

[[image:8.jpg]]

1372

1373

**General properties**

1374

1375

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

1376

[[image:9.jpg]]

1377

1378

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

1379

1380

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

1381

1382

Sending mode: (AUTO/TRIGGER)

1383

1384

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

1385

1386

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.

1387

1388

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.

1393

1394

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

1395

1396

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

1397

1398

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

1399

1400

1: Message must be delivered at least once.

1401

1402

2: Message is delivered just once.

1403

1404

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

**Content format:**

Raw data: Data composed of BYTE data.

1409

1410

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

1411

1412

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

1413

1414

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

1415

1416

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

1417

1418

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

1451

1452

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

1453

[[image:10.jpg]]

1454

1455

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

1456

1457

**Delete:** Delete the address.

1458

1459

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

1460

1461

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

1462

[[image:11.jpg]]

1463

1464

**Included in all message sent**

1465

1466

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

1467

1468

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

1469

1470

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

1471

1472

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

1473

1474

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

1475

1476

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

1477

1478

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

1479

[[image:12.jpg]]

1480

1481

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 "

1498

}

1499

1500

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

1501

1502

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

1503

1504

**Delete:** Delete the selected field.

1505

1506

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

1507

1508

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

1509

1510

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

1511

1512

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

1513

1514

**Security settings**

1515

1516

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.

1517

1518

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

1519

[[image:13.jpg]]

1520

1521

**MQTT topic subscription**

1522

1523

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

1524

1525

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

1526

[[image:14.jpg]]

1527

1528

**General properties**

1529

1530

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

1531

[[image:15.jpg]]

1532

1533

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

1534

1535

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

1536

1537

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

1538

1539

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

1540

1541

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

1542

1543

1: Message must be delivered at least once.

1544

1545

2: Message is delivered just once.

**Content format:**

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

1550

1551

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

1552

1553

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

1554

1555

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

1556

1557

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

1558

1559

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

1590

1591

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

1592

[[image:16.jpg]]

1593

1594

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

1595

1596

**Delete:** Delete the address.

1597

1598

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

1599

1600

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

1601

[[image:17.jpg]]

1602

1603

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

1604

1605

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

1606

1607

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

1608

1609

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

1610

1611

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

1612

[[image:18.jpg]]

1613

1614

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

1615

1616

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

1617

1618

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

1619

1620

**Delete:** Delete the selected field.

1621

1622

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

1623

1624

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

1625

1626

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

1627

1628

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

1629

1630

**(3) Security settings**

1631

1632

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.

1633

1634

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

1635

[[image:19.jpg]]

1636

1637

**MQTT Server Settings (AWS IOT)**

**General**

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

1642

[[image:20.jpg]]

1643

1644

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

1645

1646

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

1647

1648

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

1649

1650

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

1651

1652

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

1653

1654

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

1655

1656

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

1657

1658

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

1659

1660

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

1661

1662

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

1663

1664

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

**Address**

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

1670

[[image:21.jpg]]

1671

1672

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

1673

1674

HDWn: Display [MQTT] connection status.

1675

1676

|Value|Description

1677

|0|Disable MQTT server connection

1678

|1|Disconnected or connecting

1679

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1686

|-3|Disconnected

1687

|-4|Exceed client data concurrency

1688

|-5|Invalid UTF-8 string

1689

|-6|Null pointer parameter

1690

|-7|Topic name is truncated

1691

|-8|Wrong protocol structure body

1692

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

1693

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

1694

|-11|Wrong MQTT version

1695

|-14|Wrong protocol type

1696

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

1697

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

1698

|-17|0 length topic connection

1699

1700

**Buffer usage address:** Not available.

1701

1702

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

1703

1704

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

|Value|Description

|0|Ready

|1|Start

|2|Stop

|3|Update

HDWn+1: Reserved for use.

1713

1714

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

1715

1716

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

1717

1718

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.

1728

1729

**Server authentication:**

1730

1731

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.

1732

1733

Import: Select CA certificate to import.

1734

1735

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

1736

1737

Reset: Reset the import information.

1738

1739

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.

1740

1741

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

1746

1747

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

1748

1749

Reset: Reset the import information.

Key:

Import: Select the key to import.

1754

1755

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

1756

1757

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.

1763

1764

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

[[image:23.jpg]]

**General**

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

1770

[[image:24.jpg]]

1771

1772

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

1773

1774

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

1775

1776

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

1777

1778

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

1779

1780

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

1781

1782

1: Message must be delivered at least once.

1783

1784

2: Message is delivered just once.

1785

1786

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

1787

1788

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

1789

1790

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

1791

1792

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

1825

[[image:25.jpg]]

1826

1827

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

1828

1829

**Delete:** Delete the address.

1830

1831

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

1832

1833

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

[[image:26.jpg]]

**Advanced Mode:**

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

1839

1840

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

1841

1842

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

1843

1844

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

**Length:**

Length 1: General JSON format.

1849

1850

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.

1851

1852

For example, configure as the following figure:

1853

1854

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

1855

[[image:27.jpg]]

1856

1857

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

1880

1881

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

1882

1883

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

1884

1885

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

1886

1887

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

1888

1889

**MQTT Server Settings (ALi)**

**General**

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

1894

[[image:28.jpg]]

1895

1896

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

1897

1898

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

1899

1900

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

1901

1902

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

1903

1904

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

1905

1906

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

1907

1908

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

1909

1910

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

1911

1912

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

1913

1914

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

1915

1916

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

1917

1918

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

1919

1920

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

1921

1922

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

1923

1924

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

1925

1926

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

1932

[[image:29.jpg]]

1933

1934

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

1935

1936

HDWn: Display [MQTT] connection status.

1937

1938

|Value|Description

1939

|0|Disable MQTT server connection

1940

|1|Disconnected or connecting

1941

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

1948

|-3|Disconnected

1949

|-4|Exceed client data concurrency

1950

|-5|Invalid UTF-8 string

1951

|-6|Null pointer parameter

1952

|-7|Topic name is truncated

1953

|-8|Wrong protocol structure body

1954

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

1955

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

1956

|-11|Wrong MQTT version

1957

|-14|Wrong protocol type

1958

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

1959

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

1960

|-17|0 length topic connection

1961

1962

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

1963

1964

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.

1965

1966

HDWn: Display buffer usage.

1967

1968

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

1969

1970

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.

1979

1980

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

1981

1982

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

1983

1984

HDWn+98: ProductId of the Alibaba Cloud connection.

1985

1986

HDWn+162: DeviceId of the Alibaba Cloud connection.

1987

1988

HDWn+194: DeviceSecret of the Alibaba Cloud connection.

**TLS/SSL Settings**

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

1993

[[image:30.jpg]]

1994

1995

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

1996

1997

**Server authentication:**

1998

1999

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.

2000

2001

Import: Select CA certificate to import.

2002

2003

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

2004

2005

Reset: Reset the import information.

2006

2007

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.

2008

2009

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

2014

2015

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

2016

2017

Reset: Reset the import information.

Key:

Import: Select the key to import.

2022

2023

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

2024

2025

Reset: Reset the import information.

**MQTT Topic**

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

2031

**MQTT topic publish**

2032

2033

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.

2034

2035

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

2036

[[image:31.jpg]]

2037

2038

**General properties**

2039

2040

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

[[image:32.jpg]]

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

2045

2046

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

2047

2048

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

2049

2050

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

2051

2052

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.

2053

2054

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.

2059

2060

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

2061

2062

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

2063

2064

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

2065

2066

1: Message must be delivered at least once.

2067

2068

2: Message is delivered just once.

2069

2070

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

**Content format:**

Raw data: Data composed of BYTE data.

2075

2076

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

2077

2078

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

2079

2080

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

2081

2082

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

2083

2084

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

2118

2119

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

2120

[[image:33.jpg]]

2121

2122

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

2123

2124

**Delete:** Delete the address.

2125

2126

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

2127

2128

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

2129

[[image:34.jpg]]

2130

2131

**Included in all message sent**

2132

2133

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

2134

2135

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

2136

2137

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

2138

2139

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

2140

2141

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

2142

2143

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

2144

2145

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

2146

[[image:HMIEditor_Db5tLtioq7.jpg]]

2147

2148

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 "

2165

}

2166

2167

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

2168

2169

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

2170

2171

**Delete:** Delete the selected field.

2172

2173

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

2174

2175

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

2176

2177

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

2178

2179

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

2180

2181

2182

**Security settings**

2183

2184

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.

2185

2186

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

2187

[[image:35.jpg]]

2188

2189

**MQTT topic subscription**

2190

2191

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

2192

2193

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

2194

[[image:36.jpg]]

2195

2196

**General properties**

2197

2198

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

2199

[[image:37.jpg]]

2200

2201

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

2202

2203

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

2204

2205

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

2206

2207

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

2208

2209

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

2210

2211

1: Message must be delivered at least once.

2212

2213

2: Message is delivered just once.

**Content format:**

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

2218

2219

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

2220

2221

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

2222

2223

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

2224

2225

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

2226

2227

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

2258

2259

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

2260

[[image:38.jpg]]

2261

2262

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

2263

2264

**Delete:** Delete the address.

2265

2266

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

2267

2268

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

2269

[[image:39.jpg]]

2270

2271

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

2272

2273

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

2274

2275

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

2276

2277

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

2278

2279

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

2280

[[image:40.jpg]]

2281

2282

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

2283

2284

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

2285

2286

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

2287

2288

**Delete:** Delete the selected field.

2289

2290

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

2291

2292

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

2293

2294

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

2295

2296

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

2297

2298

2299

**Security settings**

2300

2301

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.

2302

2303

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

2304

[[image:41.jpg]]

2305

2306

**MQTT Server Settings (Huawei)**

**General**

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

2311

[[image:42.jpg]]

2312

2313

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

2314

2315

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

2316

2317

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

2318

2319

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

2320

2321

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

2322

2323

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

2324

2325

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

2326

2327

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

2328

2329

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

2330

2331

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

2332

2333

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

2334

2335

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

2336

2337

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

2343

[[image:43.jpg]]

2344

2345

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

2346

2347

HDWn: Display [MQTT] connection status.

2348

2349

|Value|Description

2350

|0|Disable MQTT server connection

2351

|1|Disconnected or connecting

2352

|2|Successfully connected the MQTT server

HDWn+1: Error prompt

|Value|Description

|0|No error

|-1|General error code of wrong operation

2359

|-3|Disconnected

2360

|-4|Exceed client data concurrency

2361

|-5|Invalid UTF-8 string

2362

|-6|Null pointer parameter

2363

|-7|Topic name is truncated

2364

|-8|Wrong protocol structure body

2365

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

2366

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

2367

|-11|Wrong MQTT version

2368

|-14|Wrong protocol type

2369

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

2370

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

2371

|-17|0 length topic connection

2372

2373

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

2374

2375

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.

2376

2377

HDWn: Display buffer usage.

2378

2379

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

2380

2381

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.

2390

2391

HDWn+2: Domain name of the Huawei Cloud.

2392

2393

HDWn+66: DeviceSecret of the Huawei Cloud.

2394

2395

HDWn+130: DeviceSecret of the Huawei Cloud.

**TLS/SSL Settings**

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

2400

[[image:44.jpg]]

2401

2402

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

2403

2404

**Server authentication:**

2405

2406

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.

2407

2408

Import: Select CA certificate to import.

2409

2410

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

2411

2412

Reset: Reset the import information.

2413

2414

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.

2415

2416

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

2421

2422

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

2423

2424

Reset: Reset the import information.

Key:

Import: Select the key to import.

2429

2430

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

2431

2432

Reset: Reset the import information.

**MQTT Topic**

**MQTT topic publish**

2437

2438

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.

2439

2440

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

2441

[[image:45.jpg]]

2442

2443

**General properties**

2444

2445

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

2446

[[image:46.jpg]]

2447

2448

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

2449

2450

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

2451

2452

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

2453

2454

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

2455

2456

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.

2457

2458

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.

2463

2464

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

2465

2466

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

2467

2468

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

2469

2470

1: Message must be delivered at least once.

2471

2472

2: Message is delivered just once.

2473

2474

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

**Content format:**

Raw data: Data composed of BYTE data.

2479

2480

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

2481

2482

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

2483

2484

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

2485

2486

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

2487

2488

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

2522

2523

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

2524

[[image:47.jpg]]

2525

2526

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

2527

2528

**Delete:** Delete the address.

2529

2530

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

2531

2532

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

2533

[[image:48.jpg]]

2534

2535

**Included in all message sent**

2536

2537

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

2538

2539

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

2540

2541

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

2542

2543

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

2544

2545

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

2546

2547

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

2548

2549

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

2550

[[image:49.jpg]]

2551

2552

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 "

2569

}

2570

2571

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

2572

2573

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

2574

2575

**Delete:** Delete the selected field.

2576

2577

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

2578

2579

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

2580

2581

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

2582

2583

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

2584

2585

2586

**Security settings**

2587

2588

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.

2589

2590

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

[[image:50.jpg]]

**MQTT topic subscription**

2595

2596

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

2597

2598

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

2599

[[image:51.jpg]]

2600

2601

**General properties**

2602

2603

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

2604

[[image:52.jpg]]

2605

2606

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

2607

2608

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

2609

2610

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

2611

2612

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

2613

2614

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

2615

2616

1: Message must be delivered at least once.

2617

2618

2: Message is delivered just once.

**Content format:**

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

2623

2624

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

2625

2626

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

2627

2628

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

2629

2630

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

2631

2632

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

2663

2664

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

2665

[[image:53.jpg]]

2666

2667

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

2668

2669

**Delete:** Delete the address.

2670

2671

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

2672

2673

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

2674

[[image:54.jpg]]

2675

2676

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

2677

2678

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

2679

2680

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

2681

2682

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

2683

2684

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

2685

[[image:HMIEditor_Db5tLtioq7.jpg]]

2686

2687

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

2688

2689

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

2690

2691

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

2692

2693

**Delete:** Delete the selected field.

2694

2695

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

2696

2697

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

2698

2699

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

2700

2701

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

2702

2703

2704

**Security settings**

2705

2706

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.

2707

2708

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

2709

[[image:56.jpg]]

Wiki source code of 06 Data Tool